{ "@roblox/global/DateTime": { "documentation": "A data type that represents a moment in time.", "keys": { "now": "@roblox/global/DateTime.now", "fromUnixTimestamp": "@roblox/global/DateTime.fromUnixTimestamp", "fromUnixTimestampMillis": "@roblox/global/DateTime.fromUnixTimestampMillis", "fromUniversalTime": "@roblox/global/DateTime.fromUniversalTime", "fromLocalTime": "@roblox/global/DateTime.fromLocalTime", "fromIsoDate": "@roblox/global/DateTime.fromIsoDate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime", "code_sample": "" }, "@roblox/global/DateTime.now": { "documentation": "Returns a DateTime representing the current moment in time.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#now", "code_sample": "" }, "@roblox/global/DateTime.fromUnixTimestamp/param/0": { "documentation": "" }, "@roblox/global/DateTime.fromUnixTimestamp": { "documentation": "Returns a DateTime representing the given Unix timestamp.", "params": [ { "name": "unixTimestamp", "documentation": "@roblox/global/DateTime.fromUnixTimestamp/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#fromUnixTimestamp", "code_sample": "" }, "@roblox/global/DateTime.fromUnixTimestampMillis/param/0": { "documentation": "" }, "@roblox/global/DateTime.fromUnixTimestampMillis": { "documentation": "Returns a DateTime representing the given Unix timestamp in milliseconds.", "params": [ { "name": "unixTimestampMillis", "documentation": "@roblox/global/DateTime.fromUnixTimestampMillis/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#fromUnixTimestampMillis", "code_sample": "" }, "@roblox/global/DateTime.fromUniversalTime/param/0": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime/param/1": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime/param/2": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime/param/3": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime/param/4": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime/param/5": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime/param/6": { "documentation": "" }, "@roblox/global/DateTime.fromUniversalTime": { "documentation": "Returns a new DateTime using the given units from a UTC time.", "params": [ { "name": "year", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/0" }, { "name": "month", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/1" }, { "name": "day", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/2" }, { "name": "hour", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/3" }, { "name": "minute", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/4" }, { "name": "second", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/5" }, { "name": "millisecond", "documentation": "@roblox/global/DateTime.fromUniversalTime/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#fromUniversalTime", "code_sample": "" }, "@roblox/global/DateTime.fromLocalTime/param/0": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime/param/1": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime/param/2": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime/param/3": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime/param/4": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime/param/5": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime/param/6": { "documentation": "" }, "@roblox/global/DateTime.fromLocalTime": { "documentation": "Returns a new DateTime using the given units from a local time.", "params": [ { "name": "year", "documentation": "@roblox/global/DateTime.fromLocalTime/param/0" }, { "name": "month", "documentation": "@roblox/global/DateTime.fromLocalTime/param/1" }, { "name": "day", "documentation": "@roblox/global/DateTime.fromLocalTime/param/2" }, { "name": "hour", "documentation": "@roblox/global/DateTime.fromLocalTime/param/3" }, { "name": "minute", "documentation": "@roblox/global/DateTime.fromLocalTime/param/4" }, { "name": "second", "documentation": "@roblox/global/DateTime.fromLocalTime/param/5" }, { "name": "millisecond", "documentation": "@roblox/global/DateTime.fromLocalTime/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#fromLocalTime", "code_sample": "" }, "@roblox/global/DateTime.fromIsoDate/param/0": { "documentation": "" }, "@roblox/global/DateTime.fromIsoDate": { "documentation": "Returns a DateTime from an ISO 8601 date-time string (in UTC).", "params": [ { "name": "isoDate", "documentation": "@roblox/global/DateTime.fromIsoDate/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#fromIsoDate", "code_sample": "" }, "@roblox/globaltype/DateTime": { "documentation": "A data type that represents a moment in time.", "keys": { "UnixTimestamp": "@roblox/globaltype/DateTime.UnixTimestamp", "UnixTimestampMillis": "@roblox/globaltype/DateTime.UnixTimestampMillis", "ToUniversalTime": "@roblox/globaltype/DateTime.ToUniversalTime", "ToLocalTime": "@roblox/globaltype/DateTime.ToLocalTime", "ToIsoDate": "@roblox/globaltype/DateTime.ToIsoDate", "FormatUniversalTime": "@roblox/globaltype/DateTime.FormatUniversalTime", "FormatLocalTime": "@roblox/globaltype/DateTime.FormatLocalTime" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime", "code_sample": "" }, "@roblox/globaltype/DateTime.UnixTimestamp": { "documentation": "The number of seconds between January 1st, 1970 at 00:00 UTC (the Unix epoch).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#UnixTimestamp", "code_sample": "" }, "@roblox/globaltype/DateTime.UnixTimestampMillis": { "documentation": "The number of milliseconds between January 1st, 1970 at 00:00 UTC (the Unix epoch).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#UnixTimestampMillis", "code_sample": "" }, "@roblox/globaltype/DateTime.ToUniversalTime/param/0": { "documentation": "A data type that represents a moment in time." }, "@roblox/globaltype/DateTime.ToUniversalTime/return/0": { "documentation": "" }, "@roblox/globaltype/DateTime.ToUniversalTime": { "documentation": "Returns the components of the DateTime in UTC.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DateTime.ToUniversalTime/param/0" } ], "returns": [ "@roblox/globaltype/DateTime.ToUniversalTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#ToUniversalTime", "code_sample": "" }, "@roblox/globaltype/DateTime.ToLocalTime/param/0": { "documentation": "A data type that represents a moment in time." }, "@roblox/globaltype/DateTime.ToLocalTime/return/0": { "documentation": "" }, "@roblox/globaltype/DateTime.ToLocalTime": { "documentation": "Returns the components of the DateTime in local time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DateTime.ToLocalTime/param/0" } ], "returns": [ "@roblox/globaltype/DateTime.ToLocalTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#ToLocalTime", "code_sample": "" }, "@roblox/globaltype/DateTime.ToIsoDate/param/0": { "documentation": "A data type that represents a moment in time." }, "@roblox/globaltype/DateTime.ToIsoDate/return/0": { "documentation": "" }, "@roblox/globaltype/DateTime.ToIsoDate": { "documentation": "Returns the DateTime as an ISO 8601 date-time string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DateTime.ToIsoDate/param/0" } ], "returns": [ "@roblox/globaltype/DateTime.ToIsoDate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#ToIsoDate", "code_sample": "" }, "@roblox/globaltype/DateTime.FormatUniversalTime/param/0": { "documentation": "A data type that represents a moment in time." }, "@roblox/globaltype/DateTime.FormatUniversalTime/param/1": { "documentation": "" }, "@roblox/globaltype/DateTime.FormatUniversalTime/param/2": { "documentation": "" }, "@roblox/globaltype/DateTime.FormatUniversalTime/return/0": { "documentation": "" }, "@roblox/globaltype/DateTime.FormatUniversalTime": { "documentation": "Returns the DateTime's value in UTC formatted into a string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DateTime.FormatUniversalTime/param/0" }, { "name": "format", "documentation": "@roblox/globaltype/DateTime.FormatUniversalTime/param/1" }, { "name": "locale", "documentation": "@roblox/globaltype/DateTime.FormatUniversalTime/param/2" } ], "returns": [ "@roblox/globaltype/DateTime.FormatUniversalTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#FormatUniversalTime", "code_sample": "" }, "@roblox/globaltype/DateTime.FormatLocalTime/param/0": { "documentation": "A data type that represents a moment in time." }, "@roblox/globaltype/DateTime.FormatLocalTime/param/1": { "documentation": "" }, "@roblox/globaltype/DateTime.FormatLocalTime/param/2": { "documentation": "" }, "@roblox/globaltype/DateTime.FormatLocalTime/return/0": { "documentation": "" }, "@roblox/globaltype/DateTime.FormatLocalTime": { "documentation": "Returns the DateTime object's value in local time formatted into a string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DateTime.FormatLocalTime/param/0" }, { "name": "format", "documentation": "@roblox/globaltype/DateTime.FormatLocalTime/param/1" }, { "name": "locale", "documentation": "@roblox/globaltype/DateTime.FormatLocalTime/param/2" } ], "returns": [ "@roblox/globaltype/DateTime.FormatLocalTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DateTime#FormatLocalTime", "code_sample": "" }, "@roblox/global/Path2DControlPoint": { "documentation": "Stores the info for a single control point used with the Path2D instance.", "keys": { "new": "@roblox/global/Path2DControlPoint.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint", "code_sample": "" }, "@roblox/global/Path2DControlPoint.new": { "overloads": { "() -> Path2DControlPoint": "@roblox/global/Path2DControlPoint.new/overload/() -> Path2DControlPoint", "(UDim2) -> Path2DControlPoint": "@roblox/global/Path2DControlPoint.new/overload/(UDim2) -> Path2DControlPoint", "(UDim2, UDim2, UDim2) -> Path2DControlPoint": "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint" } }, "@roblox/global/Path2DControlPoint.new/overload/() -> Path2DControlPoint": { "documentation": "Returns an empty Path2DControlPoint.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint#new", "code_sample": "" }, "@roblox/global/Path2DControlPoint.new/overload/(UDim2) -> Path2DControlPoint/param/0": { "documentation": "The UDim2 position of the control point." }, "@roblox/global/Path2DControlPoint.new/overload/(UDim2) -> Path2DControlPoint": { "documentation": "Returns a Path2DControlPoint with only the position set.", "params": [ { "name": "Position", "documentation": "@roblox/global/Path2DControlPoint.new/overload/(UDim2) -> Path2DControlPoint/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint#new", "code_sample": "" }, "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint/param/0": { "documentation": "The UDim2 position of the control point." }, "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint/param/1": { "documentation": "The UDim2 left tangent of the control point." }, "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint/param/2": { "documentation": "The UDim2 right tangent of the control point." }, "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint": { "documentation": "Returns a Path2DControlPoint with the position, left tangent, and right tangent set.", "params": [ { "name": "Position", "documentation": "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint/param/0" }, { "name": "Left Tangent", "documentation": "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint/param/1" }, { "name": "Right Tangent", "documentation": "@roblox/global/Path2DControlPoint.new/overload/(UDim2, UDim2, UDim2) -> Path2DControlPoint/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint#new", "code_sample": "" }, "@roblox/globaltype/Path2DControlPoint": { "documentation": "Stores the info for a single control point used with the Path2D instance.", "keys": { "Position": "@roblox/globaltype/Path2DControlPoint.Position", "LeftTangent": "@roblox/globaltype/Path2DControlPoint.LeftTangent", "RightTangent": "@roblox/globaltype/Path2DControlPoint.RightTangent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint", "code_sample": "" }, "@roblox/globaltype/Path2DControlPoint.Position": { "documentation": "The position of the Path2DControlPoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint#Position", "code_sample": "" }, "@roblox/globaltype/Path2DControlPoint.LeftTangent": { "documentation": "The left tangent of the Path2DControlPoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint#LeftTangent", "code_sample": "" }, "@roblox/globaltype/Path2DControlPoint.RightTangent": { "documentation": "The right tangent of the Path2DControlPoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Path2DControlPoint#RightTangent", "code_sample": "" }, "@roblox/global/Color3": { "documentation": "A color value comprised of red, green, and blue components.", "keys": { "new": "@roblox/global/Color3.new", "fromRGB": "@roblox/global/Color3.fromRGB", "fromHSV": "@roblox/global/Color3.fromHSV", "fromHex": "@roblox/global/Color3.fromHex", "toHSV": "@roblox/global/Color3.toHSV" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3", "code_sample": "" }, "@roblox/global/Color3.new/param/0": { "documentation": "" }, "@roblox/global/Color3.new/param/1": { "documentation": "" }, "@roblox/global/Color3.new/param/2": { "documentation": "" }, "@roblox/global/Color3.new": { "documentation": "Returns a Color3 with the given red, green, and blue values.", "params": [ { "name": "red", "documentation": "@roblox/global/Color3.new/param/0" }, { "name": "green", "documentation": "@roblox/global/Color3.new/param/1" }, { "name": "blue", "documentation": "@roblox/global/Color3.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#new", "code_sample": "" }, "@roblox/global/Color3.fromRGB/param/0": { "documentation": "" }, "@roblox/global/Color3.fromRGB/param/1": { "documentation": "" }, "@roblox/global/Color3.fromRGB/param/2": { "documentation": "" }, "@roblox/global/Color3.fromRGB": { "documentation": "Returns a Color3 from given components within the range of 0 to 255.", "params": [ { "name": "red", "documentation": "@roblox/global/Color3.fromRGB/param/0" }, { "name": "green", "documentation": "@roblox/global/Color3.fromRGB/param/1" }, { "name": "blue", "documentation": "@roblox/global/Color3.fromRGB/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#fromRGB", "code_sample": "" }, "@roblox/global/Color3.fromHSV/param/0": { "documentation": "" }, "@roblox/global/Color3.fromHSV/param/1": { "documentation": "" }, "@roblox/global/Color3.fromHSV/param/2": { "documentation": "" }, "@roblox/global/Color3.fromHSV": { "documentation": "Returns a Color3 from the given hue, saturation, and value components.", "params": [ { "name": "hue", "documentation": "@roblox/global/Color3.fromHSV/param/0" }, { "name": "saturation", "documentation": "@roblox/global/Color3.fromHSV/param/1" }, { "name": "value", "documentation": "@roblox/global/Color3.fromHSV/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#fromHSV", "code_sample": "" }, "@roblox/global/Color3.fromHex/param/0": { "documentation": "" }, "@roblox/global/Color3.fromHex": { "documentation": "Returns a Color3 from a given hex value.", "params": [ { "name": "hex", "documentation": "@roblox/global/Color3.fromHex/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#fromHex", "code_sample": "" }, "@roblox/global/Color3.toHSV/param/0": { "documentation": "" }, "@roblox/global/Color3.toHSV/return/0": { "documentation": "" }, "@roblox/global/Color3.toHSV/return/1": { "documentation": "" }, "@roblox/global/Color3.toHSV/return/2": { "documentation": "" }, "@roblox/global/Color3.toHSV": { "documentation": "Returns the hue, saturation, and value of a Color3.", "params": [ { "name": "color", "documentation": "@roblox/global/Color3.toHSV/param/0" } ], "returns": [ "@roblox/global/Color3.toHSV/return/0", "@roblox/global/Color3.toHSV/return/1", "@roblox/global/Color3.toHSV/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#toHSV", "code_sample": "" }, "@roblox/globaltype/Color3": { "documentation": "A color value comprised of red, green, and blue components.", "keys": { "R": "@roblox/globaltype/Color3.R", "G": "@roblox/globaltype/Color3.G", "B": "@roblox/globaltype/Color3.B", "toHSV": "@roblox/globaltype/Color3.toHSV", "Lerp": "@roblox/globaltype/Color3.Lerp", "ToHSV": "@roblox/globaltype/Color3.ToHSV", "ToHex": "@roblox/globaltype/Color3.ToHex" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3", "code_sample": "" }, "@roblox/globaltype/Color3.R": { "documentation": "The red value of the color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#R", "code_sample": "" }, "@roblox/globaltype/Color3.G": { "documentation": "The green value of the color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#G", "code_sample": "" }, "@roblox/globaltype/Color3.B": { "documentation": "The blue value of the color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#B", "code_sample": "" }, "@roblox/globaltype/Color3.toHSV/param/0": { "documentation": "" }, "@roblox/globaltype/Color3.toHSV/return/0": { "documentation": "" }, "@roblox/globaltype/Color3.toHSV/return/1": { "documentation": "" }, "@roblox/globaltype/Color3.toHSV/return/2": { "documentation": "" }, "@roblox/globaltype/Color3.toHSV": { "documentation": "Returns the hue, saturation, and value of a Color3.", "params": [ { "name": "color", "documentation": "@roblox/globaltype/Color3.toHSV/param/0" } ], "returns": [ "@roblox/globaltype/Color3.toHSV/return/0", "@roblox/globaltype/Color3.toHSV/return/1", "@roblox/globaltype/Color3.toHSV/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#toHSV", "code_sample": "" }, "@roblox/globaltype/Color3.Lerp/param/0": { "documentation": "A color value comprised of red, green, and blue components." }, "@roblox/globaltype/Color3.Lerp/param/1": { "documentation": "" }, "@roblox/globaltype/Color3.Lerp/param/2": { "documentation": "" }, "@roblox/globaltype/Color3.Lerp/return/0": { "documentation": "" }, "@roblox/globaltype/Color3.Lerp": { "documentation": "Returns a Color3 interpolated between two colors.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3.Lerp/param/0" }, { "name": "color", "documentation": "@roblox/globaltype/Color3.Lerp/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/Color3.Lerp/param/2" } ], "returns": [ "@roblox/globaltype/Color3.Lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#Lerp", "code_sample": "" }, "@roblox/globaltype/Color3.ToHSV/param/0": { "documentation": "A color value comprised of red, green, and blue components." }, "@roblox/globaltype/Color3.ToHSV/return/0": { "documentation": "" }, "@roblox/globaltype/Color3.ToHSV/return/1": { "documentation": "" }, "@roblox/globaltype/Color3.ToHSV/return/2": { "documentation": "" }, "@roblox/globaltype/Color3.ToHSV": { "documentation": "Returns the hue, saturation, and value of a Color3.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3.ToHSV/param/0" } ], "returns": [ "@roblox/globaltype/Color3.ToHSV/return/0", "@roblox/globaltype/Color3.ToHSV/return/1", "@roblox/globaltype/Color3.ToHSV/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#ToHSV", "code_sample": "" }, "@roblox/globaltype/Color3.ToHex/param/0": { "documentation": "A color value comprised of red, green, and blue components." }, "@roblox/globaltype/Color3.ToHex/return/0": { "documentation": "" }, "@roblox/globaltype/Color3.ToHex": { "documentation": "Returns the hex code of a Color3.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3.ToHex/param/0" } ], "returns": [ "@roblox/globaltype/Color3.ToHex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Color3#ToHex", "code_sample": "" }, "@roblox/global/Region3int16": { "documentation": "Represents a Region3 stored as two boundaries as opposed to position and size components.", "keys": { "new": "@roblox/global/Region3int16.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3int16", "code_sample": "" }, "@roblox/global/Region3int16.new/param/0": { "documentation": "" }, "@roblox/global/Region3int16.new/param/1": { "documentation": "" }, "@roblox/global/Region3int16.new": { "documentation": "Returns a new Region3int16 from the provided boundaries.", "params": [ { "name": "min", "documentation": "@roblox/global/Region3int16.new/param/0" }, { "name": "max", "documentation": "@roblox/global/Region3int16.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3int16#new", "code_sample": "" }, "@roblox/globaltype/Region3int16": { "documentation": "Represents a Region3 stored as two boundaries as opposed to position and size components.", "keys": { "Min": "@roblox/globaltype/Region3int16.Min", "Max": "@roblox/globaltype/Region3int16.Max" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3int16", "code_sample": "" }, "@roblox/globaltype/Region3int16.Min": { "documentation": "The lower bound of the Region3int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3int16#Min", "code_sample": "" }, "@roblox/globaltype/Region3int16.Max": { "documentation": "The upper bound of the Region3int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3int16#Max", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams": { "documentation": "Stores parameters used in catalog searches via AvatarEditorService:SearchCatalogAsync().", "keys": { "SearchKeyword": "@roblox/globaltype/CatalogSearchParams.SearchKeyword", "MinPrice": "@roblox/globaltype/CatalogSearchParams.MinPrice", "MaxPrice": "@roblox/globaltype/CatalogSearchParams.MaxPrice", "SortType": "@roblox/globaltype/CatalogSearchParams.SortType", "SortAggregation": "@roblox/globaltype/CatalogSearchParams.SortAggregation", "CategoryFilter": "@roblox/globaltype/CatalogSearchParams.CategoryFilter", "SalesTypeFilter": "@roblox/globaltype/CatalogSearchParams.SalesTypeFilter", "BundleTypes": "@roblox/globaltype/CatalogSearchParams.BundleTypes", "AssetTypes": "@roblox/globaltype/CatalogSearchParams.AssetTypes", "IncludeOffSale": "@roblox/globaltype/CatalogSearchParams.IncludeOffSale", "CreatorName": "@roblox/globaltype/CatalogSearchParams.CreatorName", "CreatorType": "@roblox/globaltype/CatalogSearchParams.CreatorType", "CreatorId": "@roblox/globaltype/CatalogSearchParams.CreatorId", "Limit": "@roblox/globaltype/CatalogSearchParams.Limit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.SearchKeyword": { "documentation": "The keyword to search for catalog results with.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#SearchKeyword", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.MinPrice": { "documentation": "The minimum item price to search for.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#MinPrice", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.MaxPrice": { "documentation": "The maximum item price to search for.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#MaxPrice", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.SortType": { "documentation": "The order in which to sort the results.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#SortType", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.SortAggregation": { "documentation": "The time period to use to aggregate the sort results.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#SortAggregation", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.CategoryFilter": { "documentation": "The category to filter the search by.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#CategoryFilter", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.SalesTypeFilter": { "documentation": "The sales type filter the search by.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#SalesTypeFilter", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.BundleTypes": { "documentation": "An array containing BundleType values to filter the search by.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#BundleTypes", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.AssetTypes": { "documentation": "An array containing AvatarAssetType values to filter the search by.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#AssetTypes", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.IncludeOffSale": { "documentation": "Whether off sale items should be included in the results.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#IncludeOffSale", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.CreatorName": { "documentation": "Search for items with the given creator name.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#CreatorName", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.CreatorType": { "documentation": "Search for items created by the given creator type.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#CreatorType", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.CreatorId": { "documentation": "Search for items created by the given creator ID.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#CreatorId", "code_sample": "" }, "@roblox/globaltype/CatalogSearchParams.Limit": { "documentation": "Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CatalogSearchParams#Limit", "code_sample": "" }, "@roblox/global/RotationCurveKey": { "documentation": "A time-value pair used with RotationCurve instances.", "keys": { "new": "@roblox/global/RotationCurveKey.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey", "code_sample": "" }, "@roblox/global/RotationCurveKey.new/param/0": { "documentation": "Time at which to create the new RotationCurveKey." }, "@roblox/global/RotationCurveKey.new/param/1": { "documentation": "CFrame of the new RotationCurveKey." }, "@roblox/global/RotationCurveKey.new/param/2": { "documentation": "" }, "@roblox/global/RotationCurveKey.new": { "documentation": "Returns a new RotationCurveKey at a given time with a given CFrame.", "params": [ { "name": "time", "documentation": "@roblox/global/RotationCurveKey.new/param/0" }, { "name": "cframe", "documentation": "@roblox/global/RotationCurveKey.new/param/1" }, { "name": "Interpolation", "documentation": "@roblox/global/RotationCurveKey.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey#new", "code_sample": "" }, "@roblox/globaltype/RotationCurveKey": { "documentation": "A time-value pair used with RotationCurve instances.", "keys": { "Interpolation": "@roblox/globaltype/RotationCurveKey.Interpolation", "Time": "@roblox/globaltype/RotationCurveKey.Time", "Value": "@roblox/globaltype/RotationCurveKey.Value", "RightTangent": "@roblox/globaltype/RotationCurveKey.RightTangent", "LeftTangent": "@roblox/globaltype/RotationCurveKey.LeftTangent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey", "code_sample": "" }, "@roblox/globaltype/RotationCurveKey.Interpolation": { "documentation": "The key interpolation mode for the segment started by this RotationCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey#Interpolation", "code_sample": "" }, "@roblox/globaltype/RotationCurveKey.Time": { "documentation": "The time position of this RotationCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey#Time", "code_sample": "" }, "@roblox/globaltype/RotationCurveKey.Value": { "documentation": "The CFrame value of this RotationCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey#Value", "code_sample": "" }, "@roblox/globaltype/RotationCurveKey.RightTangent": { "documentation": "The tangent to the right of this RotationCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey#RightTangent", "code_sample": "" }, "@roblox/globaltype/RotationCurveKey.LeftTangent": { "documentation": "The tangent to the left of this RotationCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RotationCurveKey#LeftTangent", "code_sample": "" }, "@roblox/global/Content": { "documentation": "Represents a reference to asset content stored externally or as an object within the place.", "keys": { "fromUri": "@roblox/global/Content.fromUri", "fromObject": "@roblox/global/Content.fromObject", "none": "@roblox/global/Content.none" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content", "code_sample": "" }, "@roblox/global/Content.fromUri/param/0": { "documentation": "The asset URI string." }, "@roblox/global/Content.fromUri": { "documentation": "Returns a new Content with an asset URI string value referencing content external to the place.", "params": [ { "name": "uri", "documentation": "@roblox/global/Content.fromUri/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#fromUri", "code_sample": "" }, "@roblox/global/Content.fromObject/param/0": { "documentation": "The Object to reference." }, "@roblox/global/Content.fromObject": { "documentation": "Returns a new Content with a strong reference to an Object.", "params": [ { "name": "object", "documentation": "@roblox/global/Content.fromObject/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#fromObject", "code_sample": "" }, "@roblox/global/Content.none": { "documentation": "An empty Content value with Content.SourceType of None.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#none", "code_sample": "" }, "@roblox/globaltype/Content": { "documentation": "Represents a reference to asset content stored externally or as an object within the place.", "keys": { "none": "@roblox/globaltype/Content.none", "SourceType": "@roblox/globaltype/Content.SourceType", "Uri": "@roblox/globaltype/Content.Uri", "Object": "@roblox/globaltype/Content.Object", "Opaque": "@roblox/globaltype/Content.Opaque" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content", "code_sample": "" }, "@roblox/globaltype/Content.none": { "documentation": "An empty Content value with Content.SourceType of None.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#none", "code_sample": "" }, "@roblox/globaltype/Content.SourceType": { "documentation": "The source type of the contained value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#SourceType", "code_sample": "" }, "@roblox/globaltype/Content.Uri": { "documentation": "A URI string if Content.SourceType is Uri, otherwise nil.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#Uri", "code_sample": "" }, "@roblox/globaltype/Content.Object": { "documentation": "A reference to a non-nil Object if Content.SourceType is Object, otherwise nil.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#Object", "code_sample": "" }, "@roblox/globaltype/Content.Opaque": { "documentation": "A reference to a non-nil Opaque content if Content.SourceType is Opaque, otherwise nil.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Content#Opaque", "code_sample": "" }, "@roblox/global/ColorSequence": { "documentation": "A gradient of color values comprised of ColorSequenceKeypoints.", "keys": { "new": "@roblox/global/ColorSequence.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence", "code_sample": "" }, "@roblox/global/ColorSequence.new": { "overloads": { "(Color3) -> ColorSequence": "@roblox/global/ColorSequence.new/overload/(Color3) -> ColorSequence", "(Color3, Color3) -> ColorSequence": "@roblox/global/ColorSequence.new/overload/(Color3, Color3) -> ColorSequence", "(table) -> ColorSequence": "@roblox/global/ColorSequence.new/overload/(table) -> ColorSequence" } }, "@roblox/global/ColorSequence.new/overload/(Color3) -> ColorSequence/param/0": { "documentation": "" }, "@roblox/global/ColorSequence.new/overload/(Color3) -> ColorSequence": { "documentation": "Returns a new ColorSequence that is entirely the specified color.", "params": [ { "name": "c", "documentation": "@roblox/global/ColorSequence.new/overload/(Color3) -> ColorSequence/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence#new", "code_sample": "" }, "@roblox/global/ColorSequence.new/overload/(Color3, Color3) -> ColorSequence/param/0": { "documentation": "" }, "@roblox/global/ColorSequence.new/overload/(Color3, Color3) -> ColorSequence/param/1": { "documentation": "" }, "@roblox/global/ColorSequence.new/overload/(Color3, Color3) -> ColorSequence": { "documentation": "Returns a new ColorSequence with c0 as the start value and c1 as the end value.", "params": [ { "name": "c0", "documentation": "@roblox/global/ColorSequence.new/overload/(Color3, Color3) -> ColorSequence/param/0" }, { "name": "c1", "documentation": "@roblox/global/ColorSequence.new/overload/(Color3, Color3) -> ColorSequence/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence#new", "code_sample": "" }, "@roblox/global/ColorSequence.new/overload/(table) -> ColorSequence/param/0": { "documentation": "" }, "@roblox/global/ColorSequence.new/overload/(table) -> ColorSequence": { "documentation": "Returns a new ColorSequence from an array of ColorSequenceKeypoints.", "params": [ { "name": "keypoints", "documentation": "@roblox/global/ColorSequence.new/overload/(table) -> ColorSequence/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence#new", "code_sample": "" }, "@roblox/globaltype/ColorSequence": { "documentation": "A gradient of color values comprised of ColorSequenceKeypoints.", "keys": { "Keypoints": "@roblox/globaltype/ColorSequence.Keypoints" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence", "code_sample": "" }, "@roblox/globaltype/ColorSequence.Keypoints": { "documentation": "An array of ColorSequenceKeypoint values in ascending order.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequence#Keypoints", "code_sample": "" }, "@roblox/global/Faces": { "documentation": "A data type containing six booleans, each representing a face of a BasePart.", "keys": { "new": "@roblox/global/Faces.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces", "code_sample": "" }, "@roblox/global/Faces.new/param/0": { "documentation": "" }, "@roblox/global/Faces.new": { "documentation": "Returns a Faces with the corresponding face of each passed NormalId as true.", "params": [ { "name": "normalIds...", "documentation": "@roblox/global/Faces.new/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#new", "code_sample": "" }, "@roblox/globaltype/Faces": { "documentation": "A data type containing six booleans, each representing a face of a BasePart.", "keys": { "Top": "@roblox/globaltype/Faces.Top", "Bottom": "@roblox/globaltype/Faces.Bottom", "Left": "@roblox/globaltype/Faces.Left", "Right": "@roblox/globaltype/Faces.Right", "Back": "@roblox/globaltype/Faces.Back", "Front": "@roblox/globaltype/Faces.Front" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces", "code_sample": "" }, "@roblox/globaltype/Faces.Top": { "documentation": "Whether the top face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#Top", "code_sample": "" }, "@roblox/globaltype/Faces.Bottom": { "documentation": "Whether the bottom face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#Bottom", "code_sample": "" }, "@roblox/globaltype/Faces.Left": { "documentation": "Whether the left face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#Left", "code_sample": "" }, "@roblox/globaltype/Faces.Right": { "documentation": "Whether the right face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#Right", "code_sample": "" }, "@roblox/globaltype/Faces.Back": { "documentation": "Whether the back face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#Back", "code_sample": "" }, "@roblox/globaltype/Faces.Front": { "documentation": "Whether the front face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Faces#Front", "code_sample": "" }, "@roblox/global/OverlapParams": { "documentation": "Stores parameters used in boundary-querying functions.", "keys": { "new": "@roblox/global/OverlapParams.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams", "code_sample": "" }, "@roblox/global/OverlapParams.new": { "documentation": "Returns a blank OverlapParams object.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#new", "code_sample": "" }, "@roblox/globaltype/OverlapParams": { "documentation": "Stores parameters used in boundary-querying functions.", "keys": { "FilterDescendantsInstances": "@roblox/globaltype/OverlapParams.FilterDescendantsInstances", "FilterType": "@roblox/globaltype/OverlapParams.FilterType", "MaxParts": "@roblox/globaltype/OverlapParams.MaxParts", "CollisionGroup": "@roblox/globaltype/OverlapParams.CollisionGroup", "Tolerance": "@roblox/globaltype/OverlapParams.Tolerance", "RespectCanCollide": "@roblox/globaltype/OverlapParams.RespectCanCollide", "BruteForceAllSlow": "@roblox/globaltype/OverlapParams.BruteForceAllSlow", "AddToFilter": "@roblox/globaltype/OverlapParams.AddToFilter" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams", "code_sample": "" }, "@roblox/globaltype/OverlapParams.FilterDescendantsInstances": { "documentation": "An array of objects whose descendants is used in filtering candidates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#FilterDescendantsInstances", "code_sample": "" }, "@roblox/globaltype/OverlapParams.FilterType": { "documentation": "Determines how the OverlapParams.FilterDescendantsInstances list is used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#FilterType", "code_sample": "" }, "@roblox/globaltype/OverlapParams.MaxParts": { "documentation": "The maximum amount of parts to be returned by the query.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#MaxParts", "code_sample": "" }, "@roblox/globaltype/OverlapParams.CollisionGroup": { "documentation": "The collision group used for the operation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#CollisionGroup", "code_sample": "" }, "@roblox/globaltype/OverlapParams.Tolerance": { "documentation": "Slightly increases the volume of the boundary-querying operation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#Tolerance", "code_sample": "" }, "@roblox/globaltype/OverlapParams.RespectCanCollide": { "documentation": "Determines whether the boundary-querying operation considers a part's BasePart.CanCollide property value over its BasePart.CanQuery value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#RespectCanCollide", "code_sample": "" }, "@roblox/globaltype/OverlapParams.BruteForceAllSlow": { "documentation": "When enabled, the query will ignore all part collision properties and perform a brute-force check on every part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#BruteForceAllSlow", "code_sample": "" }, "@roblox/globaltype/OverlapParams.AddToFilter/param/0": { "documentation": "Stores parameters used in boundary-querying functions." }, "@roblox/globaltype/OverlapParams.AddToFilter/param/1": { "documentation": "An instance or an array containing instances to add." }, "@roblox/globaltype/OverlapParams.AddToFilter": { "documentation": "Adds the instances provided to FilterDescendantsInstances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/OverlapParams.AddToFilter/param/0" }, { "name": "instances", "documentation": "@roblox/globaltype/OverlapParams.AddToFilter/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#AddToFilter", "code_sample": "" }, "@roblox/global/NumberRange": { "documentation": "Represents a range of numbers.", "keys": { "new": "@roblox/global/NumberRange.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberRange", "code_sample": "" }, "@roblox/global/NumberRange.new": { "overloads": { "(number) -> NumberRange": "@roblox/global/NumberRange.new/overload/(number) -> NumberRange", "(number, number) -> NumberRange": "@roblox/global/NumberRange.new/overload/(number, number) -> NumberRange" } }, "@roblox/global/NumberRange.new/overload/(number) -> NumberRange/param/0": { "documentation": "" }, "@roblox/global/NumberRange.new/overload/(number) -> NumberRange": { "documentation": "Returns a new NumberRange with the minimum and maximum set to the value.", "params": [ { "name": "value", "documentation": "@roblox/global/NumberRange.new/overload/(number) -> NumberRange/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberRange#new", "code_sample": "" }, "@roblox/global/NumberRange.new/overload/(number, number) -> NumberRange/param/0": { "documentation": "" }, "@roblox/global/NumberRange.new/overload/(number, number) -> NumberRange/param/1": { "documentation": "" }, "@roblox/global/NumberRange.new/overload/(number, number) -> NumberRange": { "documentation": "Returns a new NumberRange with the provided minimum and maximum.", "params": [ { "name": "minimum", "documentation": "@roblox/global/NumberRange.new/overload/(number, number) -> NumberRange/param/0" }, { "name": "maximum", "documentation": "@roblox/global/NumberRange.new/overload/(number, number) -> NumberRange/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberRange#new", "code_sample": "" }, "@roblox/globaltype/NumberRange": { "documentation": "Represents a range of numbers.", "keys": { "Min": "@roblox/globaltype/NumberRange.Min", "Max": "@roblox/globaltype/NumberRange.Max" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberRange", "code_sample": "" }, "@roblox/globaltype/NumberRange.Min": { "documentation": "The minimum value of the NumberRange.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberRange#Min", "code_sample": "" }, "@roblox/globaltype/NumberRange.Max": { "documentation": "The maximum value of the NumberRange.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberRange#Max", "code_sample": "" }, "@roblox/global/Vector3int16": { "documentation": "A Vector3 with signed 16-bit integers for components.", "keys": { "new": "@roblox/global/Vector3int16.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16", "code_sample": "" }, "@roblox/global/Vector3int16.new/param/0": { "documentation": "" }, "@roblox/global/Vector3int16.new/param/1": { "documentation": "" }, "@roblox/global/Vector3int16.new/param/2": { "documentation": "" }, "@roblox/global/Vector3int16.new": { "documentation": "Returns a new Vector3int16 from the given x, y, and z components.", "params": [ { "name": "x", "documentation": "@roblox/global/Vector3int16.new/param/0" }, { "name": "y", "documentation": "@roblox/global/Vector3int16.new/param/1" }, { "name": "z", "documentation": "@roblox/global/Vector3int16.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16#new", "code_sample": "" }, "@roblox/globaltype/Vector3int16": { "documentation": "A Vector3 with signed 16-bit integers for components.", "keys": { "X": "@roblox/globaltype/Vector3int16.X", "Y": "@roblox/globaltype/Vector3int16.Y", "Z": "@roblox/globaltype/Vector3int16.Z" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16", "code_sample": "" }, "@roblox/globaltype/Vector3int16.X": { "documentation": "The x-coordinate of the Vector3int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16#X", "code_sample": "" }, "@roblox/globaltype/Vector3int16.Y": { "documentation": "The y-coordinate of the Vector3int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16#Y", "code_sample": "" }, "@roblox/globaltype/Vector3int16.Z": { "documentation": "The z-coordinate of the Vector3int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3int16#Z", "code_sample": "" }, "@roblox/global/Vector2": { "documentation": "Represents a 2D value with direction and magnitude.", "keys": { "new": "@roblox/global/Vector2.new", "zero": "@roblox/global/Vector2.zero", "one": "@roblox/global/Vector2.one", "xAxis": "@roblox/global/Vector2.xAxis", "yAxis": "@roblox/global/Vector2.yAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2", "code_sample": "" }, "@roblox/global/Vector2.new/param/0": { "documentation": "" }, "@roblox/global/Vector2.new/param/1": { "documentation": "" }, "@roblox/global/Vector2.new": { "documentation": "Returns a Vector2 from the given x and y components.", "params": [ { "name": "x", "documentation": "@roblox/global/Vector2.new/param/0" }, { "name": "y", "documentation": "@roblox/global/Vector2.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#new", "code_sample": "" }, "@roblox/global/Vector2.zero": { "documentation": "A Vector2 with a magnitude of zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#zero", "code_sample": "" }, "@roblox/global/Vector2.one": { "documentation": "A Vector2 with a value of 1 on every axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#one", "code_sample": "" }, "@roblox/global/Vector2.xAxis": { "documentation": "A Vector2 with a value of 1 on the X axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#xAxis", "code_sample": "" }, "@roblox/global/Vector2.yAxis": { "documentation": "A Vector2 with a value of 1 on the Y axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#yAxis", "code_sample": "" }, "@roblox/globaltype/Vector2": { "documentation": "Represents a 2D value with direction and magnitude.", "keys": { "zero": "@roblox/globaltype/Vector2.zero", "one": "@roblox/globaltype/Vector2.one", "xAxis": "@roblox/globaltype/Vector2.xAxis", "yAxis": "@roblox/globaltype/Vector2.yAxis", "X": "@roblox/globaltype/Vector2.X", "Y": "@roblox/globaltype/Vector2.Y", "Magnitude": "@roblox/globaltype/Vector2.Magnitude", "Unit": "@roblox/globaltype/Vector2.Unit", "Cross": "@roblox/globaltype/Vector2.Cross", "Abs": "@roblox/globaltype/Vector2.Abs", "Ceil": "@roblox/globaltype/Vector2.Ceil", "Floor": "@roblox/globaltype/Vector2.Floor", "Sign": "@roblox/globaltype/Vector2.Sign", "Angle": "@roblox/globaltype/Vector2.Angle", "Dot": "@roblox/globaltype/Vector2.Dot", "Lerp": "@roblox/globaltype/Vector2.Lerp", "Max": "@roblox/globaltype/Vector2.Max", "Min": "@roblox/globaltype/Vector2.Min", "FuzzyEq": "@roblox/globaltype/Vector2.FuzzyEq" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2", "code_sample": "" }, "@roblox/globaltype/Vector2.zero": { "documentation": "A Vector2 with a magnitude of zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#zero", "code_sample": "" }, "@roblox/globaltype/Vector2.one": { "documentation": "A Vector2 with a value of 1 on every axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#one", "code_sample": "" }, "@roblox/globaltype/Vector2.xAxis": { "documentation": "A Vector2 with a value of 1 on the X axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#xAxis", "code_sample": "" }, "@roblox/globaltype/Vector2.yAxis": { "documentation": "A Vector2 with a value of 1 on the y axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#yAxis", "code_sample": "" }, "@roblox/globaltype/Vector2.X": { "documentation": "The x-coordinate of the Vector2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#X", "code_sample": "" }, "@roblox/globaltype/Vector2.Y": { "documentation": "The y-coordinate of the Vector2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Y", "code_sample": "" }, "@roblox/globaltype/Vector2.Magnitude": { "documentation": "The length of the Vector2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Magnitude", "code_sample": "" }, "@roblox/globaltype/Vector2.Unit": { "documentation": "A normalized copy of the Vector2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Unit", "code_sample": "" }, "@roblox/globaltype/Vector2.Cross/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Cross/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.Cross/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Cross": { "documentation": "Returns the cross product of the two vectors.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Cross/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector2.Cross/param/1" } ], "returns": [ "@roblox/globaltype/Vector2.Cross/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Cross", "code_sample": "" }, "@roblox/globaltype/Vector2.Abs/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Abs/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Abs": { "documentation": "Returns a new vector from the absolute values of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Abs/param/0" } ], "returns": [ "@roblox/globaltype/Vector2.Abs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Abs", "code_sample": "" }, "@roblox/globaltype/Vector2.Ceil/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Ceil/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Ceil": { "documentation": "Returns a new vector from the ceiling of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Ceil/param/0" } ], "returns": [ "@roblox/globaltype/Vector2.Ceil/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Ceil", "code_sample": "" }, "@roblox/globaltype/Vector2.Floor/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Floor/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Floor": { "documentation": "Returns a new vector from the floor of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Floor/param/0" } ], "returns": [ "@roblox/globaltype/Vector2.Floor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Floor", "code_sample": "" }, "@roblox/globaltype/Vector2.Sign/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Sign/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Sign": { "documentation": "Returns a new vector from the sign (-1, 0, or 1) of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Sign/param/0" } ], "returns": [ "@roblox/globaltype/Vector2.Sign/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Sign", "code_sample": "" }, "@roblox/globaltype/Vector2.Angle/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Angle/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.Angle/param/2": { "documentation": "" }, "@roblox/globaltype/Vector2.Angle/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Angle": { "documentation": "Returns the angle in radians between the two vectors.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Angle/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector2.Angle/param/1" }, { "name": "isSigned", "documentation": "@roblox/globaltype/Vector2.Angle/param/2" } ], "returns": [ "@roblox/globaltype/Vector2.Angle/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Angle", "code_sample": "" }, "@roblox/globaltype/Vector2.Dot/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Dot/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.Dot/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Dot": { "documentation": "Returns a scalar dot product of the two vectors.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Dot/param/0" }, { "name": "v", "documentation": "@roblox/globaltype/Vector2.Dot/param/1" } ], "returns": [ "@roblox/globaltype/Vector2.Dot/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Dot", "code_sample": "" }, "@roblox/globaltype/Vector2.Lerp/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Lerp/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.Lerp/param/2": { "documentation": "" }, "@roblox/globaltype/Vector2.Lerp/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Lerp": { "documentation": "Returns a Vector2 linearly interpolated between this Vector2 and the given goal by the given alpha.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Lerp/param/0" }, { "name": "v", "documentation": "@roblox/globaltype/Vector2.Lerp/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/Vector2.Lerp/param/2" } ], "returns": [ "@roblox/globaltype/Vector2.Lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Lerp", "code_sample": "" }, "@roblox/globaltype/Vector2.Max/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Max/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.Max/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Max": { "documentation": "Returns a Vector2 with each component as the highest among the respective components of the provided Vector2 objects.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Max/param/0" }, { "name": "others...", "documentation": "@roblox/globaltype/Vector2.Max/param/1" } ], "returns": [ "@roblox/globaltype/Vector2.Max/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Max", "code_sample": "" }, "@roblox/globaltype/Vector2.Min/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.Min/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.Min/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.Min": { "documentation": "Returns a Vector2 with each component as the lowest among the respective components of the provided Vector2 objects.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.Min/param/0" }, { "name": "others...", "documentation": "@roblox/globaltype/Vector2.Min/param/1" } ], "returns": [ "@roblox/globaltype/Vector2.Min/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#Min", "code_sample": "" }, "@roblox/globaltype/Vector2.FuzzyEq/param/0": { "documentation": "Represents a 2D value with direction and magnitude." }, "@roblox/globaltype/Vector2.FuzzyEq/param/1": { "documentation": "" }, "@roblox/globaltype/Vector2.FuzzyEq/param/2": { "documentation": "" }, "@roblox/globaltype/Vector2.FuzzyEq/return/0": { "documentation": "" }, "@roblox/globaltype/Vector2.FuzzyEq": { "documentation": "Returns true if the X and Y components of the other Vector2 are within epsilon units of each corresponding component of this Vector2.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector2.FuzzyEq/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector2.FuzzyEq/param/1" }, { "name": "epsilon", "documentation": "@roblox/globaltype/Vector2.FuzzyEq/param/2" } ], "returns": [ "@roblox/globaltype/Vector2.FuzzyEq/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2#FuzzyEq", "code_sample": "" }, "@roblox/global/NumberSequence": { "documentation": "A series of floats across a period of time.", "keys": { "new": "@roblox/global/NumberSequence.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence", "code_sample": "" }, "@roblox/global/NumberSequence.new": { "overloads": { "(number) -> NumberSequence": "@roblox/global/NumberSequence.new/overload/(number) -> NumberSequence", "(number, number) -> NumberSequence": "@roblox/global/NumberSequence.new/overload/(number, number) -> NumberSequence", "(table) -> NumberSequence": "@roblox/global/NumberSequence.new/overload/(table) -> NumberSequence" } }, "@roblox/global/NumberSequence.new/overload/(number) -> NumberSequence/param/0": { "documentation": "" }, "@roblox/global/NumberSequence.new/overload/(number) -> NumberSequence": { "documentation": "Returns a NumberSequence with the start and end values set to the provided n.", "params": [ { "name": "n", "documentation": "@roblox/global/NumberSequence.new/overload/(number) -> NumberSequence/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence#new", "code_sample": "" }, "@roblox/global/NumberSequence.new/overload/(number, number) -> NumberSequence/param/0": { "documentation": "" }, "@roblox/global/NumberSequence.new/overload/(number, number) -> NumberSequence/param/1": { "documentation": "" }, "@roblox/global/NumberSequence.new/overload/(number, number) -> NumberSequence": { "documentation": "Returns a NumberSequence of two keypoints with n0 as the start value and n1 as the end value.", "params": [ { "name": "n0", "documentation": "@roblox/global/NumberSequence.new/overload/(number, number) -> NumberSequence/param/0" }, { "name": "n1", "documentation": "@roblox/global/NumberSequence.new/overload/(number, number) -> NumberSequence/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence#new", "code_sample": "" }, "@roblox/global/NumberSequence.new/overload/(table) -> NumberSequence/param/0": { "documentation": "" }, "@roblox/global/NumberSequence.new/overload/(table) -> NumberSequence": { "documentation": "Returns a NumberSequence from an array of NumberSequenceKeypoints.", "params": [ { "name": "Keypoints", "documentation": "@roblox/global/NumberSequence.new/overload/(table) -> NumberSequence/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence#new", "code_sample": "" }, "@roblox/globaltype/NumberSequence": { "documentation": "A series of floats across a period of time.", "keys": { "Keypoints": "@roblox/globaltype/NumberSequence.Keypoints" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence", "code_sample": "" }, "@roblox/globaltype/NumberSequence.Keypoints": { "documentation": "An array of NumberSequenceKeypoint values in ascending order.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequence#Keypoints", "code_sample": "" }, "@roblox/global/FloatCurveKey": { "documentation": "A time-value pair used with FloatCurve instances.", "keys": { "new": "@roblox/global/FloatCurveKey.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey", "code_sample": "" }, "@roblox/global/FloatCurveKey.new/param/0": { "documentation": "Time at which to create the new FloatCurveKey." }, "@roblox/global/FloatCurveKey.new/param/1": { "documentation": "Value of the new FloatCurveKey." }, "@roblox/global/FloatCurveKey.new/param/2": { "documentation": "" }, "@roblox/global/FloatCurveKey.new": { "documentation": "Returns a new FloatCurveKey from the given time and value.", "params": [ { "name": "time", "documentation": "@roblox/global/FloatCurveKey.new/param/0" }, { "name": "value", "documentation": "@roblox/global/FloatCurveKey.new/param/1" }, { "name": "Interpolation", "documentation": "@roblox/global/FloatCurveKey.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey#new", "code_sample": "" }, "@roblox/globaltype/FloatCurveKey": { "documentation": "A time-value pair used with FloatCurve instances.", "keys": { "Interpolation": "@roblox/globaltype/FloatCurveKey.Interpolation", "Time": "@roblox/globaltype/FloatCurveKey.Time", "Value": "@roblox/globaltype/FloatCurveKey.Value", "RightTangent": "@roblox/globaltype/FloatCurveKey.RightTangent", "LeftTangent": "@roblox/globaltype/FloatCurveKey.LeftTangent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey", "code_sample": "" }, "@roblox/globaltype/FloatCurveKey.Interpolation": { "documentation": "The key interpolation mode for the segment started by this FloatCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey#Interpolation", "code_sample": "" }, "@roblox/globaltype/FloatCurveKey.Time": { "documentation": "The time position of this FloatCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey#Time", "code_sample": "" }, "@roblox/globaltype/FloatCurveKey.Value": { "documentation": "The value of this FloatCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey#Value", "code_sample": "" }, "@roblox/globaltype/FloatCurveKey.RightTangent": { "documentation": "The tangent to the right of this FloatCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey#RightTangent", "code_sample": "" }, "@roblox/globaltype/FloatCurveKey.LeftTangent": { "documentation": "The tangent to the left of this FloatCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/FloatCurveKey#LeftTangent", "code_sample": "" }, "@roblox/global/Random": { "documentation": "Generates pseudorandom numbers and directions.", "keys": { "new": "@roblox/global/Random.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random", "code_sample": "" }, "@roblox/global/Random.new/param/0": { "documentation": "" }, "@roblox/global/Random.new": { "documentation": "Returns a new pseudorandom generator using an optional seed.", "params": [ { "name": "seed", "documentation": "@roblox/global/Random.new/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#new", "code_sample": "local max = 2147483647 -- use a large integer\nlocal seed = math.random(max)\nlocal generator = Random.new(seed)" }, "@roblox/globaltype/Random": { "documentation": "Generates pseudorandom numbers and directions.", "keys": { "NextInteger": "@roblox/globaltype/Random.NextInteger", "NextNumber": "@roblox/globaltype/Random.NextNumber", "Shuffle": "@roblox/globaltype/Random.Shuffle", "NextUnitVector": "@roblox/globaltype/Random.NextUnitVector", "Clone": "@roblox/globaltype/Random.Clone" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random", "code_sample": "" }, "@roblox/globaltype/Random.NextInteger/param/0": { "documentation": "Generates pseudorandom numbers and directions." }, "@roblox/globaltype/Random.NextInteger/param/1": { "documentation": "" }, "@roblox/globaltype/Random.NextInteger/param/2": { "documentation": "" }, "@roblox/globaltype/Random.NextInteger/return/0": { "documentation": "" }, "@roblox/globaltype/Random.NextInteger": { "documentation": "Returns a pseudorandom integer uniformly distributed over [min, max].", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Random.NextInteger/param/0" }, { "name": "min", "documentation": "@roblox/globaltype/Random.NextInteger/param/1" }, { "name": "max", "documentation": "@roblox/globaltype/Random.NextInteger/param/2" } ], "returns": [ "@roblox/globaltype/Random.NextInteger/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#NextInteger", "code_sample": "" }, "@roblox/globaltype/Random.NextNumber": { "overloads": { "(Random) -> number": "@roblox/globaltype/Random.NextNumber/overload/(Random) -> number", "(Random, number, number) -> number": "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number" } }, "@roblox/globaltype/Random.NextNumber/overload/(Random) -> number/param/0": { "documentation": "Generates pseudorandom numbers and directions." }, "@roblox/globaltype/Random.NextNumber/overload/(Random) -> number/return/0": { "documentation": "" }, "@roblox/globaltype/Random.NextNumber/overload/(Random) -> number": { "documentation": "Returns a pseudorandom number uniformly distributed over [0, 1].", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Random.NextNumber/overload/(Random) -> number/param/0" } ], "returns": [ "@roblox/globaltype/Random.NextNumber/overload/(Random) -> number/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#NextNumber", "code_sample": "" }, "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/param/0": { "documentation": "Generates pseudorandom numbers and directions." }, "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/param/1": { "documentation": "" }, "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/param/2": { "documentation": "" }, "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/return/0": { "documentation": "" }, "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number": { "documentation": "Returns a pseudorandom number uniformly distributed over [min, max].", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/param/0" }, { "name": "min", "documentation": "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/param/1" }, { "name": "max", "documentation": "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/param/2" } ], "returns": [ "@roblox/globaltype/Random.NextNumber/overload/(Random, number, number) -> number/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#NextNumber", "code_sample": "" }, "@roblox/globaltype/Random.Shuffle/param/0": { "documentation": "Generates pseudorandom numbers and directions." }, "@roblox/globaltype/Random.Shuffle/param/1": { "documentation": "" }, "@roblox/globaltype/Random.Shuffle": { "documentation": "Uniformly shuffles a table in-place.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Random.Shuffle/param/0" }, { "name": "tb", "documentation": "@roblox/globaltype/Random.Shuffle/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#Shuffle", "code_sample": "" }, "@roblox/globaltype/Random.NextUnitVector/param/0": { "documentation": "Generates pseudorandom numbers and directions." }, "@roblox/globaltype/Random.NextUnitVector/return/0": { "documentation": "A unit vector with a pseudorandom direction." }, "@roblox/globaltype/Random.NextUnitVector": { "documentation": "Returns a unit vector with a pseudorandom direction.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Random.NextUnitVector/param/0" } ], "returns": [ "@roblox/globaltype/Random.NextUnitVector/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#NextUnitVector", "code_sample": "" }, "@roblox/globaltype/Random.Clone/param/0": { "documentation": "Generates pseudorandom numbers and directions." }, "@roblox/globaltype/Random.Clone/return/0": { "documentation": "" }, "@roblox/globaltype/Random.Clone": { "documentation": "Returns a new Random object with the same state as the original.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Random.Clone/param/0" } ], "returns": [ "@roblox/globaltype/Random.Clone/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Random#Clone", "code_sample": "" }, "@roblox/global/NumberSequenceKeypoint": { "documentation": "Represents keypoint within a NumberSequence with a particular time, value, and envelope size.", "keys": { "new": "@roblox/global/NumberSequenceKeypoint.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint", "code_sample": "" }, "@roblox/global/NumberSequenceKeypoint.new": { "overloads": { "(number, number) -> NumberSequenceKeypoint": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number) -> NumberSequenceKeypoint", "(number, number, number) -> NumberSequenceKeypoint": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint" } }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number) -> NumberSequenceKeypoint/param/0": { "documentation": "" }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number) -> NumberSequenceKeypoint/param/1": { "documentation": "" }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number) -> NumberSequenceKeypoint": { "documentation": "Returns a keypoint with the specified time and value.", "params": [ { "name": "time", "documentation": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number) -> NumberSequenceKeypoint/param/0" }, { "name": "value", "documentation": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number) -> NumberSequenceKeypoint/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint#new", "code_sample": "" }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint/param/0": { "documentation": "" }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint/param/1": { "documentation": "" }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint/param/2": { "documentation": "" }, "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint": { "documentation": "Returns a keypoint with the specified time, value, and envelope.", "params": [ { "name": "time", "documentation": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint/param/0" }, { "name": "value", "documentation": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint/param/1" }, { "name": "envelope", "documentation": "@roblox/global/NumberSequenceKeypoint.new/overload/(number, number, number) -> NumberSequenceKeypoint/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint#new", "code_sample": "" }, "@roblox/globaltype/NumberSequenceKeypoint": { "documentation": "Represents keypoint within a NumberSequence with a particular time, value, and envelope size.", "keys": { "Envelope": "@roblox/globaltype/NumberSequenceKeypoint.Envelope", "Time": "@roblox/globaltype/NumberSequenceKeypoint.Time", "Value": "@roblox/globaltype/NumberSequenceKeypoint.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint", "code_sample": "" }, "@roblox/globaltype/NumberSequenceKeypoint.Envelope": { "documentation": "The amount of variance allowed from the value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint#Envelope", "code_sample": "" }, "@roblox/globaltype/NumberSequenceKeypoint.Time": { "documentation": "The relative time at which the keypoint is positioned.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint#Time", "code_sample": "" }, "@roblox/globaltype/NumberSequenceKeypoint.Value": { "documentation": "The base value of the keypoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/NumberSequenceKeypoint#Value", "code_sample": "" }, "@roblox/global/Region3": { "documentation": "Describes a rectangular volume in 3D space.", "keys": { "new": "@roblox/global/Region3.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3", "code_sample": "" }, "@roblox/global/Region3.new/param/0": { "documentation": "" }, "@roblox/global/Region3.new/param/1": { "documentation": "" }, "@roblox/global/Region3.new": { "documentation": "Returns a new Region3 using the provided vectors as boundaries.", "params": [ { "name": "min", "documentation": "@roblox/global/Region3.new/param/0" }, { "name": "max", "documentation": "@roblox/global/Region3.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3#new", "code_sample": "" }, "@roblox/globaltype/Region3": { "documentation": "Describes a rectangular volume in 3D space.", "keys": { "CFrame": "@roblox/globaltype/Region3.CFrame", "Size": "@roblox/globaltype/Region3.Size", "ExpandToGrid": "@roblox/globaltype/Region3.ExpandToGrid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3", "code_sample": "" }, "@roblox/globaltype/Region3.CFrame": { "documentation": "The center location and rotation of the Region3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3#CFrame", "code_sample": "" }, "@roblox/globaltype/Region3.Size": { "documentation": "The 3D size of the Region3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3#Size", "code_sample": "" }, "@roblox/globaltype/Region3.ExpandToGrid/param/0": { "documentation": "Describes a rectangular volume in 3D space." }, "@roblox/globaltype/Region3.ExpandToGrid/param/1": { "documentation": "" }, "@roblox/globaltype/Region3.ExpandToGrid/return/0": { "documentation": "" }, "@roblox/globaltype/Region3.ExpandToGrid": { "documentation": "Expands the Region3 to fit a grid based on the provided resolution.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Region3.ExpandToGrid/param/0" }, { "name": "resolution", "documentation": "@roblox/globaltype/Region3.ExpandToGrid/param/1" } ], "returns": [ "@roblox/globaltype/Region3.ExpandToGrid/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Region3#ExpandToGrid", "code_sample": "" }, "@roblox/global/Rect": { "documentation": "A value that represents a two-dimensional rectangle.", "keys": { "new": "@roblox/global/Rect.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect", "code_sample": "" }, "@roblox/global/Rect.new": { "overloads": { "() -> Rect": "@roblox/global/Rect.new/overload/() -> Rect", "(Vector2, Vector2) -> Rect": "@roblox/global/Rect.new/overload/(Vector2, Vector2) -> Rect", "(number, number, number, number) -> Rect": "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect" } }, "@roblox/global/Rect.new/overload/() -> Rect": { "documentation": "Returns a new Rect with zero Vector2 positions.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#new", "code_sample": "" }, "@roblox/global/Rect.new/overload/(Vector2, Vector2) -> Rect/param/0": { "documentation": "" }, "@roblox/global/Rect.new/overload/(Vector2, Vector2) -> Rect/param/1": { "documentation": "" }, "@roblox/global/Rect.new/overload/(Vector2, Vector2) -> Rect": { "documentation": "Returns a new Rect from the given Vector2 positions.", "params": [ { "name": "min", "documentation": "@roblox/global/Rect.new/overload/(Vector2, Vector2) -> Rect/param/0" }, { "name": "max", "documentation": "@roblox/global/Rect.new/overload/(Vector2, Vector2) -> Rect/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#new", "code_sample": "" }, "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/0": { "documentation": "" }, "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/1": { "documentation": "" }, "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/2": { "documentation": "" }, "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/3": { "documentation": "" }, "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect": { "documentation": "Returns a new Rect using the first and last two arguments as coordinates for corners.", "params": [ { "name": "minX", "documentation": "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/0" }, { "name": "minY", "documentation": "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/1" }, { "name": "maxX", "documentation": "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/2" }, { "name": "maxY", "documentation": "@roblox/global/Rect.new/overload/(number, number, number, number) -> Rect/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#new", "code_sample": "" }, "@roblox/globaltype/Rect": { "documentation": "A value that represents a two-dimensional rectangle.", "keys": { "Width": "@roblox/globaltype/Rect.Width", "Height": "@roblox/globaltype/Rect.Height", "Min": "@roblox/globaltype/Rect.Min", "Max": "@roblox/globaltype/Rect.Max" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect", "code_sample": "" }, "@roblox/globaltype/Rect.Width": { "documentation": "The width of the Rect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#Width", "code_sample": "" }, "@roblox/globaltype/Rect.Height": { "documentation": "The height of the Rect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#Height", "code_sample": "" }, "@roblox/globaltype/Rect.Min": { "documentation": "The coordinates of the top-left corner.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#Min", "code_sample": "" }, "@roblox/globaltype/Rect.Max": { "documentation": "The coordinates of the bottom-right corner.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Rect#Max", "code_sample": "" }, "@roblox/global/DockWidgetPluginGuiInfo": { "documentation": "Describes details for a DockWidgetPluginGui.", "keys": { "new": "@roblox/global/DockWidgetPluginGuiInfo.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo", "code_sample": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/0": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/1": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/2": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/3": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/4": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/5": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new/param/6": { "documentation": "" }, "@roblox/global/DockWidgetPluginGuiInfo.new": { "documentation": "Returns a new DockWidgetPluginGuiInfo object.", "params": [ { "name": "InitialDockState", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/0" }, { "name": "InitialEnabled", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/1" }, { "name": "InitialEnabledShouldOverrideRestore", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/2" }, { "name": "FloatingXSize", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/3" }, { "name": "FloatingYSize", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/4" }, { "name": "MinWidth", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/5" }, { "name": "MinHeight", "documentation": "@roblox/global/DockWidgetPluginGuiInfo.new/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#new", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo": { "documentation": "Describes details for a DockWidgetPluginGui.", "keys": { "InitialEnabled": "@roblox/globaltype/DockWidgetPluginGuiInfo.InitialEnabled", "InitialEnabledShouldOverrideRestore": "@roblox/globaltype/DockWidgetPluginGuiInfo.InitialEnabledShouldOverrideRestore", "FloatingXSize": "@roblox/globaltype/DockWidgetPluginGuiInfo.FloatingXSize", "FloatingYSize": "@roblox/globaltype/DockWidgetPluginGuiInfo.FloatingYSize", "MinWidth": "@roblox/globaltype/DockWidgetPluginGuiInfo.MinWidth", "MinHeight": "@roblox/globaltype/DockWidgetPluginGuiInfo.MinHeight" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo.InitialEnabled": { "documentation": "The enabled state of the PluginGui if it does not have a saved state from a previous session.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#InitialEnabled", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo.InitialEnabledShouldOverrideRestore": { "documentation": "If true, will override any saved enabled state with the InitialEnabled value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#InitialEnabledShouldOverrideRestore", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo.FloatingXSize": { "documentation": "The initial pixel width of the PluginGui when floating.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#FloatingXSize", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo.FloatingYSize": { "documentation": "The initial pixel height of the PluginGui when floating.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#FloatingYSize", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo.MinWidth": { "documentation": "The minimum pixel width of the PluginGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#MinWidth", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGuiInfo.MinHeight": { "documentation": "The minimum pixel height of the PluginGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/DockWidgetPluginGuiInfo#MinHeight", "code_sample": "" }, "@roblox/global/SharedTable": { "documentation": "Provides sharable, table-like storage for key/value pairs.", "keys": { "new": "@roblox/global/SharedTable.new", "clear": "@roblox/global/SharedTable.clear", "clone": "@roblox/global/SharedTable.clone", "cloneAndFreeze": "@roblox/global/SharedTable.cloneAndFreeze", "increment": "@roblox/global/SharedTable.increment", "isFrozen": "@roblox/global/SharedTable.isFrozen", "size": "@roblox/global/SharedTable.size", "update": "@roblox/global/SharedTable.update" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable", "code_sample": "local st = SharedTable.new()\nst[1] = \"a\"\nst[\"x\"] = true\nst.y = 5\n\nassert(st[1] == \"a\")\nassert(st[\"x\"] == true)\nassert(st.x == true)\nassert(st[\"y\"] == 5)\nassert(st.y == 5)\n\n-- true is not a valid SharedTable key, so attempting to set that key\n-- fails:\nassert(not pcall(function() st[true] = 100 end))\n-- A function is not a valid SharedTable value, so attempting to set a\n-- value to a function fails:\nassert(not pcall(function() st[\"f\"] = function() end end))" }, "@roblox/global/SharedTable.new": { "overloads": { "() -> SharedTable": "@roblox/global/SharedTable.new/overload/() -> SharedTable", "(table) -> SharedTable": "@roblox/global/SharedTable.new/overload/(table) -> SharedTable" } }, "@roblox/global/SharedTable.new/overload/() -> SharedTable": { "documentation": "Returns a new, empty SharedTable.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#new", "code_sample": "" }, "@roblox/global/SharedTable.new/overload/(table) -> SharedTable/param/0": { "documentation": "The Luau table whose elements are to be stored in the new SharedTable." }, "@roblox/global/SharedTable.new/overload/(table) -> SharedTable": { "documentation": "Returns a new SharedTable containing elements equivalent to those in the provided Luau table.", "params": [ { "name": "t", "documentation": "@roblox/global/SharedTable.new/overload/(table) -> SharedTable/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#new", "code_sample": "" }, "@roblox/global/SharedTable.clear/param/0": { "documentation": "The SharedTable to clear." }, "@roblox/global/SharedTable.clear": { "documentation": "Removes all of the elements from the SharedTable.", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#clear", "code_sample": "" }, "@roblox/global/SharedTable.clone/param/0": { "documentation": "The SharedTable object to clone." }, "@roblox/global/SharedTable.clone/param/1": { "documentation": "Whether to create a deep clone (true) or a shallow clone (false)." }, "@roblox/global/SharedTable.clone/return/0": { "documentation": "" }, "@roblox/global/SharedTable.clone": { "documentation": "Creates and returns a clone of the provided SharedTable.", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.clone/param/0" }, { "name": "deep", "documentation": "@roblox/global/SharedTable.clone/param/1" } ], "returns": [ "@roblox/global/SharedTable.clone/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#clone", "code_sample": "local original = SharedTable.new()\noriginal[\"a\"] = \"original a\"\noriginal[\"b\"] = \"original b\"\noriginal[\"c\"] = SharedTable.new()\noriginal[\"c\"][\"d\"] = \"original d\"\n\nlocal clone = SharedTable.clone(original, false)\nclone[\"a\"] = \"new a\"\nclone[\"b\"] = \"new b\"\nclone[\"c\"][\"d\"] = \"new d\"\nassert(original[\"a\"] == \"original a\")\nassert(original[\"b\"] == \"original b\")\n\n-- Because this was a shallow clone, original[\"c\"] and clone[\"c\"] are\n-- the same SharedTable object.\nassert(original[\"c\"] == clone[\"c\"])\nassert(original[\"c\"][\"d\"] == \"new d\")" }, "@roblox/global/SharedTable.cloneAndFreeze/param/0": { "documentation": "The SharedTable object to clone." }, "@roblox/global/SharedTable.cloneAndFreeze/param/1": { "documentation": "Whether to create a deep clone (true) or a shallow clone (false)." }, "@roblox/global/SharedTable.cloneAndFreeze/return/0": { "documentation": "" }, "@roblox/global/SharedTable.cloneAndFreeze": { "documentation": "Creates and returns a frozen (read-only) clone of the provided SharedTable.", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.cloneAndFreeze/param/0" }, { "name": "deep", "documentation": "@roblox/global/SharedTable.cloneAndFreeze/param/1" } ], "returns": [ "@roblox/global/SharedTable.cloneAndFreeze/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#cloneAndFreeze", "code_sample": "" }, "@roblox/global/SharedTable.increment/param/0": { "documentation": "The SharedTable object to be updated." }, "@roblox/global/SharedTable.increment/param/1": { "documentation": "The key of the element in the SharedTable object to be updated." }, "@roblox/global/SharedTable.increment/param/2": { "documentation": "The value to be added to the element in the SharedTable." }, "@roblox/global/SharedTable.increment/return/0": { "documentation": "The original value of the element, before delta was added to it." }, "@roblox/global/SharedTable.increment": { "documentation": "Adds delta to the value with the provided key and returns the original value.", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.increment/param/0" }, { "name": "key", "documentation": "@roblox/global/SharedTable.increment/param/1" }, { "name": "delta", "documentation": "@roblox/global/SharedTable.increment/param/2" } ], "returns": [ "@roblox/global/SharedTable.increment/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#increment", "code_sample": "local st = SharedTable.new()\nst[\"x\"] = 1\n\nlocal oldValue = SharedTable.increment(st, \"x\", 1)\nassert(oldValue == 1)\nassert(st[\"x\"] == 2)\n\n-- The value of the specified key must be a number. If it is not a\n-- number, the call will fail:\nst[\"y\"] = \"test\"\nassert(not pcall(function() SharedTable.increment(st, \"y\", 1) end))" }, "@roblox/global/SharedTable.isFrozen/param/0": { "documentation": "The SharedTable object whose frozen state is to be queried." }, "@roblox/global/SharedTable.isFrozen/return/0": { "documentation": "" }, "@roblox/global/SharedTable.isFrozen": { "documentation": "Returns true if the SharedTable is frozen (read-only).", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.isFrozen/param/0" } ], "returns": [ "@roblox/global/SharedTable.isFrozen/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#isFrozen", "code_sample": "" }, "@roblox/global/SharedTable.size/param/0": { "documentation": "The SharedTable object whose size is to be queried." }, "@roblox/global/SharedTable.size/return/0": { "documentation": "" }, "@roblox/global/SharedTable.size": { "documentation": "Returns the number of elements stored in the SharedTable.", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.size/param/0" } ], "returns": [ "@roblox/global/SharedTable.size/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#size", "code_sample": "" }, "@roblox/global/SharedTable.update/param/0": { "documentation": "The SharedTable object to be updated." }, "@roblox/global/SharedTable.update/param/1": { "documentation": "The key of the element in the SharedTable object to be updated." }, "@roblox/global/SharedTable.update/param/2": { "documentation": "The function that will be called to compute the new value for the element." }, "@roblox/global/SharedTable.update": { "documentation": "Updates the value with the provided key via the provided update function.", "params": [ { "name": "st", "documentation": "@roblox/global/SharedTable.update/param/0" }, { "name": "key", "documentation": "@roblox/global/SharedTable.update/param/1" }, { "name": "f", "documentation": "@roblox/global/SharedTable.update/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/SharedTable#update", "code_sample": "local st = SharedTable.new()\nst[\"x\"] = \"abcd\"\n\nSharedTable.update(st, \"x\", function(v)\n assert(v == \"abcd\")\n return v .. \"e\"\nend)\n\nassert(st[\"x\"] == \"abcde\")" }, "@roblox/globaltype/Enum": { "documentation": "A data type that represents an individual enum.", "keys": { "GetEnumItems": "@roblox/globaltype/Enum.GetEnumItems", "FromName": "@roblox/globaltype/Enum.FromName", "FromValue": "@roblox/globaltype/Enum.FromValue" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Enum", "code_sample": "" }, "@roblox/globaltype/Enum.GetEnumItems/param/0": { "documentation": "A data type that represents an individual enum." }, "@roblox/globaltype/Enum.GetEnumItems/return/0": { "documentation": "" }, "@roblox/globaltype/Enum.GetEnumItems": { "documentation": "Returns an array of all EnumItem options available for this enum.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Enum.GetEnumItems/param/0" } ], "returns": [ "@roblox/globaltype/Enum.GetEnumItems/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Enum#GetEnumItems", "code_sample": "" }, "@roblox/globaltype/Enum.FromName/param/0": { "documentation": "A data type that represents an individual enum." }, "@roblox/globaltype/Enum.FromName/return/0": { "documentation": "" }, "@roblox/globaltype/Enum.FromName": { "documentation": "Converts an enum name to an Enum.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Enum.FromName/param/0" } ], "returns": [ "@roblox/globaltype/Enum.FromName/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Enum#FromName", "code_sample": "" }, "@roblox/globaltype/Enum.FromValue/param/0": { "documentation": "A data type that represents an individual enum." }, "@roblox/globaltype/Enum.FromValue/return/0": { "documentation": "" }, "@roblox/globaltype/Enum.FromValue": { "documentation": "Converts an enum value to an Enum.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Enum.FromValue/param/0" } ], "returns": [ "@roblox/globaltype/Enum.FromValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Enum#FromValue", "code_sample": "" }, "@roblox/global/Vector3": { "documentation": "Represents a 3D value with a direction and magnitude.", "keys": { "new": "@roblox/global/Vector3.new", "FromNormalId": "@roblox/global/Vector3.FromNormalId", "FromAxis": "@roblox/global/Vector3.FromAxis", "zero": "@roblox/global/Vector3.zero", "one": "@roblox/global/Vector3.one", "xAxis": "@roblox/global/Vector3.xAxis", "yAxis": "@roblox/global/Vector3.yAxis", "zAxis": "@roblox/global/Vector3.zAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3", "code_sample": "" }, "@roblox/global/Vector3.new/param/0": { "documentation": "" }, "@roblox/global/Vector3.new/param/1": { "documentation": "" }, "@roblox/global/Vector3.new/param/2": { "documentation": "" }, "@roblox/global/Vector3.new": { "documentation": "Returns a new Vector3 from the given x, y, and z components.", "params": [ { "name": "x", "documentation": "@roblox/global/Vector3.new/param/0" }, { "name": "y", "documentation": "@roblox/global/Vector3.new/param/1" }, { "name": "z", "documentation": "@roblox/global/Vector3.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#new", "code_sample": "" }, "@roblox/global/Vector3.FromNormalId/param/0": { "documentation": "" }, "@roblox/global/Vector3.FromNormalId": { "documentation": "Returns a new Vector3 in the given direction.", "params": [ { "name": "normal", "documentation": "@roblox/global/Vector3.FromNormalId/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#FromNormalId", "code_sample": "" }, "@roblox/global/Vector3.FromAxis/param/0": { "documentation": "" }, "@roblox/global/Vector3.FromAxis": { "documentation": "Returns a new Vector3 for the given axis.", "params": [ { "name": "axis", "documentation": "@roblox/global/Vector3.FromAxis/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#FromAxis", "code_sample": "" }, "@roblox/global/Vector3.zero": { "documentation": "A Vector3 with a magnitude of 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#zero", "code_sample": "" }, "@roblox/global/Vector3.one": { "documentation": "A Vector3 with a value of 1 on every axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#one", "code_sample": "" }, "@roblox/global/Vector3.xAxis": { "documentation": "A Vector3 with a value of 1 on the X axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#xAxis", "code_sample": "" }, "@roblox/global/Vector3.yAxis": { "documentation": "A Vector3 with a value of 1 on the Y axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#yAxis", "code_sample": "" }, "@roblox/global/Vector3.zAxis": { "documentation": "A Vector3 with a value of 1 on the Z axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#zAxis", "code_sample": "" }, "@roblox/globaltype/Vector3": { "documentation": "Represents a 3D value with a direction and magnitude.", "keys": { "zero": "@roblox/globaltype/Vector3.zero", "one": "@roblox/globaltype/Vector3.one", "xAxis": "@roblox/globaltype/Vector3.xAxis", "yAxis": "@roblox/globaltype/Vector3.yAxis", "zAxis": "@roblox/globaltype/Vector3.zAxis", "X": "@roblox/globaltype/Vector3.X", "Y": "@roblox/globaltype/Vector3.Y", "Z": "@roblox/globaltype/Vector3.Z", "Magnitude": "@roblox/globaltype/Vector3.Magnitude", "Unit": "@roblox/globaltype/Vector3.Unit", "Abs": "@roblox/globaltype/Vector3.Abs", "Ceil": "@roblox/globaltype/Vector3.Ceil", "Floor": "@roblox/globaltype/Vector3.Floor", "Sign": "@roblox/globaltype/Vector3.Sign", "Cross": "@roblox/globaltype/Vector3.Cross", "Angle": "@roblox/globaltype/Vector3.Angle", "Dot": "@roblox/globaltype/Vector3.Dot", "FuzzyEq": "@roblox/globaltype/Vector3.FuzzyEq", "Lerp": "@roblox/globaltype/Vector3.Lerp", "Max": "@roblox/globaltype/Vector3.Max", "Min": "@roblox/globaltype/Vector3.Min" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3", "code_sample": "" }, "@roblox/globaltype/Vector3.zero": { "documentation": "A Vector3 with a magnitude of 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#zero", "code_sample": "" }, "@roblox/globaltype/Vector3.one": { "documentation": "A Vector3 with a value of 1 on every axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#one", "code_sample": "" }, "@roblox/globaltype/Vector3.xAxis": { "documentation": "A Vector3 with a value of 1 on the X axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#xAxis", "code_sample": "" }, "@roblox/globaltype/Vector3.yAxis": { "documentation": "A Vector3 with a value of 1on the Y axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#yAxis", "code_sample": "" }, "@roblox/globaltype/Vector3.zAxis": { "documentation": "A Vector3 with a value of 1 on the Z axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#zAxis", "code_sample": "" }, "@roblox/globaltype/Vector3.X": { "documentation": "The X coordinate of the Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#X", "code_sample": "" }, "@roblox/globaltype/Vector3.Y": { "documentation": "The Y coordinate of the Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Y", "code_sample": "" }, "@roblox/globaltype/Vector3.Z": { "documentation": "The Z coordinate of the Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Z", "code_sample": "" }, "@roblox/globaltype/Vector3.Magnitude": { "documentation": "The length of the Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Magnitude", "code_sample": "" }, "@roblox/globaltype/Vector3.Unit": { "documentation": "A normalized copy of the Vector3 - one that has the same direction as the original but a magnitude of 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Unit", "code_sample": "" }, "@roblox/globaltype/Vector3.Abs/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Abs/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Abs": { "documentation": "Returns a new vector from the absolute values of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Abs/param/0" } ], "returns": [ "@roblox/globaltype/Vector3.Abs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Abs", "code_sample": "" }, "@roblox/globaltype/Vector3.Ceil/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Ceil/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Ceil": { "documentation": "Returns a new vector from the ceiling of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Ceil/param/0" } ], "returns": [ "@roblox/globaltype/Vector3.Ceil/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Ceil", "code_sample": "" }, "@roblox/globaltype/Vector3.Floor/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Floor/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Floor": { "documentation": "Returns a new vector from the floor of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Floor/param/0" } ], "returns": [ "@roblox/globaltype/Vector3.Floor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Floor", "code_sample": "" }, "@roblox/globaltype/Vector3.Sign/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Sign/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Sign": { "documentation": "Returns a new vector from the sign (-1, 0, or 1) of the original's components.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Sign/param/0" } ], "returns": [ "@roblox/globaltype/Vector3.Sign/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Sign", "code_sample": "" }, "@roblox/globaltype/Vector3.Cross/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Cross/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.Cross/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Cross": { "documentation": "Returns the cross product of the two vectors.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Cross/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector3.Cross/param/1" } ], "returns": [ "@roblox/globaltype/Vector3.Cross/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Cross", "code_sample": "" }, "@roblox/globaltype/Vector3.Angle/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Angle/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.Angle/param/2": { "documentation": "" }, "@roblox/globaltype/Vector3.Angle/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Angle": { "documentation": "Returns the angle in radians between the two vectors. If you provide an axis, it determines the sign of the angle.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Angle/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector3.Angle/param/1" }, { "name": "axis", "documentation": "@roblox/globaltype/Vector3.Angle/param/2" } ], "returns": [ "@roblox/globaltype/Vector3.Angle/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Angle", "code_sample": "" }, "@roblox/globaltype/Vector3.Dot/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Dot/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.Dot/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Dot": { "documentation": "Returns a scalar dot product of the two vectors.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Dot/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector3.Dot/param/1" } ], "returns": [ "@roblox/globaltype/Vector3.Dot/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Dot", "code_sample": "" }, "@roblox/globaltype/Vector3.FuzzyEq/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.FuzzyEq/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.FuzzyEq/param/2": { "documentation": "" }, "@roblox/globaltype/Vector3.FuzzyEq/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.FuzzyEq": { "documentation": "Returns true if the difference between the squared magnitude of the two vectors is within epsilon. epsilon is scaled relative to the magnitude, rather than an absolute epsilon.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.FuzzyEq/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/Vector3.FuzzyEq/param/1" }, { "name": "epsilon", "documentation": "@roblox/globaltype/Vector3.FuzzyEq/param/2" } ], "returns": [ "@roblox/globaltype/Vector3.FuzzyEq/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#FuzzyEq", "code_sample": "" }, "@roblox/globaltype/Vector3.Lerp/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Lerp/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.Lerp/param/2": { "documentation": "" }, "@roblox/globaltype/Vector3.Lerp/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Lerp": { "documentation": "Returns a Vector3 linearly interpolated between this Vector3 and the given goal by the given alpha.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Lerp/param/0" }, { "name": "goal", "documentation": "@roblox/globaltype/Vector3.Lerp/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/Vector3.Lerp/param/2" } ], "returns": [ "@roblox/globaltype/Vector3.Lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Lerp", "code_sample": "" }, "@roblox/globaltype/Vector3.Max/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Max/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.Max/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Max": { "documentation": "Returns a Vector3 with each component as the highest among the respective components of both provided Vector3 objects.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Max/param/0" }, { "name": "vector", "documentation": "@roblox/globaltype/Vector3.Max/param/1" } ], "returns": [ "@roblox/globaltype/Vector3.Max/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Max", "code_sample": "" }, "@roblox/globaltype/Vector3.Min/param/0": { "documentation": "Represents a 3D value with a direction and magnitude." }, "@roblox/globaltype/Vector3.Min/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3.Min/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3.Min": { "documentation": "Returns a Vector3 with each component as the lowest among the respective components of both provided Vector3 objects.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3.Min/param/0" }, { "name": "vector", "documentation": "@roblox/globaltype/Vector3.Min/param/1" } ], "returns": [ "@roblox/globaltype/Vector3.Min/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector3#Min", "code_sample": "" }, "@roblox/global/Axes": { "documentation": "The Axes data type is for the ArcHandles class to control which rotation axes are currently enabled.", "keys": { "new": "@roblox/global/Axes.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes", "code_sample": "" }, "@roblox/global/Axes.new/param/0": { "documentation": "" }, "@roblox/global/Axes.new": { "documentation": "Creates a new Axes using list of axes and/or faces. NormalIds (faces) are converted to the corresponding axes.", "params": [ { "name": "axes", "documentation": "@roblox/global/Axes.new/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#new", "code_sample": "" }, "@roblox/globaltype/Axes": { "documentation": "The Axes data type is for the ArcHandles class to control which rotation axes are currently enabled.", "keys": { "X": "@roblox/globaltype/Axes.X", "Y": "@roblox/globaltype/Axes.Y", "Z": "@roblox/globaltype/Axes.Z", "Top": "@roblox/globaltype/Axes.Top", "Bottom": "@roblox/globaltype/Axes.Bottom", "Left": "@roblox/globaltype/Axes.Left", "Right": "@roblox/globaltype/Axes.Right", "Back": "@roblox/globaltype/Axes.Back", "Front": "@roblox/globaltype/Axes.Front" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes", "code_sample": "" }, "@roblox/globaltype/Axes.X": { "documentation": "Whether the X axis is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#X", "code_sample": "" }, "@roblox/globaltype/Axes.Y": { "documentation": "Whether the Y axis is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Y", "code_sample": "" }, "@roblox/globaltype/Axes.Z": { "documentation": "Whether the Z axis is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Z", "code_sample": "" }, "@roblox/globaltype/Axes.Top": { "documentation": "Whether the top face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Top", "code_sample": "" }, "@roblox/globaltype/Axes.Bottom": { "documentation": "Whether the bottom face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Bottom", "code_sample": "" }, "@roblox/globaltype/Axes.Left": { "documentation": "Whether the left face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Left", "code_sample": "" }, "@roblox/globaltype/Axes.Right": { "documentation": "Whether the right face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Right", "code_sample": "" }, "@roblox/globaltype/Axes.Back": { "documentation": "Whether the back face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Back", "code_sample": "" }, "@roblox/globaltype/Axes.Front": { "documentation": "Whether the front face is included.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Axes#Front", "code_sample": "" }, "@roblox/global/Vector2int16": { "documentation": "Represents a Vector2 with signed 16-bit integers for components.", "keys": { "new": "@roblox/global/Vector2int16.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2int16", "code_sample": "" }, "@roblox/global/Vector2int16.new/param/0": { "documentation": "" }, "@roblox/global/Vector2int16.new/param/1": { "documentation": "" }, "@roblox/global/Vector2int16.new": { "documentation": "Returns a Vector2int16 from the given x and y components.", "params": [ { "name": "x", "documentation": "@roblox/global/Vector2int16.new/param/0" }, { "name": "y", "documentation": "@roblox/global/Vector2int16.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2int16#new", "code_sample": "" }, "@roblox/globaltype/Vector2int16": { "documentation": "Represents a Vector2 with signed 16-bit integers for components.", "keys": { "X": "@roblox/globaltype/Vector2int16.X", "Y": "@roblox/globaltype/Vector2int16.Y" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2int16", "code_sample": "" }, "@roblox/globaltype/Vector2int16.X": { "documentation": "The x-coordinate of the Vector2int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2int16#X", "code_sample": "" }, "@roblox/globaltype/Vector2int16.Y": { "documentation": "The y-coordinate of the Vector2int16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Vector2int16#Y", "code_sample": "" }, "@roblox/global/Instance": { "documentation": "Holds the constructor for Instances.", "keys": { "new": "@roblox/global/Instance.new", "fromExisting": "@roblox/global/Instance.fromExisting" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Instance", "code_sample": "" }, "@roblox/global/Instance.new/param/0": { "documentation": "Class name of the new instance to create." }, "@roblox/global/Instance.new/param/1": { "documentation": "Optional object to parent the new instance to. Not recommended for performance reasons (see description above)." }, "@roblox/global/Instance.new": { "documentation": "Returns an Instance of the specified class.", "params": [ { "name": "className", "documentation": "@roblox/global/Instance.new/param/0" }, { "name": "parent", "documentation": "@roblox/global/Instance.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Instance#new", "code_sample": "" }, "@roblox/global/Instance.fromExisting/param/0": { "documentation": "The existing Instance to copy property values from." }, "@roblox/global/Instance.fromExisting": { "documentation": "Returns an Instance which is a copy of an existing Instance.", "params": [ { "name": "existingInstance", "documentation": "@roblox/global/Instance.fromExisting/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Instance#fromExisting", "code_sample": "" }, "@roblox/global/ColorSequenceKeypoint": { "documentation": "A color and time value that represents a keypoint in a ColorSequence.", "keys": { "new": "@roblox/global/ColorSequenceKeypoint.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequenceKeypoint", "code_sample": "" }, "@roblox/global/ColorSequenceKeypoint.new/param/0": { "documentation": "" }, "@roblox/global/ColorSequenceKeypoint.new/param/1": { "documentation": "" }, "@roblox/global/ColorSequenceKeypoint.new": { "documentation": "Returns a ColorSequenceKeypoint from the given time and color.", "params": [ { "name": "time", "documentation": "@roblox/global/ColorSequenceKeypoint.new/param/0" }, { "name": "color", "documentation": "@roblox/global/ColorSequenceKeypoint.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequenceKeypoint#new", "code_sample": "" }, "@roblox/globaltype/ColorSequenceKeypoint": { "documentation": "A color and time value that represents a keypoint in a ColorSequence.", "keys": { "Time": "@roblox/globaltype/ColorSequenceKeypoint.Time", "Value": "@roblox/globaltype/ColorSequenceKeypoint.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequenceKeypoint", "code_sample": "" }, "@roblox/globaltype/ColorSequenceKeypoint.Time": { "documentation": "The relative time at which the keypoint is located.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequenceKeypoint#Time", "code_sample": "" }, "@roblox/globaltype/ColorSequenceKeypoint.Value": { "documentation": "The Color3 value of the keypoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ColorSequenceKeypoint#Value", "code_sample": "" }, "@roblox/global/BrickColor": { "documentation": "A data type that provides a predefined list of named colors.", "keys": { "new": "@roblox/global/BrickColor.new", "palette": "@roblox/global/BrickColor.palette", "random": "@roblox/global/BrickColor.random", "White": "@roblox/global/BrickColor.White", "Gray": "@roblox/global/BrickColor.Gray", "DarkGray": "@roblox/global/BrickColor.DarkGray", "Black": "@roblox/global/BrickColor.Black", "Red": "@roblox/global/BrickColor.Red", "Yellow": "@roblox/global/BrickColor.Yellow", "Green": "@roblox/global/BrickColor.Green", "Blue": "@roblox/global/BrickColor.Blue" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor", "code_sample": "" }, "@roblox/global/BrickColor.new": { "overloads": { "(number) -> BrickColor": "@roblox/global/BrickColor.new/overload/(number) -> BrickColor", "(number, number, number) -> BrickColor": "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor", "(string) -> BrickColor": "@roblox/global/BrickColor.new/overload/(string) -> BrickColor", "(Color3) -> BrickColor": "@roblox/global/BrickColor.new/overload/(Color3) -> BrickColor" } }, "@roblox/global/BrickColor.new/overload/(number) -> BrickColor/param/0": { "documentation": "" }, "@roblox/global/BrickColor.new/overload/(number) -> BrickColor": { "documentation": "Constructs a BrickColor from its numerical index.", "params": [ { "name": "val", "documentation": "@roblox/global/BrickColor.new/overload/(number) -> BrickColor/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#new", "code_sample": "" }, "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor/param/0": { "documentation": "" }, "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor/param/1": { "documentation": "" }, "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor/param/2": { "documentation": "" }, "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor": { "documentation": "Constructs the closest BrickColor that can be matched to the specified RGB components, each between 0 and 1.", "params": [ { "name": "r", "documentation": "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor/param/0" }, { "name": "g", "documentation": "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor/param/1" }, { "name": "b", "documentation": "@roblox/global/BrickColor.new/overload/(number, number, number) -> BrickColor/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#new", "code_sample": "" }, "@roblox/global/BrickColor.new/overload/(string) -> BrickColor/param/0": { "documentation": "" }, "@roblox/global/BrickColor.new/overload/(string) -> BrickColor": { "documentation": "Constructs a BrickColor from its name.", "params": [ { "name": "name", "documentation": "@roblox/global/BrickColor.new/overload/(string) -> BrickColor/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#new", "code_sample": "" }, "@roblox/global/BrickColor.new/overload/(Color3) -> BrickColor/param/0": { "documentation": "" }, "@roblox/global/BrickColor.new/overload/(Color3) -> BrickColor": { "documentation": "Constructs the closest BrickColor that can be matched to the specified Color3.", "params": [ { "name": "color", "documentation": "@roblox/global/BrickColor.new/overload/(Color3) -> BrickColor/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#new", "code_sample": "" }, "@roblox/global/BrickColor.palette/param/0": { "documentation": "" }, "@roblox/global/BrickColor.palette": { "documentation": "Constructs a BrickColor from its palette index.", "params": [ { "name": "paletteValue", "documentation": "@roblox/global/BrickColor.palette/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#palette", "code_sample": "" }, "@roblox/global/BrickColor.random": { "documentation": "Returns a random BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#random", "code_sample": "" }, "@roblox/global/BrickColor.White": { "documentation": "Returns the \"White\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#White", "code_sample": "" }, "@roblox/global/BrickColor.Gray": { "documentation": "Returns the \"Medium stone grey\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Gray", "code_sample": "" }, "@roblox/global/BrickColor.DarkGray": { "documentation": "Returns the \"Dark stone grey\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#DarkGray", "code_sample": "" }, "@roblox/global/BrickColor.Black": { "documentation": "Returns the \"Black\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Black", "code_sample": "" }, "@roblox/global/BrickColor.Red": { "documentation": "Returns the \"Bright red\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Red", "code_sample": "" }, "@roblox/global/BrickColor.Yellow": { "documentation": "Returns the \"Bright yellow\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Yellow", "code_sample": "" }, "@roblox/global/BrickColor.Green": { "documentation": "Returns the \"Dark green\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Green", "code_sample": "" }, "@roblox/global/BrickColor.Blue": { "documentation": "Returns the \"Bright blue\" BrickColor.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Blue", "code_sample": "" }, "@roblox/globaltype/BrickColor": { "documentation": "A data type that provides a predefined list of named colors.", "keys": { "Number": "@roblox/globaltype/BrickColor.Number", "r": "@roblox/globaltype/BrickColor.r", "g": "@roblox/globaltype/BrickColor.g", "b": "@roblox/globaltype/BrickColor.b", "Name": "@roblox/globaltype/BrickColor.Name", "Color": "@roblox/globaltype/BrickColor.Color" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor", "code_sample": "" }, "@roblox/globaltype/BrickColor.Number": { "documentation": "The unique number that identifies the BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Number", "code_sample": "" }, "@roblox/globaltype/BrickColor.r": { "documentation": "The red component of the BrickColor (between 0 and 1).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#r", "code_sample": "" }, "@roblox/globaltype/BrickColor.g": { "documentation": "The green component of the BrickColor (between 0 and 1).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#g", "code_sample": "" }, "@roblox/globaltype/BrickColor.b": { "documentation": "The blue component of the BrickColor (between 0 and 1).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#b", "code_sample": "" }, "@roblox/globaltype/BrickColor.Name": { "documentation": "The name associated with the BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Name", "code_sample": "" }, "@roblox/globaltype/BrickColor.Color": { "documentation": "The Color3 associated with the BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/BrickColor#Color", "code_sample": "" }, "@roblox/global/PathWaypoint": { "documentation": "A description of the steps required to reach the next waypoint in a path.", "keys": { "new": "@roblox/global/PathWaypoint.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint", "code_sample": "" }, "@roblox/global/PathWaypoint.new/param/0": { "documentation": "The 3D position of the waypoint." }, "@roblox/global/PathWaypoint.new/param/1": { "documentation": "The action to perform at the waypoint." }, "@roblox/global/PathWaypoint.new/param/2": { "documentation": "The name of the navigation area that generates the waypoint." }, "@roblox/global/PathWaypoint.new": { "documentation": "Returns a PathWaypoint object from the given Vector3 position, PathWaypointAction action, and optional string label.", "params": [ { "name": "position", "documentation": "@roblox/global/PathWaypoint.new/param/0" }, { "name": "action", "documentation": "@roblox/global/PathWaypoint.new/param/1" }, { "name": "label", "documentation": "@roblox/global/PathWaypoint.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint#new", "code_sample": "" }, "@roblox/globaltype/PathWaypoint": { "documentation": "A description of the steps required to reach the next waypoint in a path.", "keys": { "Action": "@roblox/globaltype/PathWaypoint.Action", "Position": "@roblox/globaltype/PathWaypoint.Position", "Label": "@roblox/globaltype/PathWaypoint.Label" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint", "code_sample": "" }, "@roblox/globaltype/PathWaypoint.Action": { "documentation": "The action to perform at this waypoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint#Action", "code_sample": "" }, "@roblox/globaltype/PathWaypoint.Position": { "documentation": "The 3D position of this waypoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint#Position", "code_sample": "" }, "@roblox/globaltype/PathWaypoint.Label": { "documentation": "The name of the navigation area that generates this waypoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PathWaypoint#Label", "code_sample": "" }, "@roblox/globaltype/RBXScriptSignal": { "documentation": "An object that runs connected functions upon a specific occurrence.", "keys": { "Connect": "@roblox/globaltype/RBXScriptSignal.Connect", "ConnectParallel": "@roblox/globaltype/RBXScriptSignal.ConnectParallel", "Once": "@roblox/globaltype/RBXScriptSignal.Once", "Wait": "@roblox/globaltype/RBXScriptSignal.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal", "code_sample": "" }, "@roblox/globaltype/RBXScriptSignal.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RBXScriptSignal.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.Connect/return/0": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RBXScriptSignal.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RBXScriptSignal.Connect/param/1" } ], "returns": [ "@roblox/globaltype/RBXScriptSignal.Connect/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "code_sample": "" }, "@roblox/globaltype/RBXScriptSignal.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RBXScriptSignal.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.ConnectParallel/return/0": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RBXScriptSignal.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RBXScriptSignal.ConnectParallel/param/1" } ], "returns": [ "@roblox/globaltype/RBXScriptSignal.ConnectParallel/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "code_sample": "" }, "@roblox/globaltype/RBXScriptSignal.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RBXScriptSignal.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.Once/return/0": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RBXScriptSignal.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RBXScriptSignal.Once/param/1" } ], "returns": [ "@roblox/globaltype/RBXScriptSignal.Once/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "code_sample": "" }, "@roblox/globaltype/RBXScriptSignal.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RBXScriptSignal.Wait/return/0": { "documentation": "" }, "@roblox/globaltype/RBXScriptSignal.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RBXScriptSignal.Wait/param/0" } ], "returns": [ "@roblox/globaltype/RBXScriptSignal.Wait/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "code_sample": "" }, "@roblox/globaltype/EnumItem": { "documentation": "An individual item in an enum.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/EnumItem", "code_sample": "" }, "@roblox/globaltype/EnumItem.Name": { "documentation": "The name of the EnumItem.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/EnumItem#Name", "code_sample": "" }, "@roblox/globaltype/EnumItem.Value": { "documentation": "The integral value assigned to the EnumItem.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/EnumItem#Value", "code_sample": "" }, "@roblox/globaltype/EnumItem.EnumType": { "documentation": "A reference to the parent Enum of the EnumItem.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/EnumItem#EnumType", "code_sample": "" }, "@roblox/global/ValueCurveKey": { "documentation": "A time-value pair used with ValueCurve instances.", "keys": { "new": "@roblox/global/ValueCurveKey.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey", "code_sample": "" }, "@roblox/global/ValueCurveKey.new/param/0": { "documentation": "Time at which to create the new ValueCurveKey." }, "@roblox/global/ValueCurveKey.new/param/1": { "documentation": "Value of the new ValueCurveKey." }, "@roblox/global/ValueCurveKey.new/param/2": { "documentation": "" }, "@roblox/global/ValueCurveKey.new": { "documentation": "Returns a new ValueCurveKey from the given time and value.", "params": [ { "name": "time", "documentation": "@roblox/global/ValueCurveKey.new/param/0" }, { "name": "value", "documentation": "@roblox/global/ValueCurveKey.new/param/1" }, { "name": "Interpolation", "documentation": "@roblox/global/ValueCurveKey.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey#new", "code_sample": "" }, "@roblox/globaltype/ValueCurveKey": { "documentation": "A time-value pair used with ValueCurve instances.", "keys": { "Interpolation": "@roblox/globaltype/ValueCurveKey.Interpolation", "Time": "@roblox/globaltype/ValueCurveKey.Time", "Value": "@roblox/globaltype/ValueCurveKey.Value", "RightTangent": "@roblox/globaltype/ValueCurveKey.RightTangent", "LeftTangent": "@roblox/globaltype/ValueCurveKey.LeftTangent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey", "code_sample": "" }, "@roblox/globaltype/ValueCurveKey.Interpolation": { "documentation": "The key interpolation mode for the segment started by this ValueCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey#Interpolation", "code_sample": "" }, "@roblox/globaltype/ValueCurveKey.Time": { "documentation": "The time position of this ValueCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey#Time", "code_sample": "" }, "@roblox/globaltype/ValueCurveKey.Value": { "documentation": "The value of this ValueCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey#Value", "code_sample": "" }, "@roblox/globaltype/ValueCurveKey.RightTangent": { "documentation": "The tangent to the right of this ValueCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey#RightTangent", "code_sample": "" }, "@roblox/globaltype/ValueCurveKey.LeftTangent": { "documentation": "The tangent to the left of this ValueCurveKey.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/ValueCurveKey#LeftTangent", "code_sample": "" }, "@roblox/global/Font": { "documentation": "Describes the font used to render text.", "keys": { "new": "@roblox/global/Font.new", "fromEnum": "@roblox/global/Font.fromEnum", "fromName": "@roblox/global/Font.fromName", "fromId": "@roblox/global/Font.fromId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font", "code_sample": "" }, "@roblox/global/Font.new/param/0": { "documentation": "The asset ID for the font family, starting with rbxasset:// or rbxassetid://." }, "@roblox/global/Font.new/param/1": { "documentation": "How thick the text is." }, "@roblox/global/Font.new/param/2": { "documentation": "Whether the text is normal or italic." }, "@roblox/global/Font.new": { "documentation": "Creates a new Font.", "params": [ { "name": "family", "documentation": "@roblox/global/Font.new/param/0" }, { "name": "weight", "documentation": "@roblox/global/Font.new/param/1" }, { "name": "style", "documentation": "@roblox/global/Font.new/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#new", "code_sample": "" }, "@roblox/global/Font.fromEnum/param/0": { "documentation": "The enum value of the font to use." }, "@roblox/global/Font.fromEnum": { "documentation": "Creates a Font from an Font value.", "params": [ { "name": "font", "documentation": "@roblox/global/Font.fromEnum/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#fromEnum", "code_sample": "" }, "@roblox/global/Font.fromName/param/0": { "documentation": "The name of the font." }, "@roblox/global/Font.fromName/param/1": { "documentation": "How thick the text is." }, "@roblox/global/Font.fromName/param/2": { "documentation": "Whether the text is normal or italic." }, "@roblox/global/Font.fromName": { "documentation": "Creates a Font from a name like FredokaOne.", "params": [ { "name": "name", "documentation": "@roblox/global/Font.fromName/param/0" }, { "name": "weight", "documentation": "@roblox/global/Font.fromName/param/1" }, { "name": "style", "documentation": "@roblox/global/Font.fromName/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#fromName", "code_sample": "" }, "@roblox/global/Font.fromId/param/0": { "documentation": "The asset ID of the font as a number." }, "@roblox/global/Font.fromId/param/1": { "documentation": "How thick the text is." }, "@roblox/global/Font.fromId/param/2": { "documentation": "Whether the text is normal or italic." }, "@roblox/global/Font.fromId": { "documentation": "Creates a Font from a numerical asset ID.", "params": [ { "name": "id", "documentation": "@roblox/global/Font.fromId/param/0" }, { "name": "weight", "documentation": "@roblox/global/Font.fromId/param/1" }, { "name": "style", "documentation": "@roblox/global/Font.fromId/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#fromId", "code_sample": "" }, "@roblox/globaltype/Font": { "documentation": "Describes the font used to render text.", "keys": { "Family": "@roblox/globaltype/Font.Family", "Weight": "@roblox/globaltype/Font.Weight", "Style": "@roblox/globaltype/Font.Style", "Bold": "@roblox/globaltype/Font.Bold" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font", "code_sample": "" }, "@roblox/globaltype/Font.Family": { "documentation": "The asset ID for the font family.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#Family", "code_sample": "" }, "@roblox/globaltype/Font.Weight": { "documentation": "How thick the text is.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#Weight", "code_sample": "" }, "@roblox/globaltype/Font.Style": { "documentation": "Whether the font is italic.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#Style", "code_sample": "" }, "@roblox/globaltype/Font.Bold": { "documentation": "Whether the font is bold.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Font#Bold", "code_sample": "" }, "@roblox/global/UDim": { "documentation": "Represents a one-dimensional value with two components, a relative scale and an absolute offset.", "keys": { "new": "@roblox/global/UDim.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim", "code_sample": "" }, "@roblox/global/UDim.new/param/0": { "documentation": "" }, "@roblox/global/UDim.new/param/1": { "documentation": "" }, "@roblox/global/UDim.new": { "documentation": "Returns a UDim from the given components.", "params": [ { "name": "Scale", "documentation": "@roblox/global/UDim.new/param/0" }, { "name": "Offset", "documentation": "@roblox/global/UDim.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim#new", "code_sample": "" }, "@roblox/globaltype/UDim": { "documentation": "Represents a one-dimensional value with two components, a relative scale and an absolute offset.", "keys": { "Scale": "@roblox/globaltype/UDim.Scale", "Offset": "@roblox/globaltype/UDim.Offset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim", "code_sample": "" }, "@roblox/globaltype/UDim.Scale": { "documentation": "The relative scale component of the UDim.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim#Scale", "code_sample": "" }, "@roblox/globaltype/UDim.Offset": { "documentation": "The absolute offset component of the UDim.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim#Offset", "code_sample": "" }, "@roblox/global/TweenInfo": { "documentation": "Stores parameters for Tweens.", "keys": { "new": "@roblox/global/TweenInfo.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo", "code_sample": "" }, "@roblox/global/TweenInfo.new/param/0": { "documentation": "Duration for the tween, in seconds." }, "@roblox/global/TweenInfo.new/param/1": { "documentation": "Easing style for the tween." }, "@roblox/global/TweenInfo.new/param/2": { "documentation": "The direction in which the tween executes." }, "@roblox/global/TweenInfo.new/param/3": { "documentation": "Number of times the tween should repeat. -1 repeats indefinitely." }, "@roblox/global/TweenInfo.new/param/4": { "documentation": "Whether the tween should reverse to the starting values once it reaches its targets." }, "@roblox/global/TweenInfo.new/param/5": { "documentation": "Time of delay until the tween begins, in seconds." }, "@roblox/global/TweenInfo.new": { "documentation": "Creates a new TweenInfo from the provided parameters.", "params": [ { "name": "time", "documentation": "@roblox/global/TweenInfo.new/param/0" }, { "name": "easingStyle", "documentation": "@roblox/global/TweenInfo.new/param/1" }, { "name": "easingDirection", "documentation": "@roblox/global/TweenInfo.new/param/2" }, { "name": "repeatCount", "documentation": "@roblox/global/TweenInfo.new/param/3" }, { "name": "reverses", "documentation": "@roblox/global/TweenInfo.new/param/4" }, { "name": "delayTime", "documentation": "@roblox/global/TweenInfo.new/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#new", "code_sample": "" }, "@roblox/globaltype/TweenInfo": { "documentation": "Stores parameters for Tweens.", "keys": { "EasingDirection": "@roblox/globaltype/TweenInfo.EasingDirection", "Time": "@roblox/globaltype/TweenInfo.Time", "DelayTime": "@roblox/globaltype/TweenInfo.DelayTime", "RepeatCount": "@roblox/globaltype/TweenInfo.RepeatCount", "EasingStyle": "@roblox/globaltype/TweenInfo.EasingStyle", "Reverses": "@roblox/globaltype/TweenInfo.Reverses" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo", "code_sample": "" }, "@roblox/globaltype/TweenInfo.EasingDirection": { "documentation": "The direction in which the tween executes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#EasingDirection", "code_sample": "" }, "@roblox/globaltype/TweenInfo.Time": { "documentation": "Duration of the tween, in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#Time", "code_sample": "" }, "@roblox/globaltype/TweenInfo.DelayTime": { "documentation": "Time of delay until the tween begins, in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#DelayTime", "code_sample": "" }, "@roblox/globaltype/TweenInfo.RepeatCount": { "documentation": "Number of times the tween repeats.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#RepeatCount", "code_sample": "" }, "@roblox/globaltype/TweenInfo.EasingStyle": { "documentation": "The style in which the tween executes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#EasingStyle", "code_sample": "" }, "@roblox/globaltype/TweenInfo.Reverses": { "documentation": "Whether or not the tween interpolates in reverse tween once the initial tween completes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/TweenInfo#Reverses", "code_sample": "" }, "@roblox/globaltype/RaycastResult": { "documentation": "Stores results from a raycast operation.", "keys": { "Distance": "@roblox/globaltype/RaycastResult.Distance", "Instance": "@roblox/globaltype/RaycastResult.Instance", "Material": "@roblox/globaltype/RaycastResult.Material", "Position": "@roblox/globaltype/RaycastResult.Position", "Normal": "@roblox/globaltype/RaycastResult.Normal" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult", "code_sample": "" }, "@roblox/globaltype/RaycastResult.Distance": { "documentation": "The distance between the ray origin and the intersection point.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult#Distance", "code_sample": "" }, "@roblox/globaltype/RaycastResult.Instance": { "documentation": "The BasePart or Terrain cell that the ray intersected.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult#Instance", "code_sample": "" }, "@roblox/globaltype/RaycastResult.Material": { "documentation": "The Material at the intersection point.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult#Material", "code_sample": "" }, "@roblox/globaltype/RaycastResult.Position": { "documentation": "The world space point at which the intersection occurred.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult#Position", "code_sample": "" }, "@roblox/globaltype/RaycastResult.Normal": { "documentation": "The normal vector of the intersected face.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastResult#Normal", "code_sample": "" }, "@roblox/global/Ray": { "documentation": "Represents a line with a starting point that casts infinitely in a specific direction.", "keys": { "new": "@roblox/global/Ray.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray", "code_sample": "" }, "@roblox/global/Ray.new/param/0": { "documentation": "" }, "@roblox/global/Ray.new/param/1": { "documentation": "" }, "@roblox/global/Ray.new": { "documentation": "Returns a Ray with the given Origin and Direction.", "params": [ { "name": "Origin", "documentation": "@roblox/global/Ray.new/param/0" }, { "name": "Direction", "documentation": "@roblox/global/Ray.new/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray#new", "code_sample": "" }, "@roblox/globaltype/Ray": { "documentation": "Represents a line with a starting point that casts infinitely in a specific direction.", "keys": { "Unit": "@roblox/globaltype/Ray.Unit", "Origin": "@roblox/globaltype/Ray.Origin", "Direction": "@roblox/globaltype/Ray.Direction", "ClosestPoint": "@roblox/globaltype/Ray.ClosestPoint", "Distance": "@roblox/globaltype/Ray.Distance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray", "code_sample": "" }, "@roblox/globaltype/Ray.Unit": { "documentation": "The Ray with a normalized direction (the direction has a magnitude of 1).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray#Unit", "code_sample": "" }, "@roblox/globaltype/Ray.Origin": { "documentation": "The position of the origin.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray#Origin", "code_sample": "" }, "@roblox/globaltype/Ray.Direction": { "documentation": "The direction vector of the Ray.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray#Direction", "code_sample": "" }, "@roblox/globaltype/Ray.ClosestPoint/param/0": { "documentation": "Represents a line with a starting point that casts infinitely in a specific direction." }, "@roblox/globaltype/Ray.ClosestPoint/param/1": { "documentation": "" }, "@roblox/globaltype/Ray.ClosestPoint/return/0": { "documentation": "" }, "@roblox/globaltype/Ray.ClosestPoint": { "documentation": "Returns a Vector3 projected onto the ray so that it is within the Ray line of sight.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Ray.ClosestPoint/param/0" }, { "name": "point", "documentation": "@roblox/globaltype/Ray.ClosestPoint/param/1" } ], "returns": [ "@roblox/globaltype/Ray.ClosestPoint/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray#ClosestPoint", "code_sample": "" }, "@roblox/globaltype/Ray.Distance/param/0": { "documentation": "Represents a line with a starting point that casts infinitely in a specific direction." }, "@roblox/globaltype/Ray.Distance/param/1": { "documentation": "" }, "@roblox/globaltype/Ray.Distance/return/0": { "documentation": "" }, "@roblox/globaltype/Ray.Distance": { "documentation": "Returns the distance between the given point and the closest point on the Ray.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Ray.Distance/param/0" }, { "name": "point", "documentation": "@roblox/globaltype/Ray.Distance/param/1" } ], "returns": [ "@roblox/globaltype/Ray.Distance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Ray#Distance", "code_sample": "" }, "@roblox/globaltype/Enums": { "documentation": "A root access point of all Enums.", "keys": { "GetEnums": "@roblox/globaltype/Enums.GetEnums" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Enums", "code_sample": "" }, "@roblox/globaltype/Enums.GetEnums/param/0": { "documentation": "A root access point of all Enums." }, "@roblox/globaltype/Enums.GetEnums/return/0": { "documentation": "" }, "@roblox/globaltype/Enums.GetEnums": { "documentation": "Returns an array of all Enums.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Enums.GetEnums/param/0" } ], "returns": [ "@roblox/globaltype/Enums.GetEnums/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Enums#GetEnums", "code_sample": "" }, "@roblox/global/PhysicalProperties": { "documentation": "Describes properties that affect the physical behavior of a BasePart.", "keys": { "new": "@roblox/global/PhysicalProperties.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties", "code_sample": "" }, "@roblox/global/PhysicalProperties.new": { "overloads": { "(Material) -> PhysicalProperties": "@roblox/global/PhysicalProperties.new/overload/(Material) -> PhysicalProperties", "(number, number, number) -> PhysicalProperties": "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties", "(number, number, number, number, number) -> PhysicalProperties": "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties" } }, "@roblox/global/PhysicalProperties.new/overload/(Material) -> PhysicalProperties/param/0": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(Material) -> PhysicalProperties": { "documentation": "Returns a PhysicalProperties with the default properties for the given material.", "params": [ { "name": "material", "documentation": "@roblox/global/PhysicalProperties.new/overload/(Material) -> PhysicalProperties/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#new", "code_sample": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties/param/0": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties/param/1": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties/param/2": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties": { "documentation": "Returns a PhysicalProperties with the specified density, friction, and elasticity.", "params": [ { "name": "density", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties/param/0" }, { "name": "friction", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties/param/1" }, { "name": "elasticity", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number) -> PhysicalProperties/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#new", "code_sample": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/0": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/1": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/2": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/3": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/4": { "documentation": "" }, "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties": { "documentation": "Creates a PhysicalProperties container with the specified density, friction, elasticity, weight of friction, and weight of elasticity.", "params": [ { "name": "density", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/0" }, { "name": "friction", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/1" }, { "name": "elasticity", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/2" }, { "name": "frictionWeight", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/3" }, { "name": "elasticityWeight", "documentation": "@roblox/global/PhysicalProperties.new/overload/(number, number, number, number, number) -> PhysicalProperties/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#new", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties": { "documentation": "Describes properties that affect the physical behavior of a BasePart.", "keys": { "AcousticAbsorption": "@roblox/globaltype/PhysicalProperties.AcousticAbsorption", "Density": "@roblox/globaltype/PhysicalProperties.Density", "Friction": "@roblox/globaltype/PhysicalProperties.Friction", "Elasticity": "@roblox/globaltype/PhysicalProperties.Elasticity", "FrictionWeight": "@roblox/globaltype/PhysicalProperties.FrictionWeight", "ElasticityWeight": "@roblox/globaltype/PhysicalProperties.ElasticityWeight" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties.AcousticAbsorption": { "documentation": "A value between 0 and 1 denoting how absorbent the material is to AudioEmitters.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#AcousticAbsorption", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties.Density": { "documentation": "The mass per unit volume of the part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#Density", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties.Friction": { "documentation": "The deceleration of the part when rubbing against another part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#Friction", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties.Elasticity": { "documentation": "The amount of energy retained when colliding with another part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#Elasticity", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties.FrictionWeight": { "documentation": "The importance of the part's Friction property when calculating the friction with the colliding part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#FrictionWeight", "code_sample": "" }, "@roblox/globaltype/PhysicalProperties.ElasticityWeight": { "documentation": "The importance of the part's Elasticity property when calculating the elasticity with the colliding part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/PhysicalProperties#ElasticityWeight", "code_sample": "" }, "@roblox/globaltype/RBXScriptConnection": { "documentation": "A connection between an RBXScriptSignal and a function.", "keys": { "Connected": "@roblox/globaltype/RBXScriptConnection.Connected", "Disconnect": "@roblox/globaltype/RBXScriptConnection.Disconnect" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection", "code_sample": "" }, "@roblox/globaltype/RBXScriptConnection.Connected": { "documentation": "The state of the RBXScriptConnection.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection#Connected", "code_sample": "" }, "@roblox/globaltype/RBXScriptConnection.Disconnect/param/0": { "documentation": "A connection between an RBXScriptSignal and a function." }, "@roblox/globaltype/RBXScriptConnection.Disconnect": { "documentation": "Disconnects the connection from the event.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RBXScriptConnection.Disconnect/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptConnection#Disconnect", "code_sample": "" }, "@roblox/global/CFrame": { "documentation": "A data type that represents both a 3D position and orientation.", "keys": { "new": "@roblox/global/CFrame.new", "lookAt": "@roblox/global/CFrame.lookAt", "lookAlong": "@roblox/global/CFrame.lookAlong", "fromRotationBetweenVectors": "@roblox/global/CFrame.fromRotationBetweenVectors", "fromEulerAngles": "@roblox/global/CFrame.fromEulerAngles", "fromEulerAnglesXYZ": "@roblox/global/CFrame.fromEulerAnglesXYZ", "fromEulerAnglesYXZ": "@roblox/global/CFrame.fromEulerAnglesYXZ", "Angles": "@roblox/global/CFrame.Angles", "fromOrientation": "@roblox/global/CFrame.fromOrientation", "fromAxisAngle": "@roblox/global/CFrame.fromAxisAngle", "fromMatrix": "@roblox/global/CFrame.fromMatrix", "identity": "@roblox/global/CFrame.identity" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame", "code_sample": "" }, "@roblox/global/CFrame.new": { "overloads": { "() -> CFrame": "@roblox/global/CFrame.new/overload/() -> CFrame", "(Vector3) -> CFrame": "@roblox/global/CFrame.new/overload/(Vector3) -> CFrame", "(Vector3, Vector3) -> CFrame": "@roblox/global/CFrame.new/overload/(Vector3, Vector3) -> CFrame", "(number, number, number) -> CFrame": "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame", "(number, number, number, number, number, number, number) -> CFrame": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame", "(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame" } }, "@roblox/global/CFrame.new/overload/() -> CFrame": { "documentation": "Returns a blank identity CFrame.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#new", "code_sample": "" }, "@roblox/global/CFrame.new/overload/(Vector3) -> CFrame/param/0": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(Vector3) -> CFrame": { "documentation": "Returns a CFrame with no rotation with the position of the provided Vector3.", "params": [ { "name": "pos", "documentation": "@roblox/global/CFrame.new/overload/(Vector3) -> CFrame/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#new", "code_sample": "" }, "@roblox/global/CFrame.new/overload/(Vector3, Vector3) -> CFrame/param/0": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(Vector3, Vector3) -> CFrame/param/1": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(Vector3, Vector3) -> CFrame": { "documentation": "Returns a CFrame with the position of the first Vector3 and an orientation pointed toward the second.", "params": [ { "name": "pos", "documentation": "@roblox/global/CFrame.new/overload/(Vector3, Vector3) -> CFrame/param/0" }, { "name": "lookAt", "documentation": "@roblox/global/CFrame.new/overload/(Vector3, Vector3) -> CFrame/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#new", "code_sample": "" }, "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame/param/0": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame/param/1": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame/param/2": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame": { "documentation": "Returns a CFrame with a position comprised of the provided x, y, and z components.", "params": [ { "name": "x", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame/param/0" }, { "name": "y", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame/param/1" }, { "name": "z", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number) -> CFrame/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#new", "code_sample": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/0": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/1": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/2": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/3": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/4": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/5": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/6": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame": { "documentation": "Returns a CFrame from position (x, y, z) and quaternion (qX, qY, qZ, qW).", "params": [ { "name": "x", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/0" }, { "name": "y", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/1" }, { "name": "z", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/2" }, { "name": "qX", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/3" }, { "name": "qY", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/4" }, { "name": "qZ", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/5" }, { "name": "qW", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number) -> CFrame/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#new", "code_sample": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/0": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/1": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/2": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/3": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/4": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/5": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/6": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/7": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/8": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/9": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/10": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/11": { "documentation": "" }, "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame": { "documentation": "Returns a CFrame from position (x, y, z) with an orientation specified by the rotation matrix.", "params": [ { "name": "x", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/0" }, { "name": "y", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/1" }, { "name": "z", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/2" }, { "name": "R00", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/3" }, { "name": "R01", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/4" }, { "name": "R02", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/5" }, { "name": "R10", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/6" }, { "name": "R11", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/7" }, { "name": "R12", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/8" }, { "name": "R20", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/9" }, { "name": "R21", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/10" }, { "name": "R22", "documentation": "@roblox/global/CFrame.new/overload/(number, number, number, number, number, number, number, number, number, number, number, number) -> CFrame/param/11" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#new", "code_sample": "" }, "@roblox/global/CFrame.lookAt/param/0": { "documentation": "" }, "@roblox/global/CFrame.lookAt/param/1": { "documentation": "" }, "@roblox/global/CFrame.lookAt/param/2": { "documentation": "" }, "@roblox/global/CFrame.lookAt": { "documentation": "Returns a CFrame with the position of the first Vector3 and an orientation pointed toward the second.", "params": [ { "name": "at", "documentation": "@roblox/global/CFrame.lookAt/param/0" }, { "name": "lookAt", "documentation": "@roblox/global/CFrame.lookAt/param/1" }, { "name": "up", "documentation": "@roblox/global/CFrame.lookAt/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#lookAt", "code_sample": "" }, "@roblox/global/CFrame.lookAlong/param/0": { "documentation": "" }, "@roblox/global/CFrame.lookAlong/param/1": { "documentation": "" }, "@roblox/global/CFrame.lookAlong/param/2": { "documentation": "" }, "@roblox/global/CFrame.lookAlong": { "documentation": "Returns a CFrame with the position of the first Vector3 and an orientation directed along the second.", "params": [ { "name": "at", "documentation": "@roblox/global/CFrame.lookAlong/param/0" }, { "name": "direction", "documentation": "@roblox/global/CFrame.lookAlong/param/1" }, { "name": "up", "documentation": "@roblox/global/CFrame.lookAlong/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#lookAlong", "code_sample": "" }, "@roblox/global/CFrame.fromRotationBetweenVectors/param/0": { "documentation": "Vector representing the \"from\" direction." }, "@roblox/global/CFrame.fromRotationBetweenVectors/param/1": { "documentation": "Vector representing the \"to\" direction." }, "@roblox/global/CFrame.fromRotationBetweenVectors": { "documentation": "Returns a CFrame representing the orientation needed to rotate from the first Vector3 to the second, with the position set to zero.", "params": [ { "name": "from", "documentation": "@roblox/global/CFrame.fromRotationBetweenVectors/param/0" }, { "name": "to", "documentation": "@roblox/global/CFrame.fromRotationBetweenVectors/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromRotationBetweenVectors", "code_sample": "" }, "@roblox/global/CFrame.fromEulerAngles/param/0": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAngles/param/1": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAngles/param/2": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAngles/param/3": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAngles": { "documentation": "Returns a rotated CFrame from angles rx, ry, and rz in radians. Rotations are applied in the optional RotationOrder with a default of XYZ.", "params": [ { "name": "rx", "documentation": "@roblox/global/CFrame.fromEulerAngles/param/0" }, { "name": "ry", "documentation": "@roblox/global/CFrame.fromEulerAngles/param/1" }, { "name": "rz", "documentation": "@roblox/global/CFrame.fromEulerAngles/param/2" }, { "name": "order", "documentation": "@roblox/global/CFrame.fromEulerAngles/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromEulerAngles", "code_sample": "" }, "@roblox/global/CFrame.fromEulerAnglesXYZ/param/0": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAnglesXYZ/param/1": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAnglesXYZ/param/2": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAnglesXYZ": { "documentation": "Returns a rotated CFrame from angles rx, ry, and rz in radians using RotationOrder.XYZ.", "params": [ { "name": "rx", "documentation": "@roblox/global/CFrame.fromEulerAnglesXYZ/param/0" }, { "name": "ry", "documentation": "@roblox/global/CFrame.fromEulerAnglesXYZ/param/1" }, { "name": "rz", "documentation": "@roblox/global/CFrame.fromEulerAnglesXYZ/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromEulerAnglesXYZ", "code_sample": "" }, "@roblox/global/CFrame.fromEulerAnglesYXZ/param/0": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAnglesYXZ/param/1": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAnglesYXZ/param/2": { "documentation": "" }, "@roblox/global/CFrame.fromEulerAnglesYXZ": { "documentation": "Returns a rotated CFrame from angles rx, ry, and rz in radians using RotationOrder.YXZ.", "params": [ { "name": "rx", "documentation": "@roblox/global/CFrame.fromEulerAnglesYXZ/param/0" }, { "name": "ry", "documentation": "@roblox/global/CFrame.fromEulerAnglesYXZ/param/1" }, { "name": "rz", "documentation": "@roblox/global/CFrame.fromEulerAnglesYXZ/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromEulerAnglesYXZ", "code_sample": "" }, "@roblox/global/CFrame.Angles/param/0": { "documentation": "" }, "@roblox/global/CFrame.Angles/param/1": { "documentation": "" }, "@roblox/global/CFrame.Angles/param/2": { "documentation": "" }, "@roblox/global/CFrame.Angles": { "documentation": "Equivalent to fromEulerAnglesXYZ().", "params": [ { "name": "rx", "documentation": "@roblox/global/CFrame.Angles/param/0" }, { "name": "ry", "documentation": "@roblox/global/CFrame.Angles/param/1" }, { "name": "rz", "documentation": "@roblox/global/CFrame.Angles/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Angles", "code_sample": "" }, "@roblox/global/CFrame.fromOrientation/param/0": { "documentation": "" }, "@roblox/global/CFrame.fromOrientation/param/1": { "documentation": "" }, "@roblox/global/CFrame.fromOrientation/param/2": { "documentation": "" }, "@roblox/global/CFrame.fromOrientation": { "documentation": "Equivalent to fromEulerAnglesYXZ().", "params": [ { "name": "rx", "documentation": "@roblox/global/CFrame.fromOrientation/param/0" }, { "name": "ry", "documentation": "@roblox/global/CFrame.fromOrientation/param/1" }, { "name": "rz", "documentation": "@roblox/global/CFrame.fromOrientation/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromOrientation", "code_sample": "" }, "@roblox/global/CFrame.fromAxisAngle/param/0": { "documentation": "" }, "@roblox/global/CFrame.fromAxisAngle/param/1": { "documentation": "" }, "@roblox/global/CFrame.fromAxisAngle": { "documentation": "Returns a rotated CFrame from a unit Vector3 and a rotation in radians.", "params": [ { "name": "v", "documentation": "@roblox/global/CFrame.fromAxisAngle/param/0" }, { "name": "r", "documentation": "@roblox/global/CFrame.fromAxisAngle/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromAxisAngle", "code_sample": "" }, "@roblox/global/CFrame.fromMatrix/param/0": { "documentation": "The 3D position of the CFrame." }, "@roblox/global/CFrame.fromMatrix/param/1": { "documentation": "Equivalent to RightVector." }, "@roblox/global/CFrame.fromMatrix/param/2": { "documentation": "Equivalent to UpVector." }, "@roblox/global/CFrame.fromMatrix/param/3": { "documentation": "Equivalent to -LookVector." }, "@roblox/global/CFrame.fromMatrix": { "documentation": "Returns a CFrame from a translation and the columns of a rotation matrix.", "params": [ { "name": "pos", "documentation": "@roblox/global/CFrame.fromMatrix/param/0" }, { "name": "vX", "documentation": "@roblox/global/CFrame.fromMatrix/param/1" }, { "name": "vY", "documentation": "@roblox/global/CFrame.fromMatrix/param/2" }, { "name": "vZ", "documentation": "@roblox/global/CFrame.fromMatrix/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#fromMatrix", "code_sample": "" }, "@roblox/global/CFrame.identity": { "documentation": "An identity CFrame with no translation or rotation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#identity", "code_sample": "" }, "@roblox/globaltype/CFrame": { "documentation": "A data type that represents both a 3D position and orientation.", "keys": { "identity": "@roblox/globaltype/CFrame.identity", "Position": "@roblox/globaltype/CFrame.Position", "Rotation": "@roblox/globaltype/CFrame.Rotation", "X": "@roblox/globaltype/CFrame.X", "Y": "@roblox/globaltype/CFrame.Y", "Z": "@roblox/globaltype/CFrame.Z", "LookVector": "@roblox/globaltype/CFrame.LookVector", "RightVector": "@roblox/globaltype/CFrame.RightVector", "UpVector": "@roblox/globaltype/CFrame.UpVector", "XVector": "@roblox/globaltype/CFrame.XVector", "YVector": "@roblox/globaltype/CFrame.YVector", "ZVector": "@roblox/globaltype/CFrame.ZVector", "Inverse": "@roblox/globaltype/CFrame.Inverse", "Lerp": "@roblox/globaltype/CFrame.Lerp", "Orthonormalize": "@roblox/globaltype/CFrame.Orthonormalize", "ToWorldSpace": "@roblox/globaltype/CFrame.ToWorldSpace", "ToObjectSpace": "@roblox/globaltype/CFrame.ToObjectSpace", "PointToWorldSpace": "@roblox/globaltype/CFrame.PointToWorldSpace", "PointToObjectSpace": "@roblox/globaltype/CFrame.PointToObjectSpace", "VectorToWorldSpace": "@roblox/globaltype/CFrame.VectorToWorldSpace", "VectorToObjectSpace": "@roblox/globaltype/CFrame.VectorToObjectSpace", "GetComponents": "@roblox/globaltype/CFrame.GetComponents", "ToEulerAngles": "@roblox/globaltype/CFrame.ToEulerAngles", "ToEulerAnglesXYZ": "@roblox/globaltype/CFrame.ToEulerAnglesXYZ", "ToEulerAnglesYXZ": "@roblox/globaltype/CFrame.ToEulerAnglesYXZ", "ToOrientation": "@roblox/globaltype/CFrame.ToOrientation", "ToAxisAngle": "@roblox/globaltype/CFrame.ToAxisAngle", "components": "@roblox/globaltype/CFrame.components", "FuzzyEq": "@roblox/globaltype/CFrame.FuzzyEq", "AngleBetween": "@roblox/globaltype/CFrame.AngleBetween" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame", "code_sample": "" }, "@roblox/globaltype/CFrame.identity": { "documentation": "An identity CFrame with no translation or rotation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#identity", "code_sample": "" }, "@roblox/globaltype/CFrame.Position": { "documentation": "The 3D position of the CFrame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Position", "code_sample": "" }, "@roblox/globaltype/CFrame.Rotation": { "documentation": "A copy of the CFrame with no translation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Rotation", "code_sample": "" }, "@roblox/globaltype/CFrame.X": { "documentation": "The X coordinate of the position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#X", "code_sample": "" }, "@roblox/globaltype/CFrame.Y": { "documentation": "The Y coordinate of the position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Y", "code_sample": "" }, "@roblox/globaltype/CFrame.Z": { "documentation": "The Z coordinate of the position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Z", "code_sample": "" }, "@roblox/globaltype/CFrame.LookVector": { "documentation": "The forward-direction component of the CFrame object's orientation, equivalent to the negated form of ZVector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#LookVector", "code_sample": "" }, "@roblox/globaltype/CFrame.RightVector": { "documentation": "The right-direction component of the CFrame object's orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#RightVector", "code_sample": "" }, "@roblox/globaltype/CFrame.UpVector": { "documentation": "The up-direction component of the CFrame object's orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#UpVector", "code_sample": "" }, "@roblox/globaltype/CFrame.XVector": { "documentation": "Equivalent to RightVector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#XVector", "code_sample": "" }, "@roblox/globaltype/CFrame.YVector": { "documentation": "Equivalent to UpVector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#YVector", "code_sample": "" }, "@roblox/globaltype/CFrame.ZVector": { "documentation": "The Z component of the CFrame object's orientation. Equivalent to the third column of the rotation matrix.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ZVector", "code_sample": "" }, "@roblox/globaltype/CFrame.Inverse/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.Inverse/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.Inverse": { "documentation": "Returns the inverse of the CFrame.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.Inverse/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.Inverse/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Inverse", "code_sample": "" }, "@roblox/globaltype/CFrame.Lerp/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.Lerp/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.Lerp/param/2": { "documentation": "" }, "@roblox/globaltype/CFrame.Lerp/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.Lerp": { "documentation": "Returns a CFrame interpolated between itself and goal by the fraction alpha.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.Lerp/param/0" }, { "name": "goal", "documentation": "@roblox/globaltype/CFrame.Lerp/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/CFrame.Lerp/param/2" } ], "returns": [ "@roblox/globaltype/CFrame.Lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Lerp", "code_sample": "" }, "@roblox/globaltype/CFrame.Orthonormalize/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.Orthonormalize/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.Orthonormalize": { "documentation": "Returns an orthonormalized copy of the CFrame.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.Orthonormalize/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.Orthonormalize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#Orthonormalize", "code_sample": "" }, "@roblox/globaltype/CFrame.ToWorldSpace/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToWorldSpace/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToWorldSpace/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToWorldSpace": { "documentation": "Receives one or more CFrame objects and returns them transformed from object to world space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToWorldSpace/param/0" }, { "name": "...", "documentation": "@roblox/globaltype/CFrame.ToWorldSpace/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.ToWorldSpace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToWorldSpace", "code_sample": "" }, "@roblox/globaltype/CFrame.ToObjectSpace/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToObjectSpace/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToObjectSpace/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToObjectSpace": { "documentation": "Receives one or more CFrame objects and returns them transformed from world to object space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToObjectSpace/param/0" }, { "name": "...", "documentation": "@roblox/globaltype/CFrame.ToObjectSpace/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.ToObjectSpace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToObjectSpace", "code_sample": "" }, "@roblox/globaltype/CFrame.PointToWorldSpace/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.PointToWorldSpace/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.PointToWorldSpace/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.PointToWorldSpace": { "documentation": "Receives one or more Vector3 objects and returns them transformed from object to world space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.PointToWorldSpace/param/0" }, { "name": "...", "documentation": "@roblox/globaltype/CFrame.PointToWorldSpace/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.PointToWorldSpace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#PointToWorldSpace", "code_sample": "" }, "@roblox/globaltype/CFrame.PointToObjectSpace/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.PointToObjectSpace/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.PointToObjectSpace/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.PointToObjectSpace": { "documentation": "Receives one or more Vector3 objects and returns them transformed from world to object space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.PointToObjectSpace/param/0" }, { "name": "...", "documentation": "@roblox/globaltype/CFrame.PointToObjectSpace/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.PointToObjectSpace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#PointToObjectSpace", "code_sample": "" }, "@roblox/globaltype/CFrame.VectorToWorldSpace/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.VectorToWorldSpace/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.VectorToWorldSpace/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.VectorToWorldSpace": { "documentation": "Receives one or more Vector3 objects and returns them rotated from object to world space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.VectorToWorldSpace/param/0" }, { "name": "...", "documentation": "@roblox/globaltype/CFrame.VectorToWorldSpace/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.VectorToWorldSpace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#VectorToWorldSpace", "code_sample": "" }, "@roblox/globaltype/CFrame.VectorToObjectSpace/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.VectorToObjectSpace/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.VectorToObjectSpace/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.VectorToObjectSpace": { "documentation": "Receives one or more Vector3 objects and returns them rotated from world to object space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.VectorToObjectSpace/param/0" }, { "name": "...", "documentation": "@roblox/globaltype/CFrame.VectorToObjectSpace/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.VectorToObjectSpace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#VectorToObjectSpace", "code_sample": "" }, "@roblox/globaltype/CFrame.GetComponents/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.GetComponents/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.GetComponents": { "documentation": "Returns the values x, y, z, R00, R01, R02, R10, R11, R12, R20, R21, and R22, where x y z represent the position of the CFrame and R00‑R22 represent its 3×3 rotation matrix.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.GetComponents/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.GetComponents/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#GetComponents", "code_sample": "" }, "@roblox/globaltype/CFrame.ToEulerAngles/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToEulerAngles/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAngles/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAngles/return/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAngles/return/2": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAngles": { "documentation": "Returns approximate angles that could be used to generate the CFrame using the optional RotationOrder.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToEulerAngles/param/0" }, { "name": "order", "documentation": "@roblox/globaltype/CFrame.ToEulerAngles/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.ToEulerAngles/return/0", "@roblox/globaltype/CFrame.ToEulerAngles/return/1", "@roblox/globaltype/CFrame.ToEulerAngles/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToEulerAngles", "code_sample": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/return/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/return/2": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesXYZ": { "documentation": "Returns approximate angles that could be used to generate the CFrame using RotationOrder.XYZ.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/return/0", "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/return/1", "@roblox/globaltype/CFrame.ToEulerAnglesXYZ/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToEulerAnglesXYZ", "code_sample": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/return/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/return/2": { "documentation": "" }, "@roblox/globaltype/CFrame.ToEulerAnglesYXZ": { "documentation": "Returns approximate angles that could be used to generate the CFrame using RotationOrder.YXZ.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/return/0", "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/return/1", "@roblox/globaltype/CFrame.ToEulerAnglesYXZ/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToEulerAnglesYXZ", "code_sample": "" }, "@roblox/globaltype/CFrame.ToOrientation/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToOrientation/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToOrientation/return/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToOrientation/return/2": { "documentation": "" }, "@roblox/globaltype/CFrame.ToOrientation": { "documentation": "Equivalent to CFrame:ToEulerAnglesYXZ().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToOrientation/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.ToOrientation/return/0", "@roblox/globaltype/CFrame.ToOrientation/return/1", "@roblox/globaltype/CFrame.ToOrientation/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToOrientation", "code_sample": "" }, "@roblox/globaltype/CFrame.ToAxisAngle/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.ToAxisAngle/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.ToAxisAngle/return/1": { "documentation": "" }, "@roblox/globaltype/CFrame.ToAxisAngle": { "documentation": "Returns a tuple containing a unit Vector3 axis and a rotation angle in radians.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.ToAxisAngle/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.ToAxisAngle/return/0", "@roblox/globaltype/CFrame.ToAxisAngle/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#ToAxisAngle", "code_sample": "" }, "@roblox/globaltype/CFrame.components/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.components/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.components": { "documentation": "Equivalent to CFrame:GetComponents().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.components/param/0" } ], "returns": [ "@roblox/globaltype/CFrame.components/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#components", "code_sample": "" }, "@roblox/globaltype/CFrame.FuzzyEq/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.FuzzyEq/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.FuzzyEq/param/2": { "documentation": "" }, "@roblox/globaltype/CFrame.FuzzyEq/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.FuzzyEq": { "documentation": "Returns true if the other CFrame is sufficiently close to this CFrame in both position and rotation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.FuzzyEq/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/CFrame.FuzzyEq/param/1" }, { "name": "epsilon", "documentation": "@roblox/globaltype/CFrame.FuzzyEq/param/2" } ], "returns": [ "@roblox/globaltype/CFrame.FuzzyEq/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#FuzzyEq", "code_sample": "" }, "@roblox/globaltype/CFrame.AngleBetween/param/0": { "documentation": "A data type that represents both a 3D position and orientation." }, "@roblox/globaltype/CFrame.AngleBetween/param/1": { "documentation": "" }, "@roblox/globaltype/CFrame.AngleBetween/return/0": { "documentation": "" }, "@roblox/globaltype/CFrame.AngleBetween": { "documentation": "Returns the angle, in radians, between the orientation of one CFrame and another.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrame.AngleBetween/param/0" }, { "name": "other", "documentation": "@roblox/globaltype/CFrame.AngleBetween/param/1" } ], "returns": [ "@roblox/globaltype/CFrame.AngleBetween/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/CFrame#AngleBetween", "code_sample": "" }, "@roblox/globaltype/Secret": { "documentation": "Stores secret non-printable content.", "keys": { "AddPrefix": "@roblox/globaltype/Secret.AddPrefix", "AddSuffix": "@roblox/globaltype/Secret.AddSuffix" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Secret", "code_sample": "" }, "@roblox/globaltype/Secret.AddPrefix/param/0": { "documentation": "Stores secret non-printable content." }, "@roblox/globaltype/Secret.AddPrefix/param/1": { "documentation": "" }, "@roblox/globaltype/Secret.AddPrefix/return/0": { "documentation": "" }, "@roblox/globaltype/Secret.AddPrefix": { "documentation": "Prepends a string to the secret content.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Secret.AddPrefix/param/0" }, { "name": "prefix", "documentation": "@roblox/globaltype/Secret.AddPrefix/param/1" } ], "returns": [ "@roblox/globaltype/Secret.AddPrefix/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Secret#AddPrefix", "code_sample": "" }, "@roblox/globaltype/Secret.AddSuffix/param/0": { "documentation": "Stores secret non-printable content." }, "@roblox/globaltype/Secret.AddSuffix/param/1": { "documentation": "" }, "@roblox/globaltype/Secret.AddSuffix/return/0": { "documentation": "" }, "@roblox/globaltype/Secret.AddSuffix": { "documentation": "Appends a string to the secret content.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Secret.AddSuffix/param/0" }, { "name": "suffix", "documentation": "@roblox/globaltype/Secret.AddSuffix/param/1" } ], "returns": [ "@roblox/globaltype/Secret.AddSuffix/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/Secret#AddSuffix", "code_sample": "" }, "@roblox/global/RaycastParams": { "documentation": "A container for parameters used in raycasting operations.", "keys": { "new": "@roblox/global/RaycastParams.new" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams", "code_sample": "" }, "@roblox/global/RaycastParams.new": { "documentation": "Returns a blank RaycastParams.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#new", "code_sample": "" }, "@roblox/globaltype/RaycastParams": { "documentation": "A container for parameters used in raycasting operations.", "keys": { "FilterDescendantsInstances": "@roblox/globaltype/RaycastParams.FilterDescendantsInstances", "FilterType": "@roblox/globaltype/RaycastParams.FilterType", "IgnoreWater": "@roblox/globaltype/RaycastParams.IgnoreWater", "CollisionGroup": "@roblox/globaltype/RaycastParams.CollisionGroup", "RespectCanCollide": "@roblox/globaltype/RaycastParams.RespectCanCollide", "BruteForceAllSlow": "@roblox/globaltype/RaycastParams.BruteForceAllSlow", "AddToFilter": "@roblox/globaltype/RaycastParams.AddToFilter" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams", "code_sample": "" }, "@roblox/globaltype/RaycastParams.FilterDescendantsInstances": { "documentation": "An array of objects whose descendants are used in filtering raycasting candidates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#FilterDescendantsInstances", "code_sample": "" }, "@roblox/globaltype/RaycastParams.FilterType": { "documentation": "Determines how the FilterDescendantsInstances array is used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#FilterType", "code_sample": "" }, "@roblox/globaltype/RaycastParams.IgnoreWater": { "documentation": "Determines whether the water material is considered when raycasting against Terrain.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#IgnoreWater", "code_sample": "" }, "@roblox/globaltype/RaycastParams.CollisionGroup": { "documentation": "The collision group used for the operation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#CollisionGroup", "code_sample": "" }, "@roblox/globaltype/RaycastParams.RespectCanCollide": { "documentation": "Determines whether the raycast operation considers a part's CanCollide property value over its CanQuery value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#RespectCanCollide", "code_sample": "" }, "@roblox/globaltype/RaycastParams.BruteForceAllSlow": { "documentation": "When enabled, the query will ignore all part collision properties and perform a brute-force check on every part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#BruteForceAllSlow", "code_sample": "" }, "@roblox/globaltype/RaycastParams.AddToFilter/param/0": { "documentation": "A container for parameters used in raycasting operations." }, "@roblox/globaltype/RaycastParams.AddToFilter/param/1": { "documentation": "An instance or an array containing instances to add." }, "@roblox/globaltype/RaycastParams.AddToFilter": { "documentation": "Adds the instances provided to FilterDescendantsInstances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RaycastParams.AddToFilter/param/0" }, { "name": "instances", "documentation": "@roblox/globaltype/RaycastParams.AddToFilter/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#AddToFilter", "code_sample": "" }, "@roblox/global/UDim2": { "documentation": "Represents a two-dimensional value where each dimension is composed of a relative scale and an absolute offset.", "keys": { "new": "@roblox/global/UDim2.new", "fromScale": "@roblox/global/UDim2.fromScale", "fromOffset": "@roblox/global/UDim2.fromOffset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2", "code_sample": "" }, "@roblox/global/UDim2.new": { "overloads": { "() -> UDim2": "@roblox/global/UDim2.new/overload/() -> UDim2", "(number?, number?, number?, number?) -> UDim2": "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2", "(UDim, UDim) -> UDim2": "@roblox/global/UDim2.new/overload/(UDim, UDim) -> UDim2" } }, "@roblox/global/UDim2.new/overload/() -> UDim2": { "documentation": "Returns a new UDim2 with the coordinates of two zero UDim components representing each axis.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#new", "code_sample": "" }, "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/0": { "documentation": "The X dimension scale." }, "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/1": { "documentation": "The X dimension offset." }, "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/2": { "documentation": "The Y dimension scale." }, "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/3": { "documentation": "The Y dimension offset." }, "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2": { "documentation": "Returns a new UDim2 given the coordinates of the two UDim components representing each axis.", "params": [ { "name": "xScale", "documentation": "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/0" }, { "name": "xOffset", "documentation": "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/1" }, { "name": "yScale", "documentation": "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/2" }, { "name": "yOffset", "documentation": "@roblox/global/UDim2.new/overload/(number?, number?, number?, number?) -> UDim2/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#new", "code_sample": "" }, "@roblox/global/UDim2.new/overload/(UDim, UDim) -> UDim2/param/0": { "documentation": "" }, "@roblox/global/UDim2.new/overload/(UDim, UDim) -> UDim2/param/1": { "documentation": "" }, "@roblox/global/UDim2.new/overload/(UDim, UDim) -> UDim2": { "documentation": "Returns a new UDim2 from the given UDim objects representing the X and Y dimensions, respectively.", "params": [ { "name": "x", "documentation": "@roblox/global/UDim2.new/overload/(UDim, UDim) -> UDim2/param/0" }, { "name": "y", "documentation": "@roblox/global/UDim2.new/overload/(UDim, UDim) -> UDim2/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#new", "code_sample": "" }, "@roblox/global/UDim2.fromScale/param/0": { "documentation": "" }, "@roblox/global/UDim2.fromScale/param/1": { "documentation": "" }, "@roblox/global/UDim2.fromScale": { "documentation": "Returns a new UDim2 with the given scale components and no offsets.", "params": [ { "name": "xScale", "documentation": "@roblox/global/UDim2.fromScale/param/0" }, { "name": "yScale", "documentation": "@roblox/global/UDim2.fromScale/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#fromScale", "code_sample": "" }, "@roblox/global/UDim2.fromOffset/param/0": { "documentation": "" }, "@roblox/global/UDim2.fromOffset/param/1": { "documentation": "" }, "@roblox/global/UDim2.fromOffset": { "documentation": "Returns a new UDim2 with the given offset components and no scaling.", "params": [ { "name": "xOffset", "documentation": "@roblox/global/UDim2.fromOffset/param/0" }, { "name": "yOffset", "documentation": "@roblox/global/UDim2.fromOffset/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#fromOffset", "code_sample": "" }, "@roblox/globaltype/UDim2": { "documentation": "Represents a two-dimensional value where each dimension is composed of a relative scale and an absolute offset.", "keys": { "X": "@roblox/globaltype/UDim2.X", "Y": "@roblox/globaltype/UDim2.Y", "Width": "@roblox/globaltype/UDim2.Width", "Height": "@roblox/globaltype/UDim2.Height", "Lerp": "@roblox/globaltype/UDim2.Lerp" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2", "code_sample": "" }, "@roblox/globaltype/UDim2.X": { "documentation": "The X dimension scale and offset of the UDim2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#X", "code_sample": "" }, "@roblox/globaltype/UDim2.Y": { "documentation": "The Y dimension scale and offset of the UDim2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#Y", "code_sample": "" }, "@roblox/globaltype/UDim2.Width": { "documentation": "The X dimension scale and offset of the UDim2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#Width", "code_sample": "" }, "@roblox/globaltype/UDim2.Height": { "documentation": "The Y dimension scale and offset of the UDim2.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#Height", "code_sample": "" }, "@roblox/globaltype/UDim2.Lerp/param/0": { "documentation": "Represents a two-dimensional value where each dimension is composed of a relative scale and an absolute offset." }, "@roblox/globaltype/UDim2.Lerp/param/1": { "documentation": "" }, "@roblox/globaltype/UDim2.Lerp/param/2": { "documentation": "" }, "@roblox/globaltype/UDim2.Lerp/return/0": { "documentation": "" }, "@roblox/globaltype/UDim2.Lerp": { "documentation": "Returns a UDim2 interpolated linearly between the value and the given goal.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UDim2.Lerp/param/0" }, { "name": "goal", "documentation": "@roblox/globaltype/UDim2.Lerp/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/UDim2.Lerp/param/2" } ], "returns": [ "@roblox/globaltype/UDim2.Lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/UDim2#Lerp", "code_sample": "" }, "@roblox/globaltype/PluginToolbar": { "documentation": "", "keys": { "CreateButton": "@roblox/globaltype/PluginToolbar.CreateButton" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbar", "code_sample": "" }, "@roblox/globaltype/PluginToolbar.CreateButton/param/0": { "documentation": "" }, "@roblox/globaltype/PluginToolbar.CreateButton/param/1": { "documentation": "A unique button ID." }, "@roblox/globaltype/PluginToolbar.CreateButton/param/2": { "documentation": "The text displayed in the tooltip shown when a user hovers over the button." }, "@roblox/globaltype/PluginToolbar.CreateButton/param/3": { "documentation": "The asset ID of the icon displayed in the button." }, "@roblox/globaltype/PluginToolbar.CreateButton/param/4": { "documentation": "Optional text displayed under the button icon." }, "@roblox/globaltype/PluginToolbar.CreateButton/return/0": { "documentation": "The created PluginToolbarButton instance." }, "@roblox/globaltype/PluginToolbar.CreateButton": { "documentation": "Creates a PluginToolbarButton that allows the user to initiate a single, one-off action in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginToolbar.CreateButton/param/0" }, { "name": "buttonId", "documentation": "@roblox/globaltype/PluginToolbar.CreateButton/param/1" }, { "name": "tooltip", "documentation": "@roblox/globaltype/PluginToolbar.CreateButton/param/2" }, { "name": "iconname", "documentation": "@roblox/globaltype/PluginToolbar.CreateButton/param/3" }, { "name": "text", "documentation": "@roblox/globaltype/PluginToolbar.CreateButton/param/4" } ], "returns": [ "@roblox/globaltype/PluginToolbar.CreateButton/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbar#CreateButton", "code_sample": "" }, "@roblox/globaltype/MaterialService": { "documentation": "The game service responsible for managing materials.", "keys": { "AsphaltName": "@roblox/globaltype/MaterialService.AsphaltName", "BasaltName": "@roblox/globaltype/MaterialService.BasaltName", "BrickName": "@roblox/globaltype/MaterialService.BrickName", "CardboardName": "@roblox/globaltype/MaterialService.CardboardName", "CarpetName": "@roblox/globaltype/MaterialService.CarpetName", "CeramicTilesName": "@roblox/globaltype/MaterialService.CeramicTilesName", "ClayRoofTilesName": "@roblox/globaltype/MaterialService.ClayRoofTilesName", "CobblestoneName": "@roblox/globaltype/MaterialService.CobblestoneName", "ConcreteName": "@roblox/globaltype/MaterialService.ConcreteName", "CorrodedMetalName": "@roblox/globaltype/MaterialService.CorrodedMetalName", "CrackedLavaName": "@roblox/globaltype/MaterialService.CrackedLavaName", "DiamondPlateName": "@roblox/globaltype/MaterialService.DiamondPlateName", "FabricName": "@roblox/globaltype/MaterialService.FabricName", "FoilName": "@roblox/globaltype/MaterialService.FoilName", "GlacierName": "@roblox/globaltype/MaterialService.GlacierName", "GraniteName": "@roblox/globaltype/MaterialService.GraniteName", "GrassName": "@roblox/globaltype/MaterialService.GrassName", "GroundName": "@roblox/globaltype/MaterialService.GroundName", "IceName": "@roblox/globaltype/MaterialService.IceName", "LeafyGrassName": "@roblox/globaltype/MaterialService.LeafyGrassName", "LeatherName": "@roblox/globaltype/MaterialService.LeatherName", "LimestoneName": "@roblox/globaltype/MaterialService.LimestoneName", "MarbleName": "@roblox/globaltype/MaterialService.MarbleName", "MetalName": "@roblox/globaltype/MaterialService.MetalName", "MudName": "@roblox/globaltype/MaterialService.MudName", "PavementName": "@roblox/globaltype/MaterialService.PavementName", "PebbleName": "@roblox/globaltype/MaterialService.PebbleName", "PlasterName": "@roblox/globaltype/MaterialService.PlasterName", "PlasticName": "@roblox/globaltype/MaterialService.PlasticName", "RockName": "@roblox/globaltype/MaterialService.RockName", "RoofShinglesName": "@roblox/globaltype/MaterialService.RoofShinglesName", "RubberName": "@roblox/globaltype/MaterialService.RubberName", "SaltName": "@roblox/globaltype/MaterialService.SaltName", "SandName": "@roblox/globaltype/MaterialService.SandName", "SandstoneName": "@roblox/globaltype/MaterialService.SandstoneName", "SlateName": "@roblox/globaltype/MaterialService.SlateName", "SmoothPlasticName": "@roblox/globaltype/MaterialService.SmoothPlasticName", "SnowName": "@roblox/globaltype/MaterialService.SnowName", "Use2022Materials": "@roblox/globaltype/MaterialService.Use2022Materials", "WoodName": "@roblox/globaltype/MaterialService.WoodName", "WoodPlanksName": "@roblox/globaltype/MaterialService.WoodPlanksName", "GetBaseMaterialOverride": "@roblox/globaltype/MaterialService.GetBaseMaterialOverride", "GetMaterialVariant": "@roblox/globaltype/MaterialService.GetMaterialVariant", "SetBaseMaterialOverride": "@roblox/globaltype/MaterialService.SetBaseMaterialOverride" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService", "code_sample": "" }, "@roblox/globaltype/MaterialService.AsphaltName": { "documentation": "Specify MaterialVariant name to override built-in Asphalt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#AsphaltName", "code_sample": "" }, "@roblox/globaltype/MaterialService.BasaltName": { "documentation": "Specify MaterialVariant name to override built-in Basalt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#BasaltName", "code_sample": "" }, "@roblox/globaltype/MaterialService.BrickName": { "documentation": "Specify MaterialVariant name to override built-in Brick.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#BrickName", "code_sample": "" }, "@roblox/globaltype/MaterialService.CardboardName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#CardboardName", "code_sample": "" }, "@roblox/globaltype/MaterialService.CarpetName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#CarpetName", "code_sample": "" }, "@roblox/globaltype/MaterialService.CeramicTilesName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#CeramicTilesName", "code_sample": "" }, "@roblox/globaltype/MaterialService.ClayRoofTilesName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#ClayRoofTilesName", "code_sample": "" }, "@roblox/globaltype/MaterialService.CobblestoneName": { "documentation": "Specify MaterialVariant name to override built-in Cobblestone.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#CobblestoneName", "code_sample": "" }, "@roblox/globaltype/MaterialService.ConcreteName": { "documentation": "Specify MaterialVariant name to override built-in Concrete.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#ConcreteName", "code_sample": "" }, "@roblox/globaltype/MaterialService.CorrodedMetalName": { "documentation": "Specify MaterialVariant name to override built-in CorrodedMetal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#CorrodedMetalName", "code_sample": "" }, "@roblox/globaltype/MaterialService.CrackedLavaName": { "documentation": "Specify MaterialVariant name to override built-in CrackedLava.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#CrackedLavaName", "code_sample": "" }, "@roblox/globaltype/MaterialService.DiamondPlateName": { "documentation": "Specify MaterialVariant name to override built-in DiamondPlate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#DiamondPlateName", "code_sample": "" }, "@roblox/globaltype/MaterialService.FabricName": { "documentation": "Specify MaterialVariant name to override built-in Fabric.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#FabricName", "code_sample": "" }, "@roblox/globaltype/MaterialService.FoilName": { "documentation": "Specify MaterialVariant name to override built-in Foil.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#FoilName", "code_sample": "" }, "@roblox/globaltype/MaterialService.GlacierName": { "documentation": "Specify MaterialVariant name to override built-in Glacier.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#GlacierName", "code_sample": "" }, "@roblox/globaltype/MaterialService.GraniteName": { "documentation": "Specify MaterialVariant name to override built-in Granite.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#GraniteName", "code_sample": "" }, "@roblox/globaltype/MaterialService.GrassName": { "documentation": "Specify MaterialVariant name to override built-in Grass.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#GrassName", "code_sample": "" }, "@roblox/globaltype/MaterialService.GroundName": { "documentation": "Specify MaterialVariant name to override built-in Ground.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#GroundName", "code_sample": "" }, "@roblox/globaltype/MaterialService.IceName": { "documentation": "Specify MaterialVariant name to override built-in Ice.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#IceName", "code_sample": "" }, "@roblox/globaltype/MaterialService.LeafyGrassName": { "documentation": "Specify MaterialVariant name to override built-in LeafyGrass.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#LeafyGrassName", "code_sample": "" }, "@roblox/globaltype/MaterialService.LeatherName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#LeatherName", "code_sample": "" }, "@roblox/globaltype/MaterialService.LimestoneName": { "documentation": "Specify MaterialVariant name to override built-in Limestone.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#LimestoneName", "code_sample": "" }, "@roblox/globaltype/MaterialService.MarbleName": { "documentation": "Specify MaterialVariant name to override built-in Marble.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#MarbleName", "code_sample": "" }, "@roblox/globaltype/MaterialService.MetalName": { "documentation": "Specify MaterialVariant name to override built-in Metal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#MetalName", "code_sample": "" }, "@roblox/globaltype/MaterialService.MudName": { "documentation": "Specify MaterialVariant name to override built-in Mud.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#MudName", "code_sample": "" }, "@roblox/globaltype/MaterialService.PavementName": { "documentation": "Specify MaterialVariant name to override built-in Pavement.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#PavementName", "code_sample": "" }, "@roblox/globaltype/MaterialService.PebbleName": { "documentation": "Specify MaterialVariant name to override built-in Pebble.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#PebbleName", "code_sample": "" }, "@roblox/globaltype/MaterialService.PlasterName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#PlasterName", "code_sample": "" }, "@roblox/globaltype/MaterialService.PlasticName": { "documentation": "Specify MaterialVariant name to override built-in Plastic.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#PlasticName", "code_sample": "" }, "@roblox/globaltype/MaterialService.RockName": { "documentation": "Specify MaterialVariant name to override built-in Rock.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#RockName", "code_sample": "" }, "@roblox/globaltype/MaterialService.RoofShinglesName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#RoofShinglesName", "code_sample": "" }, "@roblox/globaltype/MaterialService.RubberName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#RubberName", "code_sample": "" }, "@roblox/globaltype/MaterialService.SaltName": { "documentation": "Specify MaterialVariant name to override built-in Salt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SaltName", "code_sample": "" }, "@roblox/globaltype/MaterialService.SandName": { "documentation": "Specify MaterialVariant name to override built-in Sand.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SandName", "code_sample": "" }, "@roblox/globaltype/MaterialService.SandstoneName": { "documentation": "Specify MaterialVariant name to override built-in Sandstone.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SandstoneName", "code_sample": "" }, "@roblox/globaltype/MaterialService.SlateName": { "documentation": "Specify MaterialVariant name to override built-in Slate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SlateName", "code_sample": "" }, "@roblox/globaltype/MaterialService.SmoothPlasticName": { "documentation": "Specify MaterialVariant name to override built-in SmoothPlastic.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SmoothPlasticName", "code_sample": "" }, "@roblox/globaltype/MaterialService.SnowName": { "documentation": "Specify MaterialVariant name to override built-in Snow.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SnowName", "code_sample": "" }, "@roblox/globaltype/MaterialService.Use2022Materials": { "documentation": "Switch built-in material pack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#Use2022Materials", "code_sample": "" }, "@roblox/globaltype/MaterialService.WoodName": { "documentation": "Specify MaterialVariant name to override built-in Wood.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#WoodName", "code_sample": "" }, "@roblox/globaltype/MaterialService.WoodPlanksName": { "documentation": "Specify MaterialVariant name to override built-in WoodPlanks.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#WoodPlanksName", "code_sample": "" }, "@roblox/globaltype/MaterialService.GetBaseMaterialOverride/param/0": { "documentation": "The game service responsible for managing materials." }, "@roblox/globaltype/MaterialService.GetBaseMaterialOverride/param/1": { "documentation": "Material type to be fetched." }, "@roblox/globaltype/MaterialService.GetBaseMaterialOverride/return/0": { "documentation": "MaterialVariant name currently set as override." }, "@roblox/globaltype/MaterialService.GetBaseMaterialOverride": { "documentation": "Get the override MaterialVariant name of specified Material type.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MaterialService.GetBaseMaterialOverride/param/0" }, { "name": "material", "documentation": "@roblox/globaltype/MaterialService.GetBaseMaterialOverride/param/1" } ], "returns": [ "@roblox/globaltype/MaterialService.GetBaseMaterialOverride/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#GetBaseMaterialOverride", "code_sample": "" }, "@roblox/globaltype/MaterialService.GetMaterialVariant/param/0": { "documentation": "The game service responsible for managing materials." }, "@roblox/globaltype/MaterialService.GetMaterialVariant/param/1": { "documentation": "BaseMaterial of MaterialVariant." }, "@roblox/globaltype/MaterialService.GetMaterialVariant/param/2": { "documentation": "Name of MaterialVariant." }, "@roblox/globaltype/MaterialService.GetMaterialVariant/return/0": { "documentation": "A MaterialVariant instance that matches parameters." }, "@roblox/globaltype/MaterialService.GetMaterialVariant": { "documentation": "Get the effective MaterialVariant reference given a name and Material.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MaterialService.GetMaterialVariant/param/0" }, { "name": "material", "documentation": "@roblox/globaltype/MaterialService.GetMaterialVariant/param/1" }, { "name": "name", "documentation": "@roblox/globaltype/MaterialService.GetMaterialVariant/param/2" } ], "returns": [ "@roblox/globaltype/MaterialService.GetMaterialVariant/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#GetMaterialVariant", "code_sample": "" }, "@roblox/globaltype/MaterialService.SetBaseMaterialOverride/param/0": { "documentation": "The game service responsible for managing materials." }, "@roblox/globaltype/MaterialService.SetBaseMaterialOverride/param/1": { "documentation": "The Material type to be changed." }, "@roblox/globaltype/MaterialService.SetBaseMaterialOverride/param/2": { "documentation": "Name of the MaterialVariant object." }, "@roblox/globaltype/MaterialService.SetBaseMaterialOverride": { "documentation": "Set a MaterialVariant name that overrides a built-in material.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MaterialService.SetBaseMaterialOverride/param/0" }, { "name": "material", "documentation": "@roblox/globaltype/MaterialService.SetBaseMaterialOverride/param/1" }, { "name": "name", "documentation": "@roblox/globaltype/MaterialService.SetBaseMaterialOverride/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialService#SetBaseMaterialOverride", "code_sample": "" }, "@roblox/globaltype/PartOperationAsset": { "documentation": "An internal service which cannot be used by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperationAsset", "code_sample": "" }, "@roblox/globaltype/TestService": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.", "keys": { "AutoRuns": "@roblox/globaltype/TestService.AutoRuns", "Description": "@roblox/globaltype/TestService.Description", "ErrorCount": "@roblox/globaltype/TestService.ErrorCount", "ExecuteWithStudioRun": "@roblox/globaltype/TestService.ExecuteWithStudioRun", "Is30FpsThrottleEnabled": "@roblox/globaltype/TestService.Is30FpsThrottleEnabled", "IsPhysicsEnvironmentalThrottled": "@roblox/globaltype/TestService.IsPhysicsEnvironmentalThrottled", "IsSleepAllowed": "@roblox/globaltype/TestService.IsSleepAllowed", "NumberOfPlayers": "@roblox/globaltype/TestService.NumberOfPlayers", "SimulateSecondsLag": "@roblox/globaltype/TestService.SimulateSecondsLag", "TestCount": "@roblox/globaltype/TestService.TestCount", "ThrottlePhysicsToRealtime": "@roblox/globaltype/TestService.ThrottlePhysicsToRealtime", "Timeout": "@roblox/globaltype/TestService.Timeout", "WarnCount": "@roblox/globaltype/TestService.WarnCount", "Check": "@roblox/globaltype/TestService.Check", "Checkpoint": "@roblox/globaltype/TestService.Checkpoint", "Done": "@roblox/globaltype/TestService.Done", "Error": "@roblox/globaltype/TestService.Error", "Fail": "@roblox/globaltype/TestService.Fail", "isFeatureEnabled": "@roblox/globaltype/TestService.isFeatureEnabled", "Message": "@roblox/globaltype/TestService.Message", "Require": "@roblox/globaltype/TestService.Require", "RunAsync": "@roblox/globaltype/TestService.RunAsync", "Run": "@roblox/globaltype/TestService.Run", "ScopeTime": "@roblox/globaltype/TestService.ScopeTime", "TakeSnapshot": "@roblox/globaltype/TestService.TakeSnapshot", "Warn": "@roblox/globaltype/TestService.Warn" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService", "code_sample": "" }, "@roblox/globaltype/TestService.AutoRuns": { "documentation": "If set to true, the game will start running when the service's TestService:RunAsync() method is called.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#AutoRuns", "code_sample": "" }, "@roblox/globaltype/TestService.Description": { "documentation": "A description of the test being executed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Description", "code_sample": "" }, "@roblox/globaltype/TestService.ErrorCount": { "documentation": "Measures how many errors have been recorded in the test session.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#ErrorCount", "code_sample": "" }, "@roblox/globaltype/TestService.ExecuteWithStudioRun": { "documentation": "When set to true, TestService will be executed when using the Run action in Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#ExecuteWithStudioRun", "code_sample": "" }, "@roblox/globaltype/TestService.Is30FpsThrottleEnabled": { "documentation": "Deprecated: This has been deprecated and directly renamed to ThrottlePhysicsToRealtime to better reflect its practical use.
Sets whether or not the physics engine should be throttled to 30 FPS while the test is being ran.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled", "code_sample": "" }, "@roblox/globaltype/TestService.IsPhysicsEnvironmentalThrottled": { "documentation": "Sets whether or not the physics environment should be throttled while running this test.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#IsPhysicsEnvironmentalThrottled", "code_sample": "" }, "@roblox/globaltype/TestService.IsSleepAllowed": { "documentation": "Sets whether or not physics objects will be allowed to fall asleep while the test simulation is running.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#IsSleepAllowed", "code_sample": "" }, "@roblox/globaltype/TestService.NumberOfPlayers": { "documentation": "The number of players expected in this test, if any.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#NumberOfPlayers", "code_sample": "" }, "@roblox/globaltype/TestService.SimulateSecondsLag": { "documentation": "Sets a specific amount of additional latency experienced by players during the test session.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#SimulateSecondsLag", "code_sample": "" }, "@roblox/globaltype/TestService.TestCount": { "documentation": "Measures how many test calls have been recorded in the test session.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#TestCount", "code_sample": "" }, "@roblox/globaltype/TestService.ThrottlePhysicsToRealtime": { "documentation": "Sets whether the test should be throttled to simulate time according to real world time or as fast as possible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#ThrottlePhysicsToRealtime", "code_sample": "" }, "@roblox/globaltype/TestService.Timeout": { "documentation": "The maximum amount of time that tests are allowed to run for.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Timeout", "code_sample": "" }, "@roblox/globaltype/TestService.WarnCount": { "documentation": "Measures how many warning calls have been recorded in the test session.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#WarnCount", "code_sample": "" }, "@roblox/globaltype/TestService.Check/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Check/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Check/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Check/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Check/param/4": { "documentation": "" }, "@roblox/globaltype/TestService.Check": { "documentation": "Prints result of a condition to the output.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Check/param/0" }, { "name": "condition", "documentation": "@roblox/globaltype/TestService.Check/param/1" }, { "name": "description", "documentation": "@roblox/globaltype/TestService.Check/param/2" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Check/param/3" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Check/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Check", "code_sample": "" }, "@roblox/globaltype/TestService.Checkpoint/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Checkpoint/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Checkpoint/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Checkpoint/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Checkpoint": { "documentation": "Prints Test checkpoint: followed by a string to the output in blue text.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Checkpoint/param/0" }, { "name": "text", "documentation": "@roblox/globaltype/TestService.Checkpoint/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Checkpoint/param/2" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Checkpoint/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Checkpoint", "code_sample": "" }, "@roblox/globaltype/TestService.Done/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Done": { "documentation": "Prints Testing Done to the output in blue text.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Done/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Done", "code_sample": "" }, "@roblox/globaltype/TestService.Error/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Error/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Error/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Error/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Error": { "documentation": "Prints a red error message to the output, prefixed by TestService:.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Error/param/0" }, { "name": "description", "documentation": "@roblox/globaltype/TestService.Error/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Error/param/2" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Error/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Error", "code_sample": "" }, "@roblox/globaltype/TestService.Fail/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Fail/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Fail/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Fail/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Fail": { "documentation": "Indicates a fatal error in a TestService run.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Fail/param/0" }, { "name": "description", "documentation": "@roblox/globaltype/TestService.Fail/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Fail/param/2" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Fail/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Fail", "code_sample": "" }, "@roblox/globaltype/TestService.isFeatureEnabled/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.isFeatureEnabled/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.isFeatureEnabled/return/0": { "documentation": "" }, "@roblox/globaltype/TestService.isFeatureEnabled": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.isFeatureEnabled/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/TestService.isFeatureEnabled/param/1" } ], "returns": [ "@roblox/globaltype/TestService.isFeatureEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#isFeatureEnabled", "code_sample": "" }, "@roblox/globaltype/TestService.Message/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Message/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Message/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Message/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Message": { "documentation": "Prints TestService: followed by a string to the output in blue text.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Message/param/0" }, { "name": "text", "documentation": "@roblox/globaltype/TestService.Message/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Message/param/2" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Message/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Message", "code_sample": "" }, "@roblox/globaltype/TestService.Require/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Require/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Require/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Require/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Require/param/4": { "documentation": "" }, "@roblox/globaltype/TestService.Require": { "documentation": "Prints whether a condition is true along with a description string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Require/param/0" }, { "name": "condition", "documentation": "@roblox/globaltype/TestService.Require/param/1" }, { "name": "description", "documentation": "@roblox/globaltype/TestService.Require/param/2" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Require/param/3" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Require/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Require", "code_sample": "" }, "@roblox/globaltype/TestService.RunAsync/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.RunAsync": { "documentation": "Runs scripts which are parented to TestService.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.RunAsync/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#RunAsync", "code_sample": "" }, "@roblox/globaltype/TestService.Run/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Run": { "documentation": "Deprecated:
Runs scripts which are parented to TestService.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Run/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Run", "code_sample": "" }, "@roblox/globaltype/TestService.ScopeTime/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.ScopeTime/return/0": { "documentation": "" }, "@roblox/globaltype/TestService.ScopeTime": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ScopeTime/param/0" } ], "returns": [ "@roblox/globaltype/TestService.ScopeTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#ScopeTime", "code_sample": "" }, "@roblox/globaltype/TestService.TakeSnapshot/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.TakeSnapshot/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.TakeSnapshot": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.TakeSnapshot/param/0" }, { "name": "snapshotname", "documentation": "@roblox/globaltype/TestService.TakeSnapshot/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot", "code_sample": "" }, "@roblox/globaltype/TestService.Warn/param/0": { "documentation": "A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree." }, "@roblox/globaltype/TestService.Warn/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.Warn/param/2": { "documentation": "" }, "@roblox/globaltype/TestService.Warn/param/3": { "documentation": "" }, "@roblox/globaltype/TestService.Warn/param/4": { "documentation": "" }, "@roblox/globaltype/TestService.Warn": { "documentation": "Prints if a condition is true, otherwise prints a warning.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.Warn/param/0" }, { "name": "condition", "documentation": "@roblox/globaltype/TestService.Warn/param/1" }, { "name": "description", "documentation": "@roblox/globaltype/TestService.Warn/param/2" }, { "name": "source", "documentation": "@roblox/globaltype/TestService.Warn/param/3" }, { "name": "line", "documentation": "@roblox/globaltype/TestService.Warn/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#Warn", "code_sample": "" }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectConditionalResult.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectConditionalResult": { "documentation": "Fires when the server should collect a conditional test result.", "keys": { "Connect": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Connect", "ConnectParallel": "@roblox/globaltype/TestService.ServerCollectConditionalResult.ConnectParallel", "Once": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Once", "Wait": "@roblox/globaltype/TestService.ServerCollectConditionalResult.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#ServerCollectConditionalResult", "code_sample": "" }, "@roblox/globaltype/TestService.ServerCollectResult.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectResult.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.ServerCollectResult.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectResult.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectResult.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.ServerCollectResult.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectResult.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectResult.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TestService.ServerCollectResult.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectResult.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TestService.ServerCollectResult.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TestService.ServerCollectResult.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TestService.ServerCollectResult": { "documentation": "Fires when the server should collect a test result.", "keys": { "Connect": "@roblox/globaltype/TestService.ServerCollectResult.Connect", "ConnectParallel": "@roblox/globaltype/TestService.ServerCollectResult.ConnectParallel", "Once": "@roblox/globaltype/TestService.ServerCollectResult.Once", "Wait": "@roblox/globaltype/TestService.ServerCollectResult.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TestService#ServerCollectResult", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem": { "documentation": "Acts as abstract properties for generic information about Classes, Members, Enums, and EnumItems.", "keys": { "Browsable": "@roblox/globaltype/ReflectionMetadataItem.Browsable", "ClassCategory": "@roblox/globaltype/ReflectionMetadataItem.ClassCategory", "ClientOnly": "@roblox/globaltype/ReflectionMetadataItem.ClientOnly", "Constraint": "@roblox/globaltype/ReflectionMetadataItem.Constraint", "Deprecated": "@roblox/globaltype/ReflectionMetadataItem.Deprecated", "EditingDisabled": "@roblox/globaltype/ReflectionMetadataItem.EditingDisabled", "EditorType": "@roblox/globaltype/ReflectionMetadataItem.EditorType", "FFlag": "@roblox/globaltype/ReflectionMetadataItem.FFlag", "IsBackend": "@roblox/globaltype/ReflectionMetadataItem.IsBackend", "PropertyOrder": "@roblox/globaltype/ReflectionMetadataItem.PropertyOrder", "ScriptContext": "@roblox/globaltype/ReflectionMetadataItem.ScriptContext", "ServerOnly": "@roblox/globaltype/ReflectionMetadataItem.ServerOnly", "SliderScaling": "@roblox/globaltype/ReflectionMetadataItem.SliderScaling", "UIMaximum": "@roblox/globaltype/ReflectionMetadataItem.UIMaximum", "UIMinimum": "@roblox/globaltype/ReflectionMetadataItem.UIMinimum", "UINumTicks": "@roblox/globaltype/ReflectionMetadataItem.UINumTicks" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.Browsable": { "documentation": "Whether or not this can be seen in studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#Browsable", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.ClassCategory": { "documentation": "Describes the category of this class.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#ClassCategory", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.ClientOnly": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#ClientOnly", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.Constraint": { "documentation": "Describes a constraint for a single-argument function whose argument type is a Object.ClassName.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#Constraint", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.Deprecated": { "documentation": "Whether or not this item is deprecated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#Deprecated", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.EditingDisabled": { "documentation": "Toggles whether this property can be edited from the Properties window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#EditingDisabled", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.EditorType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#EditorType", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.FFlag": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#FFlag", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.IsBackend": { "documentation": "Vague value for showing if this depends on backend stuff.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#IsBackend", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.PropertyOrder": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#PropertyOrder", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.ScriptContext": { "documentation": "Describes the context where this member can be used. If set to \"Server\", this member will not be available to auto fill when editing a LocalScript. If set to \"Client\", this member will not be available to auto fill when editing a Script.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#ScriptContext", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.ServerOnly": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#ServerOnly", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.SliderScaling": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#SliderScaling", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.UIMaximum": { "documentation": "The maximum value of this property. Used with ReflectionMetadataItem.UIMinimum to control the slider bar of this property in the Properties window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#UIMaximum", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.UIMinimum": { "documentation": "The minimum value of this property. Used with ReflectionMetadataItem.UIMaximum to control the slider bar of this property in the Properties window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#UIMinimum", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataItem.UINumTicks": { "documentation": "The number of potential values the property's slider bar can be set to, ReflectionMetadataItem.UIMinimum and ReflectionMetadataItem.UIMaximum.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataItem#UINumTicks", "code_sample": "" }, "@roblox/globaltype/MLService": { "documentation": "", "keys": { "CreateSessionAsync": "@roblox/globaltype/MLService.CreateSessionAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MLService", "code_sample": "" }, "@roblox/globaltype/MLService.CreateSessionAsync/param/0": { "documentation": "" }, "@roblox/globaltype/MLService.CreateSessionAsync/param/1": { "documentation": "" }, "@roblox/globaltype/MLService.CreateSessionAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MLService.CreateSessionAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MLService.CreateSessionAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/MLService.CreateSessionAsync/param/1" } ], "returns": [ "@roblox/globaltype/MLService.CreateSessionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MLService#CreateSessionAsync", "code_sample": "" }, "@roblox/globaltype/AudioPages": { "documentation": "A special version of the Pages class returned by AssetService:SearchAudioAsync().", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPages", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataFunctions": { "documentation": "Acts as a Folder containing information about functions for a ReflectionMetadataClass, and should be parented to it. ReflectionMetadataMembers that are parented to this object will be perceived as functions under the class this is parented to.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataFunctions", "code_sample": "" }, "@roblox/globaltype/UserSettings": { "documentation": "A singleton object that houses basic user settings, which persist across all games on Roblox.", "keys": { "IsUserFeatureEnabled": "@roblox/globaltype/UserSettings.IsUserFeatureEnabled", "Reset": "@roblox/globaltype/UserSettings.Reset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserSettings", "code_sample": "if UserSettings():IsUserFeatureEnabled(\"UserNoCameraClickToMove\") then\n\tprint(\"'ClickToMove' should no longer be loaded from the CameraScript!\")\nelse\n\tprint(\"'ClickToMove' is still loaded from the CameraScript!\")\nend" }, "@roblox/globaltype/UserSettings.IsUserFeatureEnabled/param/0": { "documentation": "A singleton object that houses basic user settings, which persist across all games on Roblox." }, "@roblox/globaltype/UserSettings.IsUserFeatureEnabled/param/1": { "documentation": "" }, "@roblox/globaltype/UserSettings.IsUserFeatureEnabled/return/0": { "documentation": "" }, "@roblox/globaltype/UserSettings.IsUserFeatureEnabled": { "documentation": "Returns true if the specified user feature is enabled. This will throw an error if the user feature does not exist.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserSettings.IsUserFeatureEnabled/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/UserSettings.IsUserFeatureEnabled/param/1" } ], "returns": [ "@roblox/globaltype/UserSettings.IsUserFeatureEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserSettings#IsUserFeatureEnabled", "code_sample": "if UserSettings():IsUserFeatureEnabled(\"UserNoCameraClickToMove\") then\n\tprint(\"'ClickToMove' should no longer be loaded from the CameraScript!\")\nelse\n\tprint(\"'ClickToMove' is still loaded from the CameraScript!\")\nend" }, "@roblox/globaltype/UserSettings.Reset/param/0": { "documentation": "A singleton object that houses basic user settings, which persist across all games on Roblox." }, "@roblox/globaltype/UserSettings.Reset": { "documentation": "Erases the saved state of the UserSettings, and restores its default values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserSettings.Reset/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserSettings#Reset", "code_sample": "" }, "@roblox/globaltype/RemoteDebuggerServer": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteDebuggerServer", "code_sample": "" }, "@roblox/globaltype/TeleportAsyncResult": { "documentation": "The return structure of the TeleportAsync function call.", "keys": { "PrivateServerId": "@roblox/globaltype/TeleportAsyncResult.PrivateServerId", "ReservedServerAccessCode": "@roblox/globaltype/TeleportAsyncResult.ReservedServerAccessCode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportAsyncResult", "code_sample": "" }, "@roblox/globaltype/TeleportAsyncResult.PrivateServerId": { "documentation": "The private server ID of the reserved server that the players are being teleported to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportAsyncResult#PrivateServerId", "code_sample": "" }, "@roblox/globaltype/TeleportAsyncResult.ReservedServerAccessCode": { "documentation": "The access code of the reserved server that the players are being teleported to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportAsyncResult#ReservedServerAccessCode", "code_sample": "" }, "@roblox/globaltype/DataStoreListingPages": { "documentation": "A special type of Pages object whose pages contain DataStoreInfo instances.", "keys": { "Cursor": "@roblox/globaltype/DataStoreListingPages.Cursor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreListingPages", "code_sample": "" }, "@roblox/globaltype/DataStoreListingPages.Cursor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreListingPages#Cursor", "code_sample": "" }, "@roblox/globaltype/Script": { "documentation": "An object that contains and runs Luau code on the server.", "keys": { "Source": "@roblox/globaltype/Script.Source" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Script", "code_sample": "" }, "@roblox/globaltype/Script.Source": { "documentation": "The code to be executed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Script#Source", "code_sample": "" }, "@roblox/globaltype/SphereHandleAdornment": { "documentation": "A sphere-shaped handle that can be adorned to a BasePart.", "keys": { "Radius": "@roblox/globaltype/SphereHandleAdornment.Radius", "Shading": "@roblox/globaltype/SphereHandleAdornment.Shading" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SphereHandleAdornment", "code_sample": "" }, "@roblox/globaltype/SphereHandleAdornment.Radius": { "documentation": "Radius of the sphere adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SphereHandleAdornment#Radius", "code_sample": "" }, "@roblox/globaltype/SphereHandleAdornment.Shading": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SphereHandleAdornment#Shading", "code_sample": "" }, "@roblox/globaltype/PointsService": { "documentation": "Deprecated: This class was once used to control an ancient achievement system since removed and deprecated. It and its members should not be used in new work.
This service controls the points award system used to showcase a player's achievements and participation throughout Roblox.", "keys": { "AwardPoints": "@roblox/globaltype/PointsService.AwardPoints", "GetAwardablePoints": "@roblox/globaltype/PointsService.GetAwardablePoints", "GetGamePointBalance": "@roblox/globaltype/PointsService.GetGamePointBalance", "GetPointBalance": "@roblox/globaltype/PointsService.GetPointBalance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointsService", "code_sample": "" }, "@roblox/globaltype/PointsService.AwardPoints/param/0": { "documentation": "Deprecated: This class was once used to control an ancient achievement system since removed and deprecated. It and its members should not be used in new work.
This service controls the points award system used to showcase a player's achievements and participation throughout Roblox." }, "@roblox/globaltype/PointsService.AwardPoints/param/1": { "documentation": "" }, "@roblox/globaltype/PointsService.AwardPoints/param/2": { "documentation": "" }, "@roblox/globaltype/PointsService.AwardPoints/return/0": { "documentation": "" }, "@roblox/globaltype/PointsService.AwardPoints": { "documentation": "Deprecated: This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
Attempts to award the user with the specified Player.UserId the specified number of points.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.AwardPoints/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/PointsService.AwardPoints/param/1" }, { "name": "amount", "documentation": "@roblox/globaltype/PointsService.AwardPoints/param/2" } ], "returns": [ "@roblox/globaltype/PointsService.AwardPoints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointsService#AwardPoints", "code_sample": "" }, "@roblox/globaltype/PointsService.GetAwardablePoints/param/0": { "documentation": "Deprecated: This class was once used to control an ancient achievement system since removed and deprecated. It and its members should not be used in new work.
This service controls the points award system used to showcase a player's achievements and participation throughout Roblox." }, "@roblox/globaltype/PointsService.GetAwardablePoints/return/0": { "documentation": "" }, "@roblox/globaltype/PointsService.GetAwardablePoints": { "documentation": "Deprecated: This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
Returns the number of points the current game has available to award to players.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.GetAwardablePoints/param/0" } ], "returns": [ "@roblox/globaltype/PointsService.GetAwardablePoints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointsService#GetAwardablePoints", "code_sample": "" }, "@roblox/globaltype/PointsService.GetGamePointBalance/param/0": { "documentation": "Deprecated: This class was once used to control an ancient achievement system since removed and deprecated. It and its members should not be used in new work.
This service controls the points award system used to showcase a player's achievements and participation throughout Roblox." }, "@roblox/globaltype/PointsService.GetGamePointBalance/param/1": { "documentation": "" }, "@roblox/globaltype/PointsService.GetGamePointBalance/return/0": { "documentation": "" }, "@roblox/globaltype/PointsService.GetGamePointBalance": { "documentation": "Deprecated: This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
Returns the total number of points a player has in the current game.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.GetGamePointBalance/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/PointsService.GetGamePointBalance/param/1" } ], "returns": [ "@roblox/globaltype/PointsService.GetGamePointBalance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointsService#GetGamePointBalance", "code_sample": "" }, "@roblox/globaltype/PointsService.GetPointBalance/param/0": { "documentation": "Deprecated: This class was once used to control an ancient achievement system since removed and deprecated. It and its members should not be used in new work.
This service controls the points award system used to showcase a player's achievements and participation throughout Roblox." }, "@roblox/globaltype/PointsService.GetPointBalance/param/1": { "documentation": "" }, "@roblox/globaltype/PointsService.GetPointBalance/return/0": { "documentation": "" }, "@roblox/globaltype/PointsService.GetPointBalance": { "documentation": "Deprecated: This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
Returns the total number of points the given player has across all games.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.GetPointBalance/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/PointsService.GetPointBalance/param/1" } ], "returns": [ "@roblox/globaltype/PointsService.GetPointBalance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointsService#GetPointBalance", "code_sample": "" }, "@roblox/globaltype/PointsService.PointsAwarded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PointsService.PointsAwarded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PointsService.PointsAwarded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PointsService.PointsAwarded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PointsService.PointsAwarded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PointsService.PointsAwarded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PointsService.PointsAwarded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PointsService.PointsAwarded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PointsService.PointsAwarded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PointsService.PointsAwarded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PointsService.PointsAwarded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PointsService.PointsAwarded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PointsService.PointsAwarded": { "documentation": "Fires when points have been successfully awarded to a player, while also passing along the updated balance of points the player has in the current game and all games.", "keys": { "Connect": "@roblox/globaltype/PointsService.PointsAwarded.Connect", "ConnectParallel": "@roblox/globaltype/PointsService.PointsAwarded.ConnectParallel", "Once": "@roblox/globaltype/PointsService.PointsAwarded.Once", "Wait": "@roblox/globaltype/PointsService.PointsAwarded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointsService#PointsAwarded", "code_sample": "" }, "@roblox/globaltype/GlobalDataStore": { "documentation": "An object that exposes methods to access a single data store.", "keys": { "GetAsync": "@roblox/globaltype/GlobalDataStore.GetAsync", "IncrementAsync": "@roblox/globaltype/GlobalDataStore.IncrementAsync", "OnUpdate": "@roblox/globaltype/GlobalDataStore.OnUpdate", "RemoveAsync": "@roblox/globaltype/GlobalDataStore.RemoveAsync", "SetAsync": "@roblox/globaltype/GlobalDataStore.SetAsync", "UpdateAsync": "@roblox/globaltype/GlobalDataStore.UpdateAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore", "code_sample": "" }, "@roblox/globaltype/GlobalDataStore.GetAsync/param/0": { "documentation": "An object that exposes methods to access a single data store." }, "@roblox/globaltype/GlobalDataStore.GetAsync/param/1": { "documentation": "The key name for which the value is requested. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/GlobalDataStore.GetAsync/param/2": { "documentation": "" }, "@roblox/globaltype/GlobalDataStore.GetAsync/return/0": { "documentation": "The value of the entry in the data store with the given key and a DataStoreKeyInfo instance that includes the version number, date and time the version was created, and functions to retrieve UserIds and metadata." }, "@roblox/globaltype/GlobalDataStore.GetAsync": { "documentation": "Returns the value of a key in a specified data store and a DataStoreKeyInfo instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalDataStore.GetAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/GlobalDataStore.GetAsync/param/1" }, { "name": "options", "documentation": "@roblox/globaltype/GlobalDataStore.GetAsync/param/2" } ], "returns": [ "@roblox/globaltype/GlobalDataStore.GetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#GetAsync", "code_sample": "" }, "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/0": { "documentation": "An object that exposes methods to access a single data store." }, "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/1": { "documentation": "Key name for which the value should be updated. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/2": { "documentation": "Amount to increment the current value by." }, "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/3": { "documentation": "(Optional) A table of UserIds to associate with the key." }, "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/4": { "documentation": "(Optional) DataStoreIncrementOptions instance that combines multiple additional parameters as custom metadata and allows for future extensibility." }, "@roblox/globaltype/GlobalDataStore.IncrementAsync/return/0": { "documentation": "The updated value of the entry in the data store with the given key." }, "@roblox/globaltype/GlobalDataStore.IncrementAsync": { "documentation": "Increments the value of a key by the provided amount (both must be integers).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/1" }, { "name": "delta", "documentation": "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/2" }, { "name": "userIds", "documentation": "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/3" }, { "name": "options", "documentation": "@roblox/globaltype/GlobalDataStore.IncrementAsync/param/4" } ], "returns": [ "@roblox/globaltype/GlobalDataStore.IncrementAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#IncrementAsync", "code_sample": "" }, "@roblox/globaltype/GlobalDataStore.OnUpdate/param/0": { "documentation": "An object that exposes methods to access a single data store." }, "@roblox/globaltype/GlobalDataStore.OnUpdate/param/1": { "documentation": "The key identifying the entry being retrieved from the data store." }, "@roblox/globaltype/GlobalDataStore.OnUpdate/param/2": { "documentation": "The function to be executed any time the value associated with key is changed." }, "@roblox/globaltype/GlobalDataStore.OnUpdate/return/0": { "documentation": "The connection to the key being tracked for updates." }, "@roblox/globaltype/GlobalDataStore.OnUpdate": { "documentation": "Deprecated: This function has been deprecated and should not be used in new work. You can use the Cross Server Messaging Service to publish and subscribe to topics to receive near real-time updates, completely replacing the need for this function.
Sets a callback function to be executed any time the value associated with a key is changed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalDataStore.OnUpdate/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/GlobalDataStore.OnUpdate/param/1" }, { "name": "callback", "documentation": "@roblox/globaltype/GlobalDataStore.OnUpdate/param/2" } ], "returns": [ "@roblox/globaltype/GlobalDataStore.OnUpdate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#OnUpdate", "code_sample": "local DataStoreService = game:GetService(\"DataStoreService\")\n\nlocal sampleDataStore = DataStoreService:GetDataStore(\"MyDataStore\")\n\nlocal connection\n\nlocal function printOut(input)\n\tprint(input)\n\tconnection:Disconnect()\nend\n\nconnection = sampleDataStore:OnUpdate(\"myKey\", printOut)\n\nlocal success, result = pcall(function()\n\tsampleDataStore:SetAsync(\"myKey\", 11)\nend)\n\nif not success then\n\twarn(result)\nend" }, "@roblox/globaltype/GlobalDataStore.RemoveAsync/param/0": { "documentation": "An object that exposes methods to access a single data store." }, "@roblox/globaltype/GlobalDataStore.RemoveAsync/param/1": { "documentation": "Key name to be removed. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/GlobalDataStore.RemoveAsync/return/0": { "documentation": "The value of the data store prior to deletion and a DataStoreKeyInfo instance that includes the version number, date and time the version was created, and functions to retrieve UserIds and metadata." }, "@roblox/globaltype/GlobalDataStore.RemoveAsync": { "documentation": "Removes the specified key while also retaining an accessible version.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalDataStore.RemoveAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/GlobalDataStore.RemoveAsync/param/1" } ], "returns": [ "@roblox/globaltype/GlobalDataStore.RemoveAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#RemoveAsync", "code_sample": "" }, "@roblox/globaltype/GlobalDataStore.SetAsync/param/0": { "documentation": "An object that exposes methods to access a single data store." }, "@roblox/globaltype/GlobalDataStore.SetAsync/param/1": { "documentation": "Key name for which the value should be set. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/GlobalDataStore.SetAsync/param/2": { "documentation": "The value that the data store key will be set to." }, "@roblox/globaltype/GlobalDataStore.SetAsync/param/3": { "documentation": "Table of UserIds, highly recommended to assist with GDPR tracking/removal." }, "@roblox/globaltype/GlobalDataStore.SetAsync/param/4": { "documentation": "(Optional) DataStoreSetOptions instance that allows for metadata specification on the key." }, "@roblox/globaltype/GlobalDataStore.SetAsync/return/0": { "documentation": "The version identifier of the newly created version. It can be used to retrieve key info using GetVersionAsync() or to remove it using RemoveVersionAsync()." }, "@roblox/globaltype/GlobalDataStore.SetAsync": { "documentation": "Sets the value of the data store for the given key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalDataStore.SetAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/GlobalDataStore.SetAsync/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/GlobalDataStore.SetAsync/param/2" }, { "name": "userIds", "documentation": "@roblox/globaltype/GlobalDataStore.SetAsync/param/3" }, { "name": "options", "documentation": "@roblox/globaltype/GlobalDataStore.SetAsync/param/4" } ], "returns": [ "@roblox/globaltype/GlobalDataStore.SetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#SetAsync", "code_sample": "" }, "@roblox/globaltype/GlobalDataStore.UpdateAsync/param/0": { "documentation": "An object that exposes methods to access a single data store." }, "@roblox/globaltype/GlobalDataStore.UpdateAsync/param/1": { "documentation": "Key name for which the value should be updated. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/GlobalDataStore.UpdateAsync/param/2": { "documentation": "Transform function that takes the current value and DataStoreKeyInfo as parameters and returns the new value along with optional UserIds and metadata." }, "@roblox/globaltype/GlobalDataStore.UpdateAsync/return/0": { "documentation": "The updated value of the entry in the data store with the given key and a DataStoreKeyInfo instance that includes the version number, date and time the version was created, and functions to retrieve UserIds and metadata." }, "@roblox/globaltype/GlobalDataStore.UpdateAsync": { "documentation": "Updates a key's value with a new value from the specified callback function.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalDataStore.UpdateAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/GlobalDataStore.UpdateAsync/param/1" }, { "name": "transformFunction", "documentation": "@roblox/globaltype/GlobalDataStore.UpdateAsync/param/2" } ], "returns": [ "@roblox/globaltype/GlobalDataStore.UpdateAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalDataStore#UpdateAsync", "code_sample": "" }, "@roblox/globaltype/UIDragDetector": { "documentation": "Instance which facilitates and encourages interaction with UI elements in an experience.", "keys": { "ActivatedCursorIcon": "@roblox/globaltype/UIDragDetector.ActivatedCursorIcon", "ActivatedCursorIconContent": "@roblox/globaltype/UIDragDetector.ActivatedCursorIconContent", "BoundingBehavior": "@roblox/globaltype/UIDragDetector.BoundingBehavior", "BoundingUI": "@roblox/globaltype/UIDragDetector.BoundingUI", "CursorIcon": "@roblox/globaltype/UIDragDetector.CursorIcon", "CursorIconContent": "@roblox/globaltype/UIDragDetector.CursorIconContent", "DragAxis": "@roblox/globaltype/UIDragDetector.DragAxis", "DragRelativity": "@roblox/globaltype/UIDragDetector.DragRelativity", "DragRotation": "@roblox/globaltype/UIDragDetector.DragRotation", "DragSpace": "@roblox/globaltype/UIDragDetector.DragSpace", "DragStyle": "@roblox/globaltype/UIDragDetector.DragStyle", "DragUDim2": "@roblox/globaltype/UIDragDetector.DragUDim2", "Enabled": "@roblox/globaltype/UIDragDetector.Enabled", "MaxDragAngle": "@roblox/globaltype/UIDragDetector.MaxDragAngle", "MaxDragTranslation": "@roblox/globaltype/UIDragDetector.MaxDragTranslation", "MinDragAngle": "@roblox/globaltype/UIDragDetector.MinDragAngle", "MinDragTranslation": "@roblox/globaltype/UIDragDetector.MinDragTranslation", "ReferenceUIInstance": "@roblox/globaltype/UIDragDetector.ReferenceUIInstance", "ResponseStyle": "@roblox/globaltype/UIDragDetector.ResponseStyle", "SelectionModeDragSpeed": "@roblox/globaltype/UIDragDetector.SelectionModeDragSpeed", "SelectionModeRotateSpeed": "@roblox/globaltype/UIDragDetector.SelectionModeRotateSpeed", "UIDragSpeedAxisMapping": "@roblox/globaltype/UIDragDetector.UIDragSpeedAxisMapping", "AddConstraintFunction": "@roblox/globaltype/UIDragDetector.AddConstraintFunction", "GetReferencePosition": "@roblox/globaltype/UIDragDetector.GetReferencePosition", "GetReferenceRotation": "@roblox/globaltype/UIDragDetector.GetReferenceRotation", "SetDragStyleFunction": "@roblox/globaltype/UIDragDetector.SetDragStyleFunction" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.ActivatedCursorIcon": { "documentation": "Sets the cursor icon to display when the mouse is activated over the parent of this UIDragDetector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ActivatedCursorIcon", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.ActivatedCursorIconContent": { "documentation": "Sets the cursor icon to display when the mouse is activated over the parent of this UIDragDetector. Only supports asset URIs", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ActivatedCursorIconContent", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.BoundingBehavior": { "documentation": "Determines bounding behavior of the dragged UI object when the detector's BoundingUI is set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#BoundingBehavior", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.BoundingUI": { "documentation": "Instance whose bounding area defines the drag boundaries for the parent GuiObject.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#BoundingUI", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.CursorIcon": { "documentation": "Sets the cursor icon to display when the mouse is hovered over the parent of this UIDragDetector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#CursorIcon", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.CursorIconContent": { "documentation": "Sets the cursor icon to display when the mouse is hovered over the parent of this UIDragDetector. Only asset URIs are supported.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#CursorIconContent", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragAxis": { "documentation": "The drag axis for the UIDragDetector instance when DragStyle is set to UIDragDetectorDragStyle.TranslateLine.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragAxis", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragRelativity": { "documentation": "Sets the paradigm which defines the relativity of inputs/outputs from a custom drag function.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragRelativity", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragRotation": { "documentation": "The rotation performed by the current drag.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragRotation", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragSpace": { "documentation": "Sets the paradigm which defines the space of inputs/outputs from a custom drag function.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragSpace", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragStyle": { "documentation": "The paradigm used to generate proposed motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragStyle", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragUDim2": { "documentation": "The translation performed by the current drag expressed in a UDim2 value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragUDim2", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.Enabled": { "documentation": "Whether the UIDragDetector responds to user input.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#Enabled", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.MaxDragAngle": { "documentation": "Along with MinDragAngle, impedes the detector's attempts to generate rotational motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#MaxDragAngle", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.MaxDragTranslation": { "documentation": "Along with MinDragTranslation, impedes the detector's attempts to generate linear/planar motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#MaxDragTranslation", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.MinDragAngle": { "documentation": "Along with MaxDragAngle, impedes the detector's attempts to generate rotational motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#MinDragAngle", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.MinDragTranslation": { "documentation": "Along with MaxDragTranslation, impedes the detector's attempts to generate linear/planar motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#MinDragTranslation", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.ReferenceUIInstance": { "documentation": "A GuiObject instance whose local space and absolute center position is the reference space and origin for the detector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ReferenceUIInstance", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.ResponseStyle": { "documentation": "The paradigm used to define the response to proposed motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#ResponseStyle", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.SelectionModeDragSpeed": { "documentation": "Maximum drag speed for translation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#SelectionModeDragSpeed", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.SelectionModeRotateSpeed": { "documentation": "Maximum angle per second the UIDragDetector can rotate at.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#SelectionModeRotateSpeed", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.UIDragSpeedAxisMapping": { "documentation": "UIDragSpeedAxisMapping value that determines the X/Y dimension dragging speeds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#UIDragSpeedAxisMapping", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.AddConstraintFunction/param/0": { "documentation": "Instance which facilitates and encourages interaction with UI elements in an experience." }, "@roblox/globaltype/UIDragDetector.AddConstraintFunction/param/1": { "documentation": "The order of priority for functions added via this method. Higher values take precedence over lower values." }, "@roblox/globaltype/UIDragDetector.AddConstraintFunction/param/2": { "documentation": "Function for modifying or constraining proposed motion. This function takes in input UDim2 and float of proposed motion and returns a UDim2 and float of modified or unmodified motion. It can optionally return an UIDragDetectorDragRelativity and UIDragDetectorDragSpace as the third and fourth return values as output overrides." }, "@roblox/globaltype/UIDragDetector.AddConstraintFunction/return/0": { "documentation": "Use this connection object to remove the constraint function." }, "@roblox/globaltype/UIDragDetector.AddConstraintFunction": { "documentation": "Adds a function to modify or constrain proposed motion.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.AddConstraintFunction/param/0" }, { "name": "priority", "documentation": "@roblox/globaltype/UIDragDetector.AddConstraintFunction/param/1" }, { "name": "function", "documentation": "@roblox/globaltype/UIDragDetector.AddConstraintFunction/param/2" } ], "returns": [ "@roblox/globaltype/UIDragDetector.AddConstraintFunction/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#AddConstraintFunction", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.GetReferencePosition/param/0": { "documentation": "Instance which facilitates and encourages interaction with UI elements in an experience." }, "@roblox/globaltype/UIDragDetector.GetReferencePosition/return/0": { "documentation": "UDim2 position of the current drag's reference element." }, "@roblox/globaltype/UIDragDetector.GetReferencePosition": { "documentation": "Returns the reference UDim2 position of the current drag's reference origin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.GetReferencePosition/param/0" } ], "returns": [ "@roblox/globaltype/UIDragDetector.GetReferencePosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#GetReferencePosition", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.GetReferenceRotation/param/0": { "documentation": "Instance which facilitates and encourages interaction with UI elements in an experience." }, "@roblox/globaltype/UIDragDetector.GetReferenceRotation/return/0": { "documentation": "Rotation of the current drag's reference element." }, "@roblox/globaltype/UIDragDetector.GetReferenceRotation": { "documentation": "Returns the reference rotation of the current drag's reference element.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.GetReferenceRotation/param/0" } ], "returns": [ "@roblox/globaltype/UIDragDetector.GetReferenceRotation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#GetReferenceRotation", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.SetDragStyleFunction/param/0": { "documentation": "Instance which facilitates and encourages interaction with UI elements in an experience." }, "@roblox/globaltype/UIDragDetector.SetDragStyleFunction/param/1": { "documentation": "Function for monitoring DragContinue signals. This function receives the signal's screen space input position and returns a UDim2 and float containing the desired motion of the drag in the desired space and relativity. If this function returns nil, the object will not be moved." }, "@roblox/globaltype/UIDragDetector.SetDragStyleFunction": { "documentation": "Passes a function to be used if and only if DragStyle is set to UIDragDetectorDragStyle.Scriptable.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.SetDragStyleFunction/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/UIDragDetector.SetDragStyleFunction/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#SetDragStyleFunction", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragContinue.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragContinue.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragContinue.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragContinue.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragContinue.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragContinue.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragContinue.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragContinue.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragContinue.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragContinue.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragContinue.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragContinue.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragContinue": { "documentation": "Fires when a user continues dragging the UI element after DragStart has been initiated.", "keys": { "Connect": "@roblox/globaltype/UIDragDetector.DragContinue.Connect", "ConnectParallel": "@roblox/globaltype/UIDragDetector.DragContinue.ConnectParallel", "Once": "@roblox/globaltype/UIDragDetector.DragContinue.Once", "Wait": "@roblox/globaltype/UIDragDetector.DragContinue.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragContinue", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragEnd.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragEnd.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragEnd.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragEnd.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragEnd.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragEnd.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragEnd.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragEnd.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragEnd.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragEnd.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragEnd.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragEnd.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragEnd": { "documentation": "Fires when a user stops dragging the UI element.", "keys": { "Connect": "@roblox/globaltype/UIDragDetector.DragEnd.Connect", "ConnectParallel": "@roblox/globaltype/UIDragDetector.DragEnd.ConnectParallel", "Once": "@roblox/globaltype/UIDragDetector.DragEnd.Once", "Wait": "@roblox/globaltype/UIDragDetector.DragEnd.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragEnd", "code_sample": "" }, "@roblox/globaltype/UIDragDetector.DragStart.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragStart.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragStart.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragStart.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragStart.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragStart.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragStart.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragStart.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UIDragDetector.DragStart.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragStart.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIDragDetector.DragStart.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIDragDetector.DragStart.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UIDragDetector.DragStart": { "documentation": "Fires when a user starts dragging the UI element.", "keys": { "Connect": "@roblox/globaltype/UIDragDetector.DragStart.Connect", "ConnectParallel": "@roblox/globaltype/UIDragDetector.DragStart.ConnectParallel", "Once": "@roblox/globaltype/UIDragDetector.DragStart.Once", "Wait": "@roblox/globaltype/UIDragDetector.DragStart.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIDragDetector#DragStart", "code_sample": "" }, "@roblox/globaltype/Camera": { "documentation": "A class which defines a view of the 3D world.", "keys": { "CameraSubject": "@roblox/globaltype/Camera.CameraSubject", "CameraType": "@roblox/globaltype/Camera.CameraType", "CFrame": "@roblox/globaltype/Camera.CFrame", "CoordinateFrame": "@roblox/globaltype/Camera.CoordinateFrame", "DiagonalFieldOfView": "@roblox/globaltype/Camera.DiagonalFieldOfView", "FieldOfView": "@roblox/globaltype/Camera.FieldOfView", "FieldOfViewMode": "@roblox/globaltype/Camera.FieldOfViewMode", "Focus": "@roblox/globaltype/Camera.Focus", "focus": "@roblox/globaltype/Camera.focus", "HeadLocked": "@roblox/globaltype/Camera.HeadLocked", "HeadScale": "@roblox/globaltype/Camera.HeadScale", "MaxAxisFieldOfView": "@roblox/globaltype/Camera.MaxAxisFieldOfView", "NearPlaneZ": "@roblox/globaltype/Camera.NearPlaneZ", "ViewportSize": "@roblox/globaltype/Camera.ViewportSize", "VRTiltAndRollEnabled": "@roblox/globaltype/Camera.VRTiltAndRollEnabled", "GetLargestCutoffDistance": "@roblox/globaltype/Camera.GetLargestCutoffDistance", "GetPanSpeed": "@roblox/globaltype/Camera.GetPanSpeed", "GetPartsObscuringTarget": "@roblox/globaltype/Camera.GetPartsObscuringTarget", "GetRenderCFrame": "@roblox/globaltype/Camera.GetRenderCFrame", "GetRoll": "@roblox/globaltype/Camera.GetRoll", "GetTiltSpeed": "@roblox/globaltype/Camera.GetTiltSpeed", "Interpolate": "@roblox/globaltype/Camera.Interpolate", "PanUnits": "@roblox/globaltype/Camera.PanUnits", "ScreenPointToRay": "@roblox/globaltype/Camera.ScreenPointToRay", "SetCameraPanMode": "@roblox/globaltype/Camera.SetCameraPanMode", "SetRoll": "@roblox/globaltype/Camera.SetRoll", "TiltUnits": "@roblox/globaltype/Camera.TiltUnits", "ViewportPointToRay": "@roblox/globaltype/Camera.ViewportPointToRay", "WorldToScreenPoint": "@roblox/globaltype/Camera.WorldToScreenPoint", "WorldToViewportPoint": "@roblox/globaltype/Camera.WorldToViewportPoint", "ZoomToExtents": "@roblox/globaltype/Camera.ZoomToExtents" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera", "code_sample": "" }, "@roblox/globaltype/Camera.CameraSubject": { "documentation": "The Humanoid or BasePart that is the Camera subject.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#CameraSubject", "code_sample": "" }, "@roblox/globaltype/Camera.CameraType": { "documentation": "Specifies the CameraType to be read by the camera scripts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#CameraType", "code_sample": "" }, "@roblox/globaltype/Camera.CFrame": { "documentation": "The CFrame of the Camera, defining its position and orientation in the 3D world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#CFrame", "code_sample": "" }, "@roblox/globaltype/Camera.CoordinateFrame": { "documentation": "Deprecated: This item has been superseded by Camera.CFrame which should be used in all new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#CoordinateFrame", "code_sample": "" }, "@roblox/globaltype/Camera.DiagonalFieldOfView": { "documentation": "Sets the angle of the camera's diagonal field of view.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#DiagonalFieldOfView", "code_sample": "" }, "@roblox/globaltype/Camera.FieldOfView": { "documentation": "Sets the angle of the camera's vertical field of view.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfView", "code_sample": "" }, "@roblox/globaltype/Camera.FieldOfViewMode": { "documentation": "Determines the FOV value of the Camera that's invariant under viewport size changes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#FieldOfViewMode", "code_sample": "" }, "@roblox/globaltype/Camera.Focus": { "documentation": "Sets the area in 3D space that is prioritized by Roblox's graphical systems.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#Focus", "code_sample": "" }, "@roblox/globaltype/Camera.focus": { "documentation": "Deprecated: This property is a deprecated variant of Focus which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#focus", "code_sample": "" }, "@roblox/globaltype/Camera.HeadLocked": { "documentation": "Toggles whether the camera will automatically track the head motion of a player using a VR device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#HeadLocked", "code_sample": "" }, "@roblox/globaltype/Camera.HeadScale": { "documentation": "Sets the scale of the user's perspective of the world when using VR.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#HeadScale", "code_sample": "" }, "@roblox/globaltype/Camera.MaxAxisFieldOfView": { "documentation": "Sets the angle of the camera's field of view along the longest viewport axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#MaxAxisFieldOfView", "code_sample": "" }, "@roblox/globaltype/Camera.NearPlaneZ": { "documentation": "Describes the negative Z offset, in studs, of the camera's near clipping plane.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#NearPlaneZ", "code_sample": "" }, "@roblox/globaltype/Camera.ViewportSize": { "documentation": "The dimensions of the device safe area on a Roblox client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportSize", "code_sample": "" }, "@roblox/globaltype/Camera.VRTiltAndRollEnabled": { "documentation": "Toggles whether to apply tilt and roll from the CFrame property while the player is using a VR device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#VRTiltAndRollEnabled", "code_sample": "" }, "@roblox/globaltype/Camera.GetLargestCutoffDistance/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.GetLargestCutoffDistance/param/1": { "documentation": "An array of Instances to ignore. Descendants of these instances will also be ignored." }, "@roblox/globaltype/Camera.GetLargestCutoffDistance/return/0": { "documentation": "The distance, in studs, that the Camera needs to be pushed towards its Focus to ensure there are no obstructions between the Focus and CFrame of the Camera." }, "@roblox/globaltype/Camera.GetLargestCutoffDistance": { "documentation": "Deprecated:
Returns how much the Camera needs to be pushed towards its Focus in order to make sure there is no obstructions between the Focus and CFrame.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.GetLargestCutoffDistance/param/0" }, { "name": "ignoreList", "documentation": "@roblox/globaltype/Camera.GetLargestCutoffDistance/param/1" } ], "returns": [ "@roblox/globaltype/Camera.GetLargestCutoffDistance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#GetLargestCutoffDistance", "code_sample": "" }, "@roblox/globaltype/Camera.GetPanSpeed/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.GetPanSpeed/return/0": { "documentation": "The speed at which the Camera is rotating around its Focus on the Y axis." }, "@roblox/globaltype/Camera.GetPanSpeed": { "documentation": "Deprecated: This method has been deprecated and no longer works. It should not be used in new work.
Returns the current 'pan' speed of the Camera.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.GetPanSpeed/param/0" } ], "returns": [ "@roblox/globaltype/Camera.GetPanSpeed/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#GetPanSpeed", "code_sample": "" }, "@roblox/globaltype/Camera.GetPartsObscuringTarget/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.GetPartsObscuringTarget/param/1": { "documentation": "An array of Vector3 positions of cast points." }, "@roblox/globaltype/Camera.GetPartsObscuringTarget/param/2": { "documentation": "An array of Instances that should be ignored, along with their descendants." }, "@roblox/globaltype/Camera.GetPartsObscuringTarget/return/0": { "documentation": "An array of BaseParts that obscure the lines of sight between the camera's CFrame and the castPoints." }, "@roblox/globaltype/Camera.GetPartsObscuringTarget": { "documentation": "Returns an array of BaseParts that are obscuring the lines of sight between the camera's CFrame and the cast points.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.GetPartsObscuringTarget/param/0" }, { "name": "castPoints", "documentation": "@roblox/globaltype/Camera.GetPartsObscuringTarget/param/1" }, { "name": "ignoreList", "documentation": "@roblox/globaltype/Camera.GetPartsObscuringTarget/param/2" } ], "returns": [ "@roblox/globaltype/Camera.GetPartsObscuringTarget/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#GetPartsObscuringTarget", "code_sample": "" }, "@roblox/globaltype/Camera.GetRenderCFrame/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.GetRenderCFrame/return/0": { "documentation": "The CFrame the Camera is being rendered at." }, "@roblox/globaltype/Camera.GetRenderCFrame": { "documentation": "Returns the actual CFramewhere the Camera is being rendered, accounting for any roll applied and the impact of VR devices.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.GetRenderCFrame/param/0" } ], "returns": [ "@roblox/globaltype/Camera.GetRenderCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#GetRenderCFrame", "code_sample": "" }, "@roblox/globaltype/Camera.GetRoll/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.GetRoll/return/0": { "documentation": "The current roll applied by SetRoll(), in radians." }, "@roblox/globaltype/Camera.GetRoll": { "documentation": "Returns in radians the current roll, or rotation around the camera's Z-axis, applied to the Camera using SetRoll().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.GetRoll/param/0" } ], "returns": [ "@roblox/globaltype/Camera.GetRoll/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#GetRoll", "code_sample": "" }, "@roblox/globaltype/Camera.GetTiltSpeed/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.GetTiltSpeed/return/0": { "documentation": "The speed at which the Camera is rotating around its Focus around the camera's X axis." }, "@roblox/globaltype/Camera.GetTiltSpeed": { "documentation": "Deprecated: This method has been deprecated and no longer works.
Returns the current tilt speed of the Camera.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.GetTiltSpeed/param/0" } ], "returns": [ "@roblox/globaltype/Camera.GetTiltSpeed/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#GetTiltSpeed", "code_sample": "" }, "@roblox/globaltype/Camera.Interpolate/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.Interpolate/param/1": { "documentation": "The CFrame for the Camera to tween to." }, "@roblox/globaltype/Camera.Interpolate/param/2": { "documentation": "The CFrame for the camera's Focus to tween to." }, "@roblox/globaltype/Camera.Interpolate/param/3": { "documentation": "The duration, in seconds, of the tween." }, "@roblox/globaltype/Camera.Interpolate": { "documentation": "Deprecated: This method has been deprecated. Instead use TweenService to smoothly animate the Camera, see the code snippets below for an example.
Tweens the Camera in a linear fashion towards a new CFrame and Focus over a given duration.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.Interpolate/param/0" }, { "name": "endPos", "documentation": "@roblox/globaltype/Camera.Interpolate/param/1" }, { "name": "endFocus", "documentation": "@roblox/globaltype/Camera.Interpolate/param/2" }, { "name": "duration", "documentation": "@roblox/globaltype/Camera.Interpolate/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#Interpolate", "code_sample": "" }, "@roblox/globaltype/Camera.PanUnits/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.PanUnits/param/1": { "documentation": "The number of 45 degree increments by which to pan the Camera." }, "@roblox/globaltype/Camera.PanUnits": { "documentation": "Deprecated: This method was used for legacy camera controls and has since been deprecated. Do not use in new work.
Pans the Camera around the Focus in 45 degree increments around the Y axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.PanUnits/param/0" }, { "name": "units", "documentation": "@roblox/globaltype/Camera.PanUnits/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#PanUnits", "code_sample": "" }, "@roblox/globaltype/Camera.ScreenPointToRay/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.ScreenPointToRay/param/1": { "documentation": "The position on the X axis, in pixels, of the screen point at which to originate the Ray. This position accounts for the GUI inset." }, "@roblox/globaltype/Camera.ScreenPointToRay/param/2": { "documentation": "The position on the Y axis, in pixels, of the screen point at which to originate the Ray. This position accounts for the GUI inset." }, "@roblox/globaltype/Camera.ScreenPointToRay/param/3": { "documentation": "The depth from the Camera, in studs, from which to offset the origin of the Ray." }, "@roblox/globaltype/Camera.ScreenPointToRay/return/0": { "documentation": "A unit Ray, originating from the equivalent Vector3 world position of the given screen coordinates at the given depth away from the Camera. This ray is orientated in the direction of the Camera." }, "@roblox/globaltype/Camera.ScreenPointToRay": { "documentation": "Creates a unit Ray from a position on the screen (in pixels), at a set depth from the Camera orientated in the camera's direction. Accounts for the GUI inset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.ScreenPointToRay/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Camera.ScreenPointToRay/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Camera.ScreenPointToRay/param/2" }, { "name": "depth", "documentation": "@roblox/globaltype/Camera.ScreenPointToRay/param/3" } ], "returns": [ "@roblox/globaltype/Camera.ScreenPointToRay/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#ScreenPointToRay", "code_sample": "" }, "@roblox/globaltype/Camera.SetCameraPanMode/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.SetCameraPanMode/param/1": { "documentation": "The CameraPanMode to set the Camera to." }, "@roblox/globaltype/Camera.SetCameraPanMode": { "documentation": "Deprecated: This method has been deprecated and should not be used in new work.
Sets the CameraPanMode to be used by the Camera on mobile devices.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.SetCameraPanMode/param/0" }, { "name": "mode", "documentation": "@roblox/globaltype/Camera.SetCameraPanMode/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#SetCameraPanMode", "code_sample": "" }, "@roblox/globaltype/Camera.SetRoll/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.SetRoll/param/1": { "documentation": "The roll angle, in radians, to be applied to the Camera." }, "@roblox/globaltype/Camera.SetRoll": { "documentation": "Sets the current rotation applied around the camera's Z-axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.SetRoll/param/0" }, { "name": "rollAngle", "documentation": "@roblox/globaltype/Camera.SetRoll/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#SetRoll", "code_sample": "" }, "@roblox/globaltype/Camera.TiltUnits/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.TiltUnits/param/1": { "documentation": "The number of 10 degree units by which to tilt the Camera." }, "@roblox/globaltype/Camera.TiltUnits/return/0": { "documentation": "Whether the Camera tilt applied was constrained." }, "@roblox/globaltype/Camera.TiltUnits": { "documentation": "Deprecated: This method was used for legacy camera controls and has been deprecated. Do not use in new work.
Tilts the Camera around its Focus in 10 degree increments around the camera's X axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.TiltUnits/param/0" }, { "name": "units", "documentation": "@roblox/globaltype/Camera.TiltUnits/param/1" } ], "returns": [ "@roblox/globaltype/Camera.TiltUnits/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#TiltUnits", "code_sample": "" }, "@roblox/globaltype/Camera.ViewportPointToRay/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.ViewportPointToRay/param/1": { "documentation": "The position on the X axis, in pixels, of the viewport point at which to originate the Ray, in device safe area coordinates." }, "@roblox/globaltype/Camera.ViewportPointToRay/param/2": { "documentation": "The position on the Y axis, in pixels, of the viewport point at which to originate the Ray, in device safe area coordinates." }, "@roblox/globaltype/Camera.ViewportPointToRay/param/3": { "documentation": "The depth from the Camera, in studs, from which to offset the origin of the Ray." }, "@roblox/globaltype/Camera.ViewportPointToRay/return/0": { "documentation": "A unit Ray, originating from the equivalent Vector3 world position of the given viewport coordinates at the given depth away from the Camera. This ray is orientated in the direction of the Camera." }, "@roblox/globaltype/Camera.ViewportPointToRay": { "documentation": "Creates a unit Ray from a position on the viewport (in pixels), at a given depth from the Camera, orientated in the camera's direction. Does not account for the CoreUISafeInsets inset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.ViewportPointToRay/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Camera.ViewportPointToRay/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Camera.ViewportPointToRay/param/2" }, { "name": "depth", "documentation": "@roblox/globaltype/Camera.ViewportPointToRay/param/3" } ], "returns": [ "@roblox/globaltype/Camera.ViewportPointToRay/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#ViewportPointToRay", "code_sample": "" }, "@roblox/globaltype/Camera.WorldToScreenPoint/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.WorldToScreenPoint/param/1": { "documentation": "The Vector3 world position." }, "@roblox/globaltype/Camera.WorldToScreenPoint/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/Camera.WorldToScreenPoint": { "documentation": "Returns the screen location and depth of a Vector3 worldPoint and whether this point is within the bounds of the screen. Accounts for the GUI inset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.WorldToScreenPoint/param/0" }, { "name": "worldPoint", "documentation": "@roblox/globaltype/Camera.WorldToScreenPoint/param/1" } ], "returns": [ "@roblox/globaltype/Camera.WorldToScreenPoint/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToScreenPoint", "code_sample": "" }, "@roblox/globaltype/Camera.WorldToViewportPoint/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.WorldToViewportPoint/param/1": { "documentation": "The Vector3 world position." }, "@roblox/globaltype/Camera.WorldToViewportPoint/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/Camera.WorldToViewportPoint": { "documentation": "Returns the screen location and depth of a Vector3 worldPoint and whether this point is within the bounds of the screen. Does not account for the GUI inset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.WorldToViewportPoint/param/0" }, { "name": "worldPoint", "documentation": "@roblox/globaltype/Camera.WorldToViewportPoint/param/1" } ], "returns": [ "@roblox/globaltype/Camera.WorldToViewportPoint/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#WorldToViewportPoint", "code_sample": "" }, "@roblox/globaltype/Camera.ZoomToExtents/param/0": { "documentation": "A class which defines a view of the 3D world." }, "@roblox/globaltype/Camera.ZoomToExtents/param/1": { "documentation": "The CFrame representing the center and orientation of the bounding box to fit into the viewport." }, "@roblox/globaltype/Camera.ZoomToExtents/param/2": { "documentation": "The Vector3 size of the bounding box to fit into the viewport." }, "@roblox/globaltype/Camera.ZoomToExtents": { "documentation": "Adjusts the CFrame so that the specified bounding box is fully visible within the camera's viewport.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.ZoomToExtents/param/0" }, { "name": "boundingBoxCFrame", "documentation": "@roblox/globaltype/Camera.ZoomToExtents/param/1" }, { "name": "boundingBoxSize", "documentation": "@roblox/globaltype/Camera.ZoomToExtents/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#ZoomToExtents", "code_sample": "" }, "@roblox/globaltype/Camera.InterpolationFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Camera.InterpolationFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Camera.InterpolationFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Camera.InterpolationFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Camera.InterpolationFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Camera.InterpolationFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Camera.InterpolationFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Camera.InterpolationFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Camera.InterpolationFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Camera.InterpolationFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Camera.InterpolationFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Camera.InterpolationFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Camera.InterpolationFinished": { "documentation": "Fired when the Camera has finished interpolating usingInterpolate().", "keys": { "Connect": "@roblox/globaltype/Camera.InterpolationFinished.Connect", "ConnectParallel": "@roblox/globaltype/Camera.InterpolationFinished.ConnectParallel", "Once": "@roblox/globaltype/Camera.InterpolationFinished.Once", "Wait": "@roblox/globaltype/Camera.InterpolationFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Camera#InterpolationFinished", "code_sample": "" }, "@roblox/globaltype/Terrain": { "documentation": "Terrain lets you to create dynamically morphable environments.", "keys": { "Decoration": "@roblox/globaltype/Terrain.Decoration", "GrassLength": "@roblox/globaltype/Terrain.GrassLength", "IsSmooth": "@roblox/globaltype/Terrain.IsSmooth", "MaterialColors": "@roblox/globaltype/Terrain.MaterialColors", "MaxExtents": "@roblox/globaltype/Terrain.MaxExtents", "WaterColor": "@roblox/globaltype/Terrain.WaterColor", "WaterReflectance": "@roblox/globaltype/Terrain.WaterReflectance", "WaterTransparency": "@roblox/globaltype/Terrain.WaterTransparency", "WaterWaveSize": "@roblox/globaltype/Terrain.WaterWaveSize", "WaterWaveSpeed": "@roblox/globaltype/Terrain.WaterWaveSpeed", "AutowedgeCell": "@roblox/globaltype/Terrain.AutowedgeCell", "AutowedgeCells": "@roblox/globaltype/Terrain.AutowedgeCells", "CellCenterToWorld": "@roblox/globaltype/Terrain.CellCenterToWorld", "CellCornerToWorld": "@roblox/globaltype/Terrain.CellCornerToWorld", "Clear": "@roblox/globaltype/Terrain.Clear", "ClearVoxelsAsync_beta": "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta", "ConvertToSmooth": "@roblox/globaltype/Terrain.ConvertToSmooth", "CopyRegion": "@roblox/globaltype/Terrain.CopyRegion", "CountCells": "@roblox/globaltype/Terrain.CountCells", "FillBall": "@roblox/globaltype/Terrain.FillBall", "FillBlock": "@roblox/globaltype/Terrain.FillBlock", "FillCylinder": "@roblox/globaltype/Terrain.FillCylinder", "FillRegion": "@roblox/globaltype/Terrain.FillRegion", "FillWedge": "@roblox/globaltype/Terrain.FillWedge", "GetCell": "@roblox/globaltype/Terrain.GetCell", "GetMaterialColor": "@roblox/globaltype/Terrain.GetMaterialColor", "GetWaterCell": "@roblox/globaltype/Terrain.GetWaterCell", "IterateVoxelsAsync_beta": "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta", "ModifyVoxelsAsync_beta": "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta", "PasteRegion": "@roblox/globaltype/Terrain.PasteRegion", "ReadVoxelChannels": "@roblox/globaltype/Terrain.ReadVoxelChannels", "ReadVoxels": "@roblox/globaltype/Terrain.ReadVoxels", "ReadVoxelsAsync_beta": "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta", "ReplaceMaterial": "@roblox/globaltype/Terrain.ReplaceMaterial", "SetCell": "@roblox/globaltype/Terrain.SetCell", "SetCells": "@roblox/globaltype/Terrain.SetCells", "SetMaterialColor": "@roblox/globaltype/Terrain.SetMaterialColor", "SetWaterCell": "@roblox/globaltype/Terrain.SetWaterCell", "WorldToCell": "@roblox/globaltype/Terrain.WorldToCell", "WorldToCellPreferEmpty": "@roblox/globaltype/Terrain.WorldToCellPreferEmpty", "WorldToCellPreferSolid": "@roblox/globaltype/Terrain.WorldToCellPreferSolid", "WriteVoxelChannels": "@roblox/globaltype/Terrain.WriteVoxelChannels", "WriteVoxels": "@roblox/globaltype/Terrain.WriteVoxels", "WriteVoxelsAsync_beta": "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain", "code_sample": "" }, "@roblox/globaltype/Terrain.Decoration": { "documentation": "Enables or disables terrain decoration.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#Decoration", "code_sample": "" }, "@roblox/globaltype/Terrain.GrassLength": { "documentation": "Specifies the length of animated grass.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#GrassLength", "code_sample": "" }, "@roblox/globaltype/Terrain.IsSmooth": { "documentation": "Deprecated: Sets the specified terrain voxel's material to ''Water'' and sets its occupancy to 1.
Returns true if the current game is using the smooth terrain system.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#IsSmooth", "code_sample": "" }, "@roblox/globaltype/Terrain.MaterialColors": { "documentation": "MaterialColors represents the editor for the Material Color feature, and cannot be edited by scripts. To get the color of a material, use: Terrain:GetMaterialColor() To set the color of a material, use: Terrain:SetMaterialColor()", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#MaterialColors", "code_sample": "" }, "@roblox/globaltype/Terrain.MaxExtents": { "documentation": "Displays the boundaries of the largest possible editable region.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#MaxExtents", "code_sample": "" }, "@roblox/globaltype/Terrain.WaterColor": { "documentation": "The tint of the Terrain water.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WaterColor", "code_sample": "" }, "@roblox/globaltype/Terrain.WaterReflectance": { "documentation": "Controls how opaque the Terrain's water reflections are.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WaterReflectance", "code_sample": "" }, "@roblox/globaltype/Terrain.WaterTransparency": { "documentation": "The transparency of the Terrain water.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WaterTransparency", "code_sample": "" }, "@roblox/globaltype/Terrain.WaterWaveSize": { "documentation": "Sets the maximum height of the Terrain water waves in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WaterWaveSize", "code_sample": "" }, "@roblox/globaltype/Terrain.WaterWaveSpeed": { "documentation": "Sets how many times the Terrain water waves will move up and down per minute.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WaterWaveSpeed", "code_sample": "" }, "@roblox/globaltype/Terrain.AutowedgeCell/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.AutowedgeCell/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.AutowedgeCell/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.AutowedgeCell/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.AutowedgeCell/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.AutowedgeCell": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
(OBSOLETE) No longer does anything.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.AutowedgeCell/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.AutowedgeCell/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.AutowedgeCell/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.AutowedgeCell/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.AutowedgeCell/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCell", "code_sample": "" }, "@roblox/globaltype/Terrain.AutowedgeCells/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.AutowedgeCells/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.AutowedgeCells": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
(OBSOLETE) No longer does anything.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.AutowedgeCells/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.AutowedgeCells/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#AutowedgeCells", "code_sample": "" }, "@roblox/globaltype/Terrain.CellCenterToWorld/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.CellCenterToWorld/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCenterToWorld/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCenterToWorld/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCenterToWorld/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCenterToWorld": { "documentation": "Returns the world position of the center of the terrain cell (x, y, z).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.CellCenterToWorld/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.CellCenterToWorld/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.CellCenterToWorld/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.CellCenterToWorld/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.CellCenterToWorld/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCenterToWorld", "code_sample": "" }, "@roblox/globaltype/Terrain.CellCornerToWorld/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.CellCornerToWorld/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCornerToWorld/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCornerToWorld/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCornerToWorld/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.CellCornerToWorld": { "documentation": "Returns the position of the lower-left-forward corner of the grid cell (x, y, z).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.CellCornerToWorld/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.CellCornerToWorld/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.CellCornerToWorld/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.CellCornerToWorld/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.CellCornerToWorld/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#CellCornerToWorld", "code_sample": "" }, "@roblox/globaltype/Terrain.Clear/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.Clear": { "documentation": "Clears the terrain.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.Clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#Clear", "code_sample": "" }, "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta/param/1" }, { "name": "channelIds", "documentation": "@roblox/globaltype/Terrain.ClearVoxelsAsync_beta/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ClearVoxelsAsync_beta", "code_sample": "" }, "@roblox/globaltype/Terrain.ConvertToSmooth/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ConvertToSmooth": { "documentation": "Deprecated: Since all places now automatically use the new terrain engine, this method is obsolete. Do not use it for new work.
Transforms the legacy terrain engine into the new terrain engine.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ConvertToSmooth/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ConvertToSmooth", "code_sample": "" }, "@roblox/globaltype/Terrain.CopyRegion/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.CopyRegion/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.CopyRegion/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.CopyRegion": { "documentation": "Stores a chunk of terrain into a TerrainRegion object so it can be loaded back later. Note: TerrainRegion data does not replicate between server and client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.CopyRegion/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.CopyRegion/param/1" } ], "returns": [ "@roblox/globaltype/Terrain.CopyRegion/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#CopyRegion", "code_sample": "" }, "@roblox/globaltype/Terrain.CountCells/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.CountCells/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.CountCells": { "documentation": "Returns the number of non-empty cells in the Terrain.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.CountCells/param/0" } ], "returns": [ "@roblox/globaltype/Terrain.CountCells/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#CountCells", "code_sample": "" }, "@roblox/globaltype/Terrain.FillBall/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.FillBall/param/1": { "documentation": "The position of the center of the terrain ball." }, "@roblox/globaltype/Terrain.FillBall/param/2": { "documentation": "The radius in studs of the terrain ball." }, "@roblox/globaltype/Terrain.FillBall/param/3": { "documentation": "The Material of the terrain ball." }, "@roblox/globaltype/Terrain.FillBall": { "documentation": "Fills a ball of smooth terrain in a given space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.FillBall/param/0" }, { "name": "center", "documentation": "@roblox/globaltype/Terrain.FillBall/param/1" }, { "name": "radius", "documentation": "@roblox/globaltype/Terrain.FillBall/param/2" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.FillBall/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#FillBall", "code_sample": "local Workspace = game:GetService(\"Workspace\")\n\n-- Creates a ball of grass at (0,0,-10) with a radius of 10 studs\nWorkspace.Terrain:FillBall(Vector3.new(0, 0, -10), 10, Enum.Material.Grass)" }, "@roblox/globaltype/Terrain.FillBlock/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.FillBlock/param/1": { "documentation": "The position and orientation of the terrain block." }, "@roblox/globaltype/Terrain.FillBlock/param/2": { "documentation": "The size in studs of the square block - both the height and width." }, "@roblox/globaltype/Terrain.FillBlock/param/3": { "documentation": "The Material of the terrain block." }, "@roblox/globaltype/Terrain.FillBlock": { "documentation": "Fills a block of smooth terrain with a given location, rotation, size, and material.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.FillBlock/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/Terrain.FillBlock/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/Terrain.FillBlock/param/2" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.FillBlock/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#FillBlock", "code_sample": "" }, "@roblox/globaltype/Terrain.FillCylinder/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.FillCylinder/param/1": { "documentation": "The position and orientation of the terrain cylinder." }, "@roblox/globaltype/Terrain.FillCylinder/param/2": { "documentation": "The height in studs of the terrain cylinder." }, "@roblox/globaltype/Terrain.FillCylinder/param/3": { "documentation": "The radius in studs of the terrain cylinder." }, "@roblox/globaltype/Terrain.FillCylinder/param/4": { "documentation": "The Material of the terrain cylinder." }, "@roblox/globaltype/Terrain.FillCylinder": { "documentation": "Fills a cylinder of smooth terrain in a given space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.FillCylinder/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/Terrain.FillCylinder/param/1" }, { "name": "height", "documentation": "@roblox/globaltype/Terrain.FillCylinder/param/2" }, { "name": "radius", "documentation": "@roblox/globaltype/Terrain.FillCylinder/param/3" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.FillCylinder/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#FillCylinder", "code_sample": "" }, "@roblox/globaltype/Terrain.FillRegion/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.FillRegion/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.FillRegion/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.FillRegion/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.FillRegion": { "documentation": "Fills a Region3 space with smooth terrain.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.FillRegion/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.FillRegion/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.FillRegion/param/2" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.FillRegion/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#FillRegion", "code_sample": "" }, "@roblox/globaltype/Terrain.FillWedge/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.FillWedge/param/1": { "documentation": "The position and orientation of the wedge to fill." }, "@roblox/globaltype/Terrain.FillWedge/param/2": { "documentation": "The size of the wedge to fill." }, "@roblox/globaltype/Terrain.FillWedge/param/3": { "documentation": "The material with which the wedge will be filled." }, "@roblox/globaltype/Terrain.FillWedge": { "documentation": "Fills a wedge-shaped volume of Terrain with the given Material and the area's CFrame and Size.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.FillWedge/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/Terrain.FillWedge/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/Terrain.FillWedge/param/2" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.FillWedge/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#FillWedge", "code_sample": "" }, "@roblox/globaltype/Terrain.GetCell/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.GetCell/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.GetCell/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.GetCell/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.GetCell/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.GetCell": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
Returns the closest CellMaterial from the legacy terrain engine that matches the smooth terrain voxel specified.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.GetCell/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.GetCell/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.GetCell/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.GetCell/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.GetCell/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#GetCell", "code_sample": "" }, "@roblox/globaltype/Terrain.GetMaterialColor/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.GetMaterialColor/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.GetMaterialColor/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.GetMaterialColor": { "documentation": "Returns current terrain material color for specified terrain material.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.GetMaterialColor/param/0" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.GetMaterialColor/param/1" } ], "returns": [ "@roblox/globaltype/Terrain.GetMaterialColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#GetMaterialColor", "code_sample": "" }, "@roblox/globaltype/Terrain.GetWaterCell/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.GetWaterCell/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.GetWaterCell/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.GetWaterCell/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.GetWaterCell/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.GetWaterCell": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
Returns if the cell is a water cell.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.GetWaterCell/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.GetWaterCell/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.GetWaterCell/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.GetWaterCell/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.GetWaterCell/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#GetWaterCell", "code_sample": "" }, "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/2" }, { "name": "channelIds", "documentation": "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.IterateVoxelsAsync_beta/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#IterateVoxelsAsync_beta", "code_sample": "" }, "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/2" }, { "name": "channelIds", "documentation": "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.ModifyVoxelsAsync_beta/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ModifyVoxelsAsync_beta", "code_sample": "" }, "@roblox/globaltype/Terrain.PasteRegion/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.PasteRegion/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.PasteRegion/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.PasteRegion/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.PasteRegion": { "documentation": "Applies a chunk of terrain to the Terrain object. Note: TerrainRegion data does not replicate between server and client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.PasteRegion/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.PasteRegion/param/1" }, { "name": "corner", "documentation": "@roblox/globaltype/Terrain.PasteRegion/param/2" }, { "name": "pasteEmptyCells", "documentation": "@roblox/globaltype/Terrain.PasteRegion/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#PasteRegion", "code_sample": "" }, "@roblox/globaltype/Terrain.ReadVoxelChannels/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ReadVoxelChannels/param/1": { "documentation": "Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large; limit is currently 4194304 voxels³." }, "@roblox/globaltype/Terrain.ReadVoxelChannels/param/2": { "documentation": "Voxel resolution. Must be 4." }, "@roblox/globaltype/Terrain.ReadVoxelChannels/param/3": { "documentation": "Array of channel IDs (strings) that need to be accessed from the voxel data. Each channel ID represents a type of data that's stored in voxel. Current supported IDs are {\"SolidMaterial\", \"SolidOccupancy\", \"LiquidOccupancy\"}." }, "@roblox/globaltype/Terrain.ReadVoxelChannels/return/0": { "documentation": "Returns voxel data as a dictionary based on the channelIds input. Keys represent each channel ID with their respective value as an array of 3D data. The dictionary also contains a Size key with a value representing the 3D array size of each channel data." }, "@roblox/globaltype/Terrain.ReadVoxelChannels": { "documentation": "Returns a region of terrain voxel data in table format based on the channel names.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ReadVoxelChannels/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.ReadVoxelChannels/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.ReadVoxelChannels/param/2" }, { "name": "channelIds", "documentation": "@roblox/globaltype/Terrain.ReadVoxelChannels/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.ReadVoxelChannels/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelChannels", "code_sample": "" }, "@roblox/globaltype/Terrain.ReadVoxels/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ReadVoxels/param/1": { "documentation": "Target region to read from. Must be aligned to the voxel grid. Will throw an error if region is too large. The limit is currently 4194304 voxels^3." }, "@roblox/globaltype/Terrain.ReadVoxels/param/2": { "documentation": "Voxel resolution. Must be 4." }, "@roblox/globaltype/Terrain.ReadVoxels/return/0": { "documentation": "Returns raw voxel data as two 3D arrays. " }, "@roblox/globaltype/Terrain.ReadVoxels": { "documentation": "Returns a certain region of smooth terrain in table format.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ReadVoxels/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.ReadVoxels/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.ReadVoxels/param/2" } ], "returns": [ "@roblox/globaltype/Terrain.ReadVoxels/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxels", "code_sample": "" }, "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/2" }, { "name": "channelIds", "documentation": "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.ReadVoxelsAsync_beta/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ReadVoxelsAsync_beta", "code_sample": "" }, "@roblox/globaltype/Terrain.ReplaceMaterial/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.ReplaceMaterial/param/1": { "documentation": "The region in which the replacement operation will occur." }, "@roblox/globaltype/Terrain.ReplaceMaterial/param/2": { "documentation": "The resolution at which the replacement operation will take place; at the moment this must be exactly 4." }, "@roblox/globaltype/Terrain.ReplaceMaterial/param/3": { "documentation": "The old material that shall be replaced." }, "@roblox/globaltype/Terrain.ReplaceMaterial/param/4": { "documentation": "The new material." }, "@roblox/globaltype/Terrain.ReplaceMaterial": { "documentation": "Replaces the terrain of a material within a region with another material.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.ReplaceMaterial/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.ReplaceMaterial/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.ReplaceMaterial/param/2" }, { "name": "sourceMaterial", "documentation": "@roblox/globaltype/Terrain.ReplaceMaterial/param/3" }, { "name": "targetMaterial", "documentation": "@roblox/globaltype/Terrain.ReplaceMaterial/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#ReplaceMaterial", "code_sample": "" }, "@roblox/globaltype/Terrain.SetCell/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.SetCell/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCell/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCell/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCell/param/4": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCell/param/5": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCell/param/6": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCell": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
Sets the occupancy and material of a specific terrain voxel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.SetCell/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.SetCell/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.SetCell/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.SetCell/param/3" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.SetCell/param/4" }, { "name": "block", "documentation": "@roblox/globaltype/Terrain.SetCell/param/5" }, { "name": "orientation", "documentation": "@roblox/globaltype/Terrain.SetCell/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCell", "code_sample": "" }, "@roblox/globaltype/Terrain.SetCells/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.SetCells/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCells/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCells/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCells/param/4": { "documentation": "" }, "@roblox/globaltype/Terrain.SetCells": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
Sets the occupancy and material of all terrain voxels in a specific region.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.SetCells/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.SetCells/param/1" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.SetCells/param/2" }, { "name": "block", "documentation": "@roblox/globaltype/Terrain.SetCells/param/3" }, { "name": "orientation", "documentation": "@roblox/globaltype/Terrain.SetCells/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#SetCells", "code_sample": "" }, "@roblox/globaltype/Terrain.SetMaterialColor/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.SetMaterialColor/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.SetMaterialColor/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.SetMaterialColor": { "documentation": "Sets current terrain material color for specified terrain material.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.SetMaterialColor/param/0" }, { "name": "material", "documentation": "@roblox/globaltype/Terrain.SetMaterialColor/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Terrain.SetMaterialColor/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#SetMaterialColor", "code_sample": "" }, "@roblox/globaltype/Terrain.SetWaterCell/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.SetWaterCell/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.SetWaterCell/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.SetWaterCell/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.SetWaterCell/param/4": { "documentation": "" }, "@roblox/globaltype/Terrain.SetWaterCell/param/5": { "documentation": "" }, "@roblox/globaltype/Terrain.SetWaterCell": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
Sets the specified terrain voxel's material to ''Water'' and sets its occupancy to 1.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.SetWaterCell/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/Terrain.SetWaterCell/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/Terrain.SetWaterCell/param/2" }, { "name": "z", "documentation": "@roblox/globaltype/Terrain.SetWaterCell/param/3" }, { "name": "force", "documentation": "@roblox/globaltype/Terrain.SetWaterCell/param/4" }, { "name": "direction", "documentation": "@roblox/globaltype/Terrain.SetWaterCell/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#SetWaterCell", "code_sample": "" }, "@roblox/globaltype/Terrain.WorldToCell/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.WorldToCell/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.WorldToCell/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.WorldToCell": { "documentation": "Returns the grid cell location that contains the point position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.WorldToCell/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/Terrain.WorldToCell/param/1" } ], "returns": [ "@roblox/globaltype/Terrain.WorldToCell/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCell", "code_sample": "" }, "@roblox/globaltype/Terrain.WorldToCellPreferEmpty/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.WorldToCellPreferEmpty/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.WorldToCellPreferEmpty/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.WorldToCellPreferEmpty": { "documentation": "Returns the grid cell location that contains the point position, preferring empty grid cells when position is on a grid edge.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.WorldToCellPreferEmpty/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/Terrain.WorldToCellPreferEmpty/param/1" } ], "returns": [ "@roblox/globaltype/Terrain.WorldToCellPreferEmpty/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferEmpty", "code_sample": "" }, "@roblox/globaltype/Terrain.WorldToCellPreferSolid/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.WorldToCellPreferSolid/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.WorldToCellPreferSolid/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.WorldToCellPreferSolid": { "documentation": "Returns the grid cell location that contains the point position, preferring non-empty grid cells when position is on a grid edge.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.WorldToCellPreferSolid/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/Terrain.WorldToCellPreferSolid/param/1" } ], "returns": [ "@roblox/globaltype/Terrain.WorldToCellPreferSolid/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WorldToCellPreferSolid", "code_sample": "" }, "@roblox/globaltype/Terrain.WriteVoxelChannels/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.WriteVoxelChannels/param/1": { "documentation": "Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large; limit is currently 4194304 voxels³." }, "@roblox/globaltype/Terrain.WriteVoxelChannels/param/2": { "documentation": "Voxel resolution. Must be 4." }, "@roblox/globaltype/Terrain.WriteVoxelChannels/param/3": { "documentation": "Dictionary of voxel data similar to the return value of ReadVoxelChannels(). Keys represent each channel ID with their respective value as an array of 3D data. The dictionary can support single or multiple channel inputs. " }, "@roblox/globaltype/Terrain.WriteVoxelChannels": { "documentation": "Sets a region of terrain using a dictionary of voxel channel data.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.WriteVoxelChannels/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.WriteVoxelChannels/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.WriteVoxelChannels/param/2" }, { "name": "channels", "documentation": "@roblox/globaltype/Terrain.WriteVoxelChannels/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelChannels", "code_sample": "" }, "@roblox/globaltype/Terrain.WriteVoxels/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.WriteVoxels/param/1": { "documentation": "Target region to write to. Must be aligned to the voxel grid. Will throw an error if region is too large." }, "@roblox/globaltype/Terrain.WriteVoxels/param/2": { "documentation": "Voxel resolution. Must be 4." }, "@roblox/globaltype/Terrain.WriteVoxels/param/3": { "documentation": "3D array of Enum.Material. Dimensions must exactly match the size of the target region in voxels." }, "@roblox/globaltype/Terrain.WriteVoxels/param/4": { "documentation": "3D array of voxel occupancies (number between 0 and 1). Dimensions must exactly match the size of the target region in voxels." }, "@roblox/globaltype/Terrain.WriteVoxels": { "documentation": "Sets a certain region of smooth terrain using table format.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.WriteVoxels/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.WriteVoxels/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.WriteVoxels/param/2" }, { "name": "materials", "documentation": "@roblox/globaltype/Terrain.WriteVoxels/param/3" }, { "name": "occupancy", "documentation": "@roblox/globaltype/Terrain.WriteVoxels/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxels", "code_sample": "" }, "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/0": { "documentation": "Terrain lets you to create dynamically morphable environments." }, "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/1": { "documentation": "" }, "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/2": { "documentation": "" }, "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/3": { "documentation": "" }, "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/return/0": { "documentation": "" }, "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/1" }, { "name": "resolution", "documentation": "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/2" }, { "name": "channelIds", "documentation": "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/param/3" } ], "returns": [ "@roblox/globaltype/Terrain.WriteVoxelsAsync_beta/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Terrain#WriteVoxelsAsync_beta", "code_sample": "" }, "@roblox/globaltype/AudioDistortion": { "documentation": "Distorts audio streams, making them sound fuzzier, grittier, and louder.", "keys": { "Bypass": "@roblox/globaltype/AudioDistortion.Bypass", "Level": "@roblox/globaltype/AudioDistortion.Level", "GetConnectedWires": "@roblox/globaltype/AudioDistortion.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioDistortion.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioDistortion.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion", "code_sample": "" }, "@roblox/globaltype/AudioDistortion.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioDistortion.Level": { "documentation": "Controls how distorted the input stream will become.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#Level", "code_sample": "" }, "@roblox/globaltype/AudioDistortion.GetConnectedWires/param/0": { "documentation": "Distorts audio streams, making them sound fuzzier, grittier, and louder." }, "@roblox/globaltype/AudioDistortion.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioDistortion.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioDistortion.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioDistortion.GetInputPins/param/0": { "documentation": "Distorts audio streams, making them sound fuzzier, grittier, and louder." }, "@roblox/globaltype/AudioDistortion.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioDistortion.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioDistortion.GetOutputPins/param/0": { "documentation": "Distorts audio streams, making them sound fuzzier, grittier, and louder." }, "@roblox/globaltype/AudioDistortion.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioDistortion.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioDistortion.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDistortion.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDistortion.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDistortion.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDistortion.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDistortion.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDistortion.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDistortion.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDistortion.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDistortion.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioDistortion.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioDistortion via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioDistortion.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioDistortion.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioDistortion.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioDistortion.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#WiringChanged", "code_sample": "" }, "@roblox/globaltype/UnreliableRemoteEvent": { "documentation": "An object which facilitates asynchronous, unordered and unreliable, one-way communication across the client-server boundary. Scripts firing a UnreliableRemoteEvent do not yield.", "keys": { "FireAllClients": "@roblox/globaltype/UnreliableRemoteEvent.FireAllClients", "FireClient": "@roblox/globaltype/UnreliableRemoteEvent.FireClient", "FireServer": "@roblox/globaltype/UnreliableRemoteEvent.FireServer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnreliableRemoteEvent", "code_sample": "" }, "@roblox/globaltype/UnreliableRemoteEvent.FireAllClients/param/0": { "documentation": "An object which facilitates asynchronous, unordered and unreliable, one-way communication across the client-server boundary. Scripts firing a UnreliableRemoteEvent do not yield." }, "@roblox/globaltype/UnreliableRemoteEvent.FireAllClients/param/1": { "documentation": "Values to pass to all OnClientEvent events connected to the same UnreliableRemoteEvent." }, "@roblox/globaltype/UnreliableRemoteEvent.FireAllClients": { "documentation": "Fires the OnClientEvent event for all connected clients. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireAllClients/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireAllClients/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnreliableRemoteEvent#FireAllClients", "code_sample": "" }, "@roblox/globaltype/UnreliableRemoteEvent.FireClient/param/0": { "documentation": "An object which facilitates asynchronous, unordered and unreliable, one-way communication across the client-server boundary. Scripts firing a UnreliableRemoteEvent do not yield." }, "@roblox/globaltype/UnreliableRemoteEvent.FireClient/param/1": { "documentation": "The client of the Player to fire the event to." }, "@roblox/globaltype/UnreliableRemoteEvent.FireClient/param/2": { "documentation": "Values to pass to OnClientEvent events connected to the same UnreliableRemoteEvent." }, "@roblox/globaltype/UnreliableRemoteEvent.FireClient": { "documentation": "Fires the OnClientEvent event for a specific client. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireClient/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireClient/param/1" }, { "name": "arguments", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireClient/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnreliableRemoteEvent#FireClient", "code_sample": "" }, "@roblox/globaltype/UnreliableRemoteEvent.FireServer/param/0": { "documentation": "An object which facilitates asynchronous, unordered and unreliable, one-way communication across the client-server boundary. Scripts firing a UnreliableRemoteEvent do not yield." }, "@roblox/globaltype/UnreliableRemoteEvent.FireServer/param/1": { "documentation": "Values to pass to OnServerEvent events connected to the same UnreliableRemoteEvent." }, "@roblox/globaltype/UnreliableRemoteEvent.FireServer": { "documentation": "Fires the OnServerEvent event on the server from one connected client. Has a 1000 byte limit to the payload of the event. Events with larger payloads are dropped.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireServer/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.FireServer/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnreliableRemoteEvent#FireServer", "code_sample": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent": { "documentation": "Fires from a LocalScript when either FireClient() or FireAllClients() is called on the same UnreliableRemoteEvent instance from a Script, although this firing is not guaranteed even if one of the above methods are called. This can occur due to packet loss or to maintain optimal engine performance.", "keys": { "Connect": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Connect", "ConnectParallel": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.ConnectParallel", "Once": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Once", "Wait": "@roblox/globaltype/UnreliableRemoteEvent.OnClientEvent.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnreliableRemoteEvent#OnClientEvent", "code_sample": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent": { "documentation": "Fires from a Script when FireServer() is called on the same UnreliableRemoteEvent instance from a LocalScript, although this firing is not guaranteed even if the above methods is called. This can occur due to packet loss or to maintain optimal engine performance.", "keys": { "Connect": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Connect", "ConnectParallel": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.ConnectParallel", "Once": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Once", "Wait": "@roblox/globaltype/UnreliableRemoteEvent.OnServerEvent.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnreliableRemoteEvent#OnServerEvent", "code_sample": "" }, "@roblox/globaltype/StopWatchReporter": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StopWatchReporter", "code_sample": "" }, "@roblox/globaltype/UIPadding": { "documentation": "Applies padding to the borders of the parent GuiObject.", "keys": { "PaddingBottom": "@roblox/globaltype/UIPadding.PaddingBottom", "PaddingLeft": "@roblox/globaltype/UIPadding.PaddingLeft", "PaddingRight": "@roblox/globaltype/UIPadding.PaddingRight", "PaddingTop": "@roblox/globaltype/UIPadding.PaddingTop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPadding", "code_sample": "" }, "@roblox/globaltype/UIPadding.PaddingBottom": { "documentation": "Padding to apply on the bottom side, relative to the parent's normal size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPadding#PaddingBottom", "code_sample": "" }, "@roblox/globaltype/UIPadding.PaddingLeft": { "documentation": "Padding to apply on the left side, relative to the parent's normal size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPadding#PaddingLeft", "code_sample": "" }, "@roblox/globaltype/UIPadding.PaddingRight": { "documentation": "Padding to apply on the right side, relative to the parent's normal size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPadding#PaddingRight", "code_sample": "" }, "@roblox/globaltype/UIPadding.PaddingTop": { "documentation": "Padding to apply on the top side, relative to the parent's normal size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPadding#PaddingTop", "code_sample": "" }, "@roblox/globaltype/AudioFader": { "documentation": "Adjusts the volume of audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioFader.Bypass", "Volume": "@roblox/globaltype/AudioFader.Volume", "GetConnectedWires": "@roblox/globaltype/AudioFader.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioFader.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioFader.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader", "code_sample": "" }, "@roblox/globaltype/AudioFader.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioFader.Volume": { "documentation": "Volume level which is multiplied onto the input stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader#Volume", "code_sample": "" }, "@roblox/globaltype/AudioFader.GetConnectedWires/param/0": { "documentation": "Adjusts the volume of audio streams." }, "@roblox/globaltype/AudioFader.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFader.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFader.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioFader.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioFader.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioFader.GetInputPins/param/0": { "documentation": "Adjusts the volume of audio streams." }, "@roblox/globaltype/AudioFader.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFader.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioFader.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioFader.GetOutputPins/param/0": { "documentation": "Adjusts the volume of audio streams." }, "@roblox/globaltype/AudioFader.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFader.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioFader.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioFader.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFader.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFader.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFader.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFader.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFader.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFader.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFader.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFader.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFader.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFader.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFader.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioFader.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioFader via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioFader.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioFader.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioFader.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioFader.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFader#WiringChanged", "code_sample": "" }, "@roblox/globaltype/ScreenGui": { "documentation": "Primary container of on-screen 2D user interface elements.", "keys": { "ClipToDeviceSafeArea": "@roblox/globaltype/ScreenGui.ClipToDeviceSafeArea", "DisplayOrder": "@roblox/globaltype/ScreenGui.DisplayOrder", "IgnoreGuiInset": "@roblox/globaltype/ScreenGui.IgnoreGuiInset", "SafeAreaCompatibility": "@roblox/globaltype/ScreenGui.SafeAreaCompatibility", "ScreenInsets": "@roblox/globaltype/ScreenGui.ScreenInsets" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenGui", "code_sample": "" }, "@roblox/globaltype/ScreenGui.ClipToDeviceSafeArea": { "documentation": "Whether to clip the contents of this ScreenGui to the device's safe area.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenGui#ClipToDeviceSafeArea", "code_sample": "" }, "@roblox/globaltype/ScreenGui.DisplayOrder": { "documentation": "Controls the Z-index order in which multiple ScreenGui containers are drawn.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenGui#DisplayOrder", "code_sample": "" }, "@roblox/globaltype/ScreenGui.IgnoreGuiInset": { "documentation": "Determines whether the ScreenGui overflows into the range of Roblox's core UI elements.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenGui#IgnoreGuiInset", "code_sample": "" }, "@roblox/globaltype/ScreenGui.SafeAreaCompatibility": { "documentation": "Specifies whether automatic UI compatibility transformations are applied to descendant \"fullscreen\" GuiObjects on displays with screen cutouts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenGui#SafeAreaCompatibility", "code_sample": "" }, "@roblox/globaltype/ScreenGui.ScreenInsets": { "documentation": "Controls the safe area insets that are applied to the contents of the ScreenGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenGui#ScreenInsets", "code_sample": "" }, "@roblox/globaltype/CylinderHandleAdornment": { "documentation": "A cylinder-shaped handle that can be adorned to a BasePart.", "keys": { "Angle": "@roblox/globaltype/CylinderHandleAdornment.Angle", "Height": "@roblox/globaltype/CylinderHandleAdornment.Height", "InnerRadius": "@roblox/globaltype/CylinderHandleAdornment.InnerRadius", "Radius": "@roblox/globaltype/CylinderHandleAdornment.Radius", "Shading": "@roblox/globaltype/CylinderHandleAdornment.Shading" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment", "code_sample": "" }, "@roblox/globaltype/CylinderHandleAdornment.Angle": { "documentation": "Angle of the cylinder handle as in a \"pie slice\" sector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment#Angle", "code_sample": "" }, "@roblox/globaltype/CylinderHandleAdornment.Height": { "documentation": "Height of the cylinder adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment#Height", "code_sample": "" }, "@roblox/globaltype/CylinderHandleAdornment.InnerRadius": { "documentation": "Inner radius with which to render a hollow cylinder.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment#InnerRadius", "code_sample": "" }, "@roblox/globaltype/CylinderHandleAdornment.Radius": { "documentation": "Radius of the cylinder adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment#Radius", "code_sample": "" }, "@roblox/globaltype/CylinderHandleAdornment.Shading": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderHandleAdornment#Shading", "code_sample": "" }, "@roblox/globaltype/SelectionLasso": { "documentation": "Abstract class for SelectionPartLasso and SelectionPartLasso.", "keys": { "Humanoid": "@roblox/globaltype/SelectionLasso.Humanoid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionLasso", "code_sample": "" }, "@roblox/globaltype/SelectionLasso.Humanoid": { "documentation": "The Humanoid that the Lasso belongs to, and will come from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionLasso#Humanoid", "code_sample": "" }, "@roblox/globaltype/NetworkReplicator": { "documentation": "An object which handles the replication of other objects either from the server to the client, or from the client to the server.", "keys": { "GetPlayer": "@roblox/globaltype/NetworkReplicator.GetPlayer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkReplicator", "code_sample": "" }, "@roblox/globaltype/NetworkReplicator.GetPlayer/param/0": { "documentation": "An object which handles the replication of other objects either from the server to the client, or from the client to the server." }, "@roblox/globaltype/NetworkReplicator.GetPlayer/return/0": { "documentation": "" }, "@roblox/globaltype/NetworkReplicator.GetPlayer": { "documentation": "Returns the player that is connected to the NetworkReplicator.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkReplicator.GetPlayer/param/0" } ], "returns": [ "@roblox/globaltype/NetworkReplicator.GetPlayer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkReplicator#GetPlayer", "code_sample": "" }, "@roblox/globaltype/BodyColors": { "documentation": "For a Humanoid character, the BodyColors will specify the colors for the different body parts.", "keys": { "HeadColor": "@roblox/globaltype/BodyColors.HeadColor", "HeadColor3": "@roblox/globaltype/BodyColors.HeadColor3", "LeftArmColor": "@roblox/globaltype/BodyColors.LeftArmColor", "LeftArmColor3": "@roblox/globaltype/BodyColors.LeftArmColor3", "LeftLegColor": "@roblox/globaltype/BodyColors.LeftLegColor", "LeftLegColor3": "@roblox/globaltype/BodyColors.LeftLegColor3", "RightArmColor": "@roblox/globaltype/BodyColors.RightArmColor", "RightArmColor3": "@roblox/globaltype/BodyColors.RightArmColor3", "RightLegColor": "@roblox/globaltype/BodyColors.RightLegColor", "RightLegColor3": "@roblox/globaltype/BodyColors.RightLegColor3", "TorsoColor": "@roblox/globaltype/BodyColors.TorsoColor", "TorsoColor3": "@roblox/globaltype/BodyColors.TorsoColor3" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors", "code_sample": "" }, "@roblox/globaltype/BodyColors.HeadColor": { "documentation": "Sets the color of the head, as a BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#HeadColor", "code_sample": "" }, "@roblox/globaltype/BodyColors.HeadColor3": { "documentation": "Sets the color of the head, as a Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#HeadColor3", "code_sample": "" }, "@roblox/globaltype/BodyColors.LeftArmColor": { "documentation": "Sets the color of the left arm, as a BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#LeftArmColor", "code_sample": "" }, "@roblox/globaltype/BodyColors.LeftArmColor3": { "documentation": "Sets the color of the left arm, as a Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#LeftArmColor3", "code_sample": "" }, "@roblox/globaltype/BodyColors.LeftLegColor": { "documentation": "Sets the color of the left leg, as a BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#LeftLegColor", "code_sample": "" }, "@roblox/globaltype/BodyColors.LeftLegColor3": { "documentation": "Sets the color of the left leg, as a Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#LeftLegColor3", "code_sample": "" }, "@roblox/globaltype/BodyColors.RightArmColor": { "documentation": "Sets the color of the right arm, as a BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#RightArmColor", "code_sample": "" }, "@roblox/globaltype/BodyColors.RightArmColor3": { "documentation": "Sets the color of the right arm, as a Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#RightArmColor3", "code_sample": "" }, "@roblox/globaltype/BodyColors.RightLegColor": { "documentation": "Sets the color of the right leg, as a BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#RightLegColor", "code_sample": "" }, "@roblox/globaltype/BodyColors.RightLegColor3": { "documentation": "Sets the color of the right leg, as a Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#RightLegColor3", "code_sample": "" }, "@roblox/globaltype/BodyColors.TorsoColor": { "documentation": "Sets the color of the torso, as a BrickColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#TorsoColor", "code_sample": "" }, "@roblox/globaltype/BodyColors.TorsoColor3": { "documentation": "Sets the color of the torso, as a Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyColors#TorsoColor3", "code_sample": "" }, "@roblox/globaltype/WeldConstraint": { "documentation": "Connects two BaseParts together such that their relative position and orientation remain the same.", "keys": { "Active": "@roblox/globaltype/WeldConstraint.Active", "Enabled": "@roblox/globaltype/WeldConstraint.Enabled", "Part0": "@roblox/globaltype/WeldConstraint.Part0", "Part1": "@roblox/globaltype/WeldConstraint.Part1" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WeldConstraint", "code_sample": "" }, "@roblox/globaltype/WeldConstraint.Active": { "documentation": "Indicates if the WeldConstraint is currently active in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WeldConstraint#Active", "code_sample": "" }, "@roblox/globaltype/WeldConstraint.Enabled": { "documentation": "Toggles the constraint on and off.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WeldConstraint#Enabled", "code_sample": "" }, "@roblox/globaltype/WeldConstraint.Part0": { "documentation": "The first part connected by the constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WeldConstraint#Part0", "code_sample": "" }, "@roblox/globaltype/WeldConstraint.Part1": { "documentation": "The second part connected by the constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WeldConstraint#Part1", "code_sample": "" }, "@roblox/globaltype/DataStore": { "documentation": "", "keys": { "GetVersionAsync": "@roblox/globaltype/DataStore.GetVersionAsync", "GetVersionAtTimeAsync": "@roblox/globaltype/DataStore.GetVersionAtTimeAsync", "ListKeysAsync": "@roblox/globaltype/DataStore.ListKeysAsync", "ListVersionsAsync": "@roblox/globaltype/DataStore.ListVersionsAsync", "RemoveVersionAsync": "@roblox/globaltype/DataStore.RemoveVersionAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStore", "code_sample": "" }, "@roblox/globaltype/DataStore.GetVersionAsync/param/0": { "documentation": "" }, "@roblox/globaltype/DataStore.GetVersionAsync/param/1": { "documentation": "Key name for which the version info is requested. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/DataStore.GetVersionAsync/param/2": { "documentation": "Version number of the key for which the version info is requested." }, "@roblox/globaltype/DataStore.GetVersionAsync/return/0": { "documentation": "The value of the key at the specified version and a DataStoreKeyInfo instance that includes the version number, date and time the version was created, and functions to retrieve UserIds and metadata." }, "@roblox/globaltype/DataStore.GetVersionAsync": { "documentation": "Retrieves the specified key version.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStore.GetVersionAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/DataStore.GetVersionAsync/param/1" }, { "name": "version", "documentation": "@roblox/globaltype/DataStore.GetVersionAsync/param/2" } ], "returns": [ "@roblox/globaltype/DataStore.GetVersionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStore#GetVersionAsync", "code_sample": "" }, "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/param/0": { "documentation": "" }, "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/param/1": { "documentation": "Key name for which the version info is requested. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/param/2": { "documentation": "Unix timestamp in milliseconds for which the requested version was current. Must be greater than zero. Must not be more than ten minutes in the future." }, "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/return/0": { "documentation": "The value of the key that was current at the specified time and a DataStoreKeyInfo instance that includes the version number, date and time the version was created, and functions to retrieve UserIds and metadata. nil if no available version was current at the requested time." }, "@roblox/globaltype/DataStore.GetVersionAtTimeAsync": { "documentation": "Retrieves the key version that was current at a given time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/param/1" }, { "name": "timestamp", "documentation": "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/param/2" } ], "returns": [ "@roblox/globaltype/DataStore.GetVersionAtTimeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStore#GetVersionAtTimeAsync", "code_sample": "" }, "@roblox/globaltype/DataStore.ListKeysAsync/param/0": { "documentation": "" }, "@roblox/globaltype/DataStore.ListKeysAsync/param/1": { "documentation": "(Optional) Prefix to use for locating keys." }, "@roblox/globaltype/DataStore.ListKeysAsync/param/2": { "documentation": "(Optional) Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 50 items per page." }, "@roblox/globaltype/DataStore.ListKeysAsync/param/3": { "documentation": "(Optional) Cursor to continue iteration." }, "@roblox/globaltype/DataStore.ListKeysAsync/param/4": { "documentation": "(Optional) Exclude deleted keys from being returned. When enabled ListKeys will check up to 512 keys. If all checked keys are deleted then it will return an empty list with a cursor to continue iteration." }, "@roblox/globaltype/DataStore.ListKeysAsync/return/0": { "documentation": "A DataStoreKeyPages instance that enumerates the keys as DataStoreKey instances." }, "@roblox/globaltype/DataStore.ListKeysAsync": { "documentation": "Returns a DataStoreKeyPages object for enumerating through keys of a data store.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStore.ListKeysAsync/param/0" }, { "name": "prefix", "documentation": "@roblox/globaltype/DataStore.ListKeysAsync/param/1" }, { "name": "pageSize", "documentation": "@roblox/globaltype/DataStore.ListKeysAsync/param/2" }, { "name": "cursor", "documentation": "@roblox/globaltype/DataStore.ListKeysAsync/param/3" }, { "name": "excludeDeleted", "documentation": "@roblox/globaltype/DataStore.ListKeysAsync/param/4" } ], "returns": [ "@roblox/globaltype/DataStore.ListKeysAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStore#ListKeysAsync", "code_sample": "" }, "@roblox/globaltype/DataStore.ListVersionsAsync/param/0": { "documentation": "" }, "@roblox/globaltype/DataStore.ListVersionsAsync/param/1": { "documentation": "Key name for the versions to list. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/DataStore.ListVersionsAsync/param/2": { "documentation": "(Optional) Enum specifying ascending or descending sort order." }, "@roblox/globaltype/DataStore.ListVersionsAsync/param/3": { "documentation": "(Optional) Unix timestamp in milliseconds after which the versions should be listed." }, "@roblox/globaltype/DataStore.ListVersionsAsync/param/4": { "documentation": "(Optional) Unix timestamp in milliseconds up to which the versions should be listed." }, "@roblox/globaltype/DataStore.ListVersionsAsync/param/5": { "documentation": "(Optional) Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 1024 items per page." }, "@roblox/globaltype/DataStore.ListVersionsAsync/return/0": { "documentation": "A DataStoreVersionPages instance that enumerates all the versions of the key as DataStoreObjectVersionInfo instances." }, "@roblox/globaltype/DataStore.ListVersionsAsync": { "documentation": "Enumerates all versions of a key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStore.ListVersionsAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/DataStore.ListVersionsAsync/param/1" }, { "name": "sortDirection", "documentation": "@roblox/globaltype/DataStore.ListVersionsAsync/param/2" }, { "name": "minDate", "documentation": "@roblox/globaltype/DataStore.ListVersionsAsync/param/3" }, { "name": "maxDate", "documentation": "@roblox/globaltype/DataStore.ListVersionsAsync/param/4" }, { "name": "pageSize", "documentation": "@roblox/globaltype/DataStore.ListVersionsAsync/param/5" } ], "returns": [ "@roblox/globaltype/DataStore.ListVersionsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStore#ListVersionsAsync", "code_sample": "" }, "@roblox/globaltype/DataStore.RemoveVersionAsync/param/0": { "documentation": "" }, "@roblox/globaltype/DataStore.RemoveVersionAsync/param/1": { "documentation": "Key name for which a version is to be removed. If DataStoreOptions.AllScopes was set to true when accessing the data store through DataStoreService:GetDataStore(), this key name must be prepended with the original scope as in \"scope/key\"." }, "@roblox/globaltype/DataStore.RemoveVersionAsync/param/2": { "documentation": "Version number of the key to remove." }, "@roblox/globaltype/DataStore.RemoveVersionAsync": { "documentation": "Permanently deletes the specified version of a key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStore.RemoveVersionAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/DataStore.RemoveVersionAsync/param/1" }, { "name": "version", "documentation": "@roblox/globaltype/DataStore.RemoveVersionAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStore#RemoveVersionAsync", "code_sample": "" }, "@roblox/globaltype/PluginAction": { "documentation": "", "keys": { "ActionId": "@roblox/globaltype/PluginAction.ActionId", "AllowBinding": "@roblox/globaltype/PluginAction.AllowBinding", "StatusTip": "@roblox/globaltype/PluginAction.StatusTip", "Text": "@roblox/globaltype/PluginAction.Text" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginAction", "code_sample": "" }, "@roblox/globaltype/PluginAction.ActionId": { "documentation": "A string that uniquely identifies this action.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginAction#ActionId", "code_sample": "" }, "@roblox/globaltype/PluginAction.AllowBinding": { "documentation": "Determines whether the action can be assigned a keyboard shortcut in Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginAction#AllowBinding", "code_sample": "" }, "@roblox/globaltype/PluginAction.StatusTip": { "documentation": "The description of the action when viewing it from the keyboard shortcuts window in Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginAction#StatusTip", "code_sample": "" }, "@roblox/globaltype/PluginAction.Text": { "documentation": "The text that is displayed when viewing this action in Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginAction#Text", "code_sample": "" }, "@roblox/globaltype/PluginAction.Triggered.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginAction.Triggered.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginAction.Triggered.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginAction.Triggered.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginAction.Triggered.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginAction.Triggered.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginAction.Triggered.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginAction.Triggered.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginAction.Triggered.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginAction.Triggered.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginAction.Triggered.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginAction.Triggered.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginAction.Triggered.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginAction.Triggered.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginAction.Triggered.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginAction.Triggered.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginAction.Triggered.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginAction.Triggered.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginAction.Triggered": { "documentation": "Fires when the action is triggered.", "keys": { "Connect": "@roblox/globaltype/PluginAction.Triggered.Connect", "ConnectParallel": "@roblox/globaltype/PluginAction.Triggered.ConnectParallel", "Once": "@roblox/globaltype/PluginAction.Triggered.Once", "Wait": "@roblox/globaltype/PluginAction.Triggered.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginAction#Triggered", "code_sample": "" }, "@roblox/globaltype/PublishService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PublishService", "code_sample": "" }, "@roblox/globaltype/CacheableContentProvider": { "documentation": "A variant of the ContentProvider that caches assets that have already been received. This service is not used directly, but it is used by the services that inherit from it.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CacheableContentProvider", "code_sample": "" }, "@roblox/globaltype/PluginManagerInterface": { "documentation": "", "keys": { "CreatePlugin": "@roblox/globaltype/PluginManagerInterface.CreatePlugin", "ExportPlace": "@roblox/globaltype/PluginManagerInterface.ExportPlace", "ExportSelection": "@roblox/globaltype/PluginManagerInterface.ExportSelection" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface", "code_sample": "" }, "@roblox/globaltype/PluginManagerInterface.CreatePlugin/param/0": { "documentation": "" }, "@roblox/globaltype/PluginManagerInterface.CreatePlugin/return/0": { "documentation": "" }, "@roblox/globaltype/PluginManagerInterface.CreatePlugin": { "documentation": "Deprecated: The steps to create a plugin have changed. To learn more, see Plugin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginManagerInterface.CreatePlugin/param/0" } ], "returns": [ "@roblox/globaltype/PluginManagerInterface.CreatePlugin/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#CreatePlugin", "code_sample": "" }, "@roblox/globaltype/PluginManagerInterface.ExportPlace/param/0": { "documentation": "" }, "@roblox/globaltype/PluginManagerInterface.ExportPlace/param/1": { "documentation": "" }, "@roblox/globaltype/PluginManagerInterface.ExportPlace": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginManagerInterface.ExportPlace/param/0" }, { "name": "filePath", "documentation": "@roblox/globaltype/PluginManagerInterface.ExportPlace/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#ExportPlace", "code_sample": "" }, "@roblox/globaltype/PluginManagerInterface.ExportSelection/param/0": { "documentation": "" }, "@roblox/globaltype/PluginManagerInterface.ExportSelection/param/1": { "documentation": "" }, "@roblox/globaltype/PluginManagerInterface.ExportSelection": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginManagerInterface.ExportSelection/param/0" }, { "name": "filePath", "documentation": "@roblox/globaltype/PluginManagerInterface.ExportSelection/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManagerInterface#ExportSelection", "code_sample": "" }, "@roblox/globaltype/ScriptBuilder": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptBuilder", "code_sample": "" }, "@roblox/globaltype/Snap": { "documentation": "Deprecated:
Holds two parts together and functions identically to Weld.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Snap", "code_sample": "" }, "@roblox/globaltype/BindableEvent": { "documentation": "An object which enables custom events through asynchronous one-way communication between scripts on the same side of the client-server boundary. Scripts firing a BindableEvent do not yield.", "keys": { "Fire": "@roblox/globaltype/BindableEvent.Fire" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BindableEvent", "code_sample": "" }, "@roblox/globaltype/BindableEvent.Fire/param/0": { "documentation": "An object which enables custom events through asynchronous one-way communication between scripts on the same side of the client-server boundary. Scripts firing a BindableEvent do not yield." }, "@roblox/globaltype/BindableEvent.Fire/param/1": { "documentation": "Values to pass to Event events connected to the same BindableEvent." }, "@roblox/globaltype/BindableEvent.Fire": { "documentation": "Fires the BindableEvent which in turn fires the Event event.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BindableEvent.Fire/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/BindableEvent.Fire/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BindableEvent#Fire", "code_sample": "" }, "@roblox/globaltype/BindableEvent.Event.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BindableEvent.Event.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BindableEvent.Event.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BindableEvent.Event.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BindableEvent.Event.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BindableEvent.Event.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BindableEvent.Event.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BindableEvent.Event.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BindableEvent.Event.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BindableEvent.Event.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BindableEvent.Event.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BindableEvent.Event.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BindableEvent.Event.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BindableEvent.Event.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BindableEvent.Event.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BindableEvent.Event.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BindableEvent.Event.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BindableEvent.Event.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BindableEvent.Event": { "documentation": "Fires when any script calls the Fire() method on the same BindableEvent instance.", "keys": { "Connect": "@roblox/globaltype/BindableEvent.Event.Connect", "ConnectParallel": "@roblox/globaltype/BindableEvent.Event.ConnectParallel", "Once": "@roblox/globaltype/BindableEvent.Event.Once", "Wait": "@roblox/globaltype/BindableEvent.Event.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BindableEvent#Event", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint": { "documentation": "A rotational spring that opposes the angular motion between two axes.", "keys": { "Coils": "@roblox/globaltype/TorsionSpringConstraint.Coils", "CurrentAngle": "@roblox/globaltype/TorsionSpringConstraint.CurrentAngle", "Damping": "@roblox/globaltype/TorsionSpringConstraint.Damping", "LimitEnabled": "@roblox/globaltype/TorsionSpringConstraint.LimitEnabled", "LimitsEnabled": "@roblox/globaltype/TorsionSpringConstraint.LimitsEnabled", "MaxAngle": "@roblox/globaltype/TorsionSpringConstraint.MaxAngle", "MaxTorque": "@roblox/globaltype/TorsionSpringConstraint.MaxTorque", "Radius": "@roblox/globaltype/TorsionSpringConstraint.Radius", "Restitution": "@roblox/globaltype/TorsionSpringConstraint.Restitution", "Stiffness": "@roblox/globaltype/TorsionSpringConstraint.Stiffness" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.Coils": { "documentation": "The number of coils visualized for the constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#Coils", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.CurrentAngle": { "documentation": "The current angle, in degrees, of the limiting cone.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#CurrentAngle", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.Damping": { "documentation": "Damping constant for the TorsionSpringConstraint. Multiplied to the velocity of the constraint's Attachments to reduce the spring force applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#Damping", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.LimitEnabled": { "documentation": "Deprecated: This property is deprecated. Use LimitsEnabled instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#LimitEnabled", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.LimitsEnabled": { "documentation": "Limits the relative angular motion of the secondary axes of attachments through a cone constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.MaxAngle": { "documentation": "The maximum angle of the constraint's limiting cone.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#MaxAngle", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.MaxTorque": { "documentation": "The maximum allowable torque provided by the torsion spring.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#MaxTorque", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.Radius": { "documentation": "The visualization radius of the spring.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#Radius", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.Restitution": { "documentation": "The restitution coefficient of the cone constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#Restitution", "code_sample": "" }, "@roblox/globaltype/TorsionSpringConstraint.Stiffness": { "documentation": "The torsional stiffness of the spring.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TorsionSpringConstraint#Stiffness", "code_sample": "" }, "@roblox/globaltype/NetworkClient": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkClient", "code_sample": "" }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionAccepted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionAccepted": { "documentation": "Fired when the client successfully connects to a server. Returns a string showing the server's IP and port, and the client's ClientReplicator.", "keys": { "Connect": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Connect", "ConnectParallel": "@roblox/globaltype/NetworkClient.ConnectionAccepted.ConnectParallel", "Once": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Once", "Wait": "@roblox/globaltype/NetworkClient.ConnectionAccepted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkClient#ConnectionAccepted", "code_sample": "" }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionFailed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionFailed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkClient.ConnectionFailed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkClient.ConnectionFailed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkClient.ConnectionFailed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NetworkClient.ConnectionFailed": { "documentation": "Fired if the client fails to connect to the server.", "keys": { "Connect": "@roblox/globaltype/NetworkClient.ConnectionFailed.Connect", "ConnectParallel": "@roblox/globaltype/NetworkClient.ConnectionFailed.ConnectParallel", "Once": "@roblox/globaltype/NetworkClient.ConnectionFailed.Once", "Wait": "@roblox/globaltype/NetworkClient.ConnectionFailed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkClient#ConnectionFailed", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience.", "keys": { "FinishRecording": "@roblox/globaltype/ChangeHistoryService.FinishRecording", "GetCanRedo": "@roblox/globaltype/ChangeHistoryService.GetCanRedo", "GetCanUndo": "@roblox/globaltype/ChangeHistoryService.GetCanUndo", "IsRecordingInProgress": "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress", "Redo": "@roblox/globaltype/ChangeHistoryService.Redo", "ResetWaypoints": "@roblox/globaltype/ChangeHistoryService.ResetWaypoints", "SetEnabled": "@roblox/globaltype/ChangeHistoryService.SetEnabled", "SetWaypoint": "@roblox/globaltype/ChangeHistoryService.SetWaypoint", "TryBeginRecording": "@roblox/globaltype/ChangeHistoryService.TryBeginRecording", "Undo": "@roblox/globaltype/ChangeHistoryService.Undo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/1": { "documentation": "Identifies the recording from the previous call to TryBeginRecording(). If the operation is ChangeHistoryService.FinishRecordingOperation.Cancel, this value is ignored, and the recording is determined by context." }, "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/2": { "documentation": "Specifies the operation to take." }, "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/3": { "documentation": "Optional table of values to pass to OnFinishRecording." }, "@roblox/globaltype/ChangeHistoryService.FinishRecording": { "documentation": "Communicates to Studio that the identified recording is finished and to take the final operation to complete the recording.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/0" }, { "name": "identifier", "documentation": "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/1" }, { "name": "operation", "documentation": "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/2" }, { "name": "finalOptions", "documentation": "@roblox/globaltype/ChangeHistoryService.FinishRecording/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#FinishRecording", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.GetCanRedo/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.GetCanRedo/return/0": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.GetCanRedo": { "documentation": "Returns whether there are actions that can be redone, and, if there are, returns the last of them.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.GetCanRedo/param/0" } ], "returns": [ "@roblox/globaltype/ChangeHistoryService.GetCanRedo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanRedo", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.GetCanUndo/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.GetCanUndo/return/0": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.GetCanUndo": { "documentation": "Returns whether there are actions that can be undone, and, if there are, returns the last of them.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.GetCanUndo/param/0" } ], "returns": [ "@roblox/globaltype/ChangeHistoryService.GetCanUndo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#GetCanUndo", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress/return/0": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress/param/0" }, { "name": "identifier", "documentation": "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress/param/1" } ], "returns": [ "@roblox/globaltype/ChangeHistoryService.IsRecordingInProgress/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#IsRecordingInProgress", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.Redo/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.Redo": { "documentation": "Executes the last action that was undone.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.Redo/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#Redo", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.ResetWaypoints/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.ResetWaypoints": { "documentation": "Clears the history, causing all undo/redo waypoints to be removed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.ResetWaypoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#ResetWaypoints", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.SetEnabled/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.SetEnabled/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.SetEnabled": { "documentation": "Sets whether or not the ChangeHistoryService is enabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.SetEnabled/param/0" }, { "name": "state", "documentation": "@roblox/globaltype/ChangeHistoryService.SetEnabled/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetEnabled", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.SetWaypoint/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.SetWaypoint/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.SetWaypoint": { "documentation": "Sets a new waypoint which can be used as an undo or redo point.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.SetWaypoint/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/ChangeHistoryService.SetWaypoint/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#SetWaypoint", "code_sample": "local ChangeHistoryService = game:GetService(\"ChangeHistoryService\")\nlocal Selection = game:GetService(\"Selection\")\n\nlocal toolbar = plugin:CreateToolbar(\"Example Plugin\")\nlocal button = toolbar:CreateButton(\"Neon it up\", \"\", \"\")\n\nbutton.Click:Connect(function()\n\tlocal parts = {}\n\tfor _, part in pairs(Selection:Get()) do\n\t\tif part:IsA(\"BasePart\") then\n\t\t\tparts[#parts + 1] = part\n\t\tend\n\tend\n\n\tif #parts > 0 then\n\t\t-- Calling SetWaypoint before the work will not cause any issues, however\n\t\t-- it is redundant, only the call AFTER the work is needed.\n\t\t--ChangeHistoryService:SetWaypoint(\"Setting selection to neon\")\n\n\t\tfor _, part in pairs(parts) do\n\t\t\tpart.Material = Enum.Material.Neon\n\t\tend\n\n\t\t-- Call SetWaypoint AFTER completing the work\n\t\tChangeHistoryService:SetWaypoint(\"Set selection to neon\")\n\telse\n\t\t-- Nothing to do. You do not need to call SetWaypoint in the case where\n\t\t-- the action did not end up making any changes to the experience.\n\tend\nend)" }, "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/param/1": { "documentation": "Name of the action being performed suitable for logging and coding purposes." }, "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/param/2": { "documentation": "Name of the action being performed to display to the user." }, "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/return/0": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.TryBeginRecording": { "documentation": "Begins tracking changes made to the data model into a recording.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/param/1" }, { "name": "displayName", "documentation": "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/param/2" } ], "returns": [ "@roblox/globaltype/ChangeHistoryService.TryBeginRecording/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#TryBeginRecording", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.Undo/param/0": { "documentation": "Must be used by plugins to communicate to Studio how to undo and redo the changes which they make to the experience." }, "@roblox/globaltype/ChangeHistoryService.Undo": { "documentation": "Undos the last action taken, for which there exists a waypoint.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.Undo/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#Undo", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished": { "documentation": "Fired when the user completes an action. Parameters come from TryBeginRecording() and FinishRecording().", "keys": { "Connect": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Connect", "ConnectParallel": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.ConnectParallel", "Once": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Once", "Wait": "@roblox/globaltype/ChangeHistoryService.OnRecordingFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#OnRecordingFinished", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted": { "documentation": "Fired when the user begins an action. Parameters come from TryBeginRecording().", "keys": { "Connect": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Connect", "ConnectParallel": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.ConnectParallel", "Once": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Once", "Wait": "@roblox/globaltype/ChangeHistoryService.OnRecordingStarted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#OnRecordingStarted", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRedo.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRedo.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRedo.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnRedo.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnRedo.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnRedo": { "documentation": "Fired when the user reverses the undo command. Waypoint describes the type action that has been redone.", "keys": { "Connect": "@roblox/globaltype/ChangeHistoryService.OnRedo.Connect", "ConnectParallel": "@roblox/globaltype/ChangeHistoryService.OnRedo.ConnectParallel", "Once": "@roblox/globaltype/ChangeHistoryService.OnRedo.Once", "Wait": "@roblox/globaltype/ChangeHistoryService.OnRedo.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#OnRedo", "code_sample": "" }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnUndo.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnUndo.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnUndo.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ChangeHistoryService.OnUndo.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChangeHistoryService.OnUndo.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ChangeHistoryService.OnUndo": { "documentation": "Fired when the user undoes an action in studio. Waypoint describes the type action that has been undone.", "keys": { "Connect": "@roblox/globaltype/ChangeHistoryService.OnUndo.Connect", "ConnectParallel": "@roblox/globaltype/ChangeHistoryService.OnUndo.ConnectParallel", "Once": "@roblox/globaltype/ChangeHistoryService.OnUndo.Once", "Wait": "@roblox/globaltype/ChangeHistoryService.OnUndo.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChangeHistoryService#OnUndo", "code_sample": "" }, "@roblox/globaltype/DistortionSoundEffect": { "documentation": "Distorts audio, making it sound fuzzier and overdriven.", "keys": { "Level": "@roblox/globaltype/DistortionSoundEffect.Level" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DistortionSoundEffect", "code_sample": "" }, "@roblox/globaltype/DistortionSoundEffect.Level": { "documentation": "The intensity of the effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DistortionSoundEffect#Level", "code_sample": "" }, "@roblox/globaltype/LogService": { "documentation": "A service that allows you to read outputted text.", "keys": { "ClearOutput": "@roblox/globaltype/LogService.ClearOutput", "GetLogHistory": "@roblox/globaltype/LogService.GetLogHistory" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LogService", "code_sample": "" }, "@roblox/globaltype/LogService.ClearOutput/param/0": { "documentation": "A service that allows you to read outputted text." }, "@roblox/globaltype/LogService.ClearOutput": { "documentation": "Clears the Roblox Studio output window.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LogService.ClearOutput/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LogService#ClearOutput", "code_sample": "" }, "@roblox/globaltype/LogService.GetLogHistory/param/0": { "documentation": "A service that allows you to read outputted text." }, "@roblox/globaltype/LogService.GetLogHistory/return/0": { "documentation": "" }, "@roblox/globaltype/LogService.GetLogHistory": { "documentation": "Returns a table of tables, each with the message string, message type, and timestamp of a message that the client displays in the output window.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LogService.GetLogHistory/param/0" } ], "returns": [ "@roblox/globaltype/LogService.GetLogHistory/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LogService#GetLogHistory", "code_sample": "" }, "@roblox/globaltype/LogService.MessageOut.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/LogService.MessageOut.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/LogService.MessageOut.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LogService.MessageOut.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/LogService.MessageOut.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/LogService.MessageOut.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/LogService.MessageOut.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/LogService.MessageOut.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LogService.MessageOut.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/LogService.MessageOut.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/LogService.MessageOut.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/LogService.MessageOut.Once/param/1": { "documentation": "" }, "@roblox/globaltype/LogService.MessageOut.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LogService.MessageOut.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/LogService.MessageOut.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/LogService.MessageOut.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/LogService.MessageOut.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LogService.MessageOut.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/LogService.MessageOut": { "documentation": "Fires when the client outputs text.", "keys": { "Connect": "@roblox/globaltype/LogService.MessageOut.Connect", "ConnectParallel": "@roblox/globaltype/LogService.MessageOut.ConnectParallel", "Once": "@roblox/globaltype/LogService.MessageOut.Once", "Wait": "@roblox/globaltype/LogService.MessageOut.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LogService#MessageOut", "code_sample": "" }, "@roblox/globaltype/PoseBase": { "documentation": "Base class of all 'Pose Instance' objects.", "keys": { "EasingDirection": "@roblox/globaltype/PoseBase.EasingDirection", "EasingStyle": "@roblox/globaltype/PoseBase.EasingStyle", "Weight": "@roblox/globaltype/PoseBase.Weight" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PoseBase", "code_sample": "" }, "@roblox/globaltype/PoseBase.EasingDirection": { "documentation": "The easing direction to use to reach the next Pose's value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PoseBase#EasingDirection", "code_sample": "" }, "@roblox/globaltype/PoseBase.EasingStyle": { "documentation": "The easing style to use to reach the next Pose's value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PoseBase#EasingStyle", "code_sample": "" }, "@roblox/globaltype/PoseBase.Weight": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PoseBase#Weight", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter": { "documentation": "A special object that emits customizable 2D particles into the world.", "keys": { "Acceleration": "@roblox/globaltype/ParticleEmitter.Acceleration", "Brightness": "@roblox/globaltype/ParticleEmitter.Brightness", "Color": "@roblox/globaltype/ParticleEmitter.Color", "Drag": "@roblox/globaltype/ParticleEmitter.Drag", "EmissionDirection": "@roblox/globaltype/ParticleEmitter.EmissionDirection", "Enabled": "@roblox/globaltype/ParticleEmitter.Enabled", "FlipbookFramerate": "@roblox/globaltype/ParticleEmitter.FlipbookFramerate", "FlipbookIncompatible": "@roblox/globaltype/ParticleEmitter.FlipbookIncompatible", "FlipbookLayout": "@roblox/globaltype/ParticleEmitter.FlipbookLayout", "FlipbookMode": "@roblox/globaltype/ParticleEmitter.FlipbookMode", "FlipbookSizeX": "@roblox/globaltype/ParticleEmitter.FlipbookSizeX", "FlipbookSizeY": "@roblox/globaltype/ParticleEmitter.FlipbookSizeY", "FlipbookStartRandom": "@roblox/globaltype/ParticleEmitter.FlipbookStartRandom", "Lifetime": "@roblox/globaltype/ParticleEmitter.Lifetime", "LightEmission": "@roblox/globaltype/ParticleEmitter.LightEmission", "LightInfluence": "@roblox/globaltype/ParticleEmitter.LightInfluence", "LocalTransparencyModifier": "@roblox/globaltype/ParticleEmitter.LocalTransparencyModifier", "LockedToPart": "@roblox/globaltype/ParticleEmitter.LockedToPart", "Orientation": "@roblox/globaltype/ParticleEmitter.Orientation", "Rate": "@roblox/globaltype/ParticleEmitter.Rate", "Rotation": "@roblox/globaltype/ParticleEmitter.Rotation", "RotSpeed": "@roblox/globaltype/ParticleEmitter.RotSpeed", "Shape": "@roblox/globaltype/ParticleEmitter.Shape", "ShapeInOut": "@roblox/globaltype/ParticleEmitter.ShapeInOut", "ShapePartial": "@roblox/globaltype/ParticleEmitter.ShapePartial", "ShapeStyle": "@roblox/globaltype/ParticleEmitter.ShapeStyle", "Size": "@roblox/globaltype/ParticleEmitter.Size", "Speed": "@roblox/globaltype/ParticleEmitter.Speed", "SpreadAngle": "@roblox/globaltype/ParticleEmitter.SpreadAngle", "Squash": "@roblox/globaltype/ParticleEmitter.Squash", "Texture": "@roblox/globaltype/ParticleEmitter.Texture", "TimeScale": "@roblox/globaltype/ParticleEmitter.TimeScale", "Transparency": "@roblox/globaltype/ParticleEmitter.Transparency", "VelocityInheritance": "@roblox/globaltype/ParticleEmitter.VelocityInheritance", "VelocitySpread": "@roblox/globaltype/ParticleEmitter.VelocitySpread", "WindAffectsDrag": "@roblox/globaltype/ParticleEmitter.WindAffectsDrag", "ZOffset": "@roblox/globaltype/ParticleEmitter.ZOffset", "Clear": "@roblox/globaltype/ParticleEmitter.Clear", "Emit": "@roblox/globaltype/ParticleEmitter.Emit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Acceleration": { "documentation": "Determines the global-axis acceleration of all active particles, measured in studs per second squared.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Acceleration", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Brightness": { "documentation": "Scales the light emitted from the emitter when ParticleEmitter.LightInfluence is 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Brightness", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Color": { "documentation": "Determines the color of all active particles over their individual lifetimes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Color", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Drag": { "documentation": "Determines the rate at which particles will lose half their speed through exponential decay.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Drag", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.EmissionDirection": { "documentation": "Determines the face of the object that particles emit from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#EmissionDirection", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Enabled": { "documentation": "Determines if particles emit from the emitter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Enabled", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookFramerate": { "documentation": "Determines how fast the flipbook texture animates in frames per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookFramerate", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookIncompatible": { "documentation": "The error message to display if the Texture is incompatible for a flipbook.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookIncompatible", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookLayout": { "documentation": "Determines the layout of the flipbook texture. Must be None, Grid2x2, Grid4x4, Grid8x8 or Custom.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookLayout", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookMode": { "documentation": "Determines the type of the flipbook animation. Must be Loop, OneShot, PingPong, or Random.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookMode", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookSizeX": { "documentation": "Defines the number of horizontal frames in a custom flipbook layout.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookSizeX", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookSizeY": { "documentation": "Defines the number of vertical frames in a custom flipbook layout.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookSizeY", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.FlipbookStartRandom": { "documentation": "Determines whether the animation starts at a random frame chosen per particle instead of always starting at frame zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#FlipbookStartRandom", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Lifetime": { "documentation": "Defines a random range of ages for newly emitted particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Lifetime", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.LightEmission": { "documentation": "Determines how much particles' colors are blended with the colors behind them.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#LightEmission", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.LightInfluence": { "documentation": "Determines how much particles are influenced by the environmental light.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#LightInfluence", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.LocalTransparencyModifier": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.LockedToPart": { "documentation": "Determines whether the particles rigidly move with the part they're being emitted from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#LockedToPart", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Orientation": { "documentation": "Specifies how to orient particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Orientation", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Rate": { "documentation": "Determines the number of particles emitted per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Rate", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Rotation": { "documentation": "Determines the range of rotations in degrees for newly emitted particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Rotation", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.RotSpeed": { "documentation": "Determines the range of angular speeds of emitted particles, measured in degrees per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#RotSpeed", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Shape": { "documentation": "Sets the shape of the emitter to either a box, sphere, cylinder, or disc.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Shape", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.ShapeInOut": { "documentation": "Sets whether particles emit outward only, inward only, or in both directions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#ShapeInOut", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.ShapePartial": { "documentation": "Influences particle emission from cylinder, disc, sphere, and box shapes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#ShapePartial", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.ShapeStyle": { "documentation": "Sets particle emission to either volumetric or surface-only emission.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#ShapeStyle", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Size": { "documentation": "Determines the world size over individual particles' lifetimes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Size", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Speed": { "documentation": "Determines a random range of velocities (minimum to maximum) at which new particles will emit, measured in studs per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Speed", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.SpreadAngle": { "documentation": "Determines the angles at which particles may be randomly emit, measured in degrees.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#SpreadAngle", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Squash": { "documentation": "Allows for non-uniform scaling of particles, curve-controlled over their lifetime.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Squash", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Texture": { "documentation": "Determines the image rendered on particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Texture", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.TimeScale": { "documentation": "Value between 0 and 1 that controls the speed of the particle effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#TimeScale", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Transparency": { "documentation": "Determines the transparency of particles over their individual lifetimes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Transparency", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.VelocityInheritance": { "documentation": "Determines how much of the parent's velocity is inherited by particles when emitted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#VelocityInheritance", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.VelocitySpread": { "documentation": "Deprecated: This property has been superseded by ParticleEmitter.SpreadAngle which should be used in all new work.
Determines how offset a particle can be fired from the local emitter direction of its parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#VelocitySpread", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.WindAffectsDrag": { "documentation": "Whether emitted particles follow the Workspace.GlobalWind vector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#WindAffectsDrag", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.ZOffset": { "documentation": "Determines the forward-backward render position of particles; used to control what particles render on top/bottom.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#ZOffset", "code_sample": "" }, "@roblox/globaltype/ParticleEmitter.Clear/param/0": { "documentation": "A special object that emits customizable 2D particles into the world." }, "@roblox/globaltype/ParticleEmitter.Clear": { "documentation": "Clears all particles that have been emitted.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ParticleEmitter.Clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Clear", "code_sample": "local emitter = script.Parent\nwhile true do\n\temitter:Clear()\n\temitter:Emit(10)\n\ttask.wait(2)\nend" }, "@roblox/globaltype/ParticleEmitter.Emit/param/0": { "documentation": "A special object that emits customizable 2D particles into the world." }, "@roblox/globaltype/ParticleEmitter.Emit/param/1": { "documentation": "The number of particles to emit." }, "@roblox/globaltype/ParticleEmitter.Emit": { "documentation": "Emits a given number of particles.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ParticleEmitter.Emit/param/0" }, { "name": "particleCount", "documentation": "@roblox/globaltype/ParticleEmitter.Emit/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ParticleEmitter#Emit", "code_sample": "local RunService = game:GetService(\"RunService\")\n\nlocal emitter = script.Parent\nlocal part = emitter.Parent\n\nlocal PARTICLES_PER_STUD = 3\n\nlocal lastPosition = part.Position\nlocal distance = 0\nlocal function onStep()\n\tlocal displacement = part.Position - lastPosition\n\tdistance = distance + displacement.magnitude\n\n\tlocal n = math.floor(distance * PARTICLES_PER_STUD)\n\temitter:Emit(n)\n\tdistance = distance - n / PARTICLES_PER_STUD\n\tlastPosition = part.Position\nend\n\nRunService.Stepped:Connect(onStep)\nemitter.Enabled = false" }, "@roblox/globaltype/ScrollingFrame": { "documentation": "ScrollingFrame is a special Frame type with built-in scrolling interactivity and different ways to customize how the scrolling works.", "keys": { "AbsoluteCanvasSize": "@roblox/globaltype/ScrollingFrame.AbsoluteCanvasSize", "AbsoluteWindowSize": "@roblox/globaltype/ScrollingFrame.AbsoluteWindowSize", "AutomaticCanvasSize": "@roblox/globaltype/ScrollingFrame.AutomaticCanvasSize", "BottomImage": "@roblox/globaltype/ScrollingFrame.BottomImage", "BottomImageContent": "@roblox/globaltype/ScrollingFrame.BottomImageContent", "CanvasPosition": "@roblox/globaltype/ScrollingFrame.CanvasPosition", "CanvasSize": "@roblox/globaltype/ScrollingFrame.CanvasSize", "ElasticBehavior": "@roblox/globaltype/ScrollingFrame.ElasticBehavior", "HorizontalScrollBarInset": "@roblox/globaltype/ScrollingFrame.HorizontalScrollBarInset", "MidImage": "@roblox/globaltype/ScrollingFrame.MidImage", "MidImageContent": "@roblox/globaltype/ScrollingFrame.MidImageContent", "ScrollBarImageColor3": "@roblox/globaltype/ScrollingFrame.ScrollBarImageColor3", "ScrollBarImageTransparency": "@roblox/globaltype/ScrollingFrame.ScrollBarImageTransparency", "ScrollBarThickness": "@roblox/globaltype/ScrollingFrame.ScrollBarThickness", "ScrollingDirection": "@roblox/globaltype/ScrollingFrame.ScrollingDirection", "ScrollingEnabled": "@roblox/globaltype/ScrollingFrame.ScrollingEnabled", "TopImage": "@roblox/globaltype/ScrollingFrame.TopImage", "TopImageContent": "@roblox/globaltype/ScrollingFrame.TopImageContent", "VerticalScrollBarInset": "@roblox/globaltype/ScrollingFrame.VerticalScrollBarInset", "VerticalScrollBarPosition": "@roblox/globaltype/ScrollingFrame.VerticalScrollBarPosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.AbsoluteCanvasSize": { "documentation": "The size of the area that is scrollable, in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#AbsoluteCanvasSize", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.AbsoluteWindowSize": { "documentation": "The size of the frame, in offsets, without the scroll bars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#AbsoluteWindowSize", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.AutomaticCanvasSize": { "documentation": "Determines whether ScrollingFrame.CanvasSize is resized based on child content.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#AutomaticCanvasSize", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.BottomImage": { "documentation": "Image that displays on the bottom of a vertical scroll bar, or the right of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#BottomImage", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.BottomImageContent": { "documentation": "Image that displays on the bottom of a vertical scroll bar, or the right of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar). Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#BottomImageContent", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.CanvasPosition": { "documentation": "Reflects the current positional offset of the canvas within the frame, in pixels, and sets the position of scroll bars accordingly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#CanvasPosition", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.CanvasSize": { "documentation": "Determines the size of the scrollable area.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#CanvasSize", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.ElasticBehavior": { "documentation": "Determines if and when elastic scrolling is allowed on touch‑enabled devices.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ElasticBehavior", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.HorizontalScrollBarInset": { "documentation": "Indicates whether CanvasSize is inset by ScrollBarThickness on the horizontal axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#HorizontalScrollBarInset", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.MidImage": { "documentation": "Image which spans the area between TopImage and BottomImage (rotated 90° counterclockwise for a horizontal scroll bar).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#MidImage", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.MidImageContent": { "documentation": "Image which spans the area between TopImageContent and BottomImageContent (rotated 90° counterclockwise for a horizontal scroll bar). Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#MidImageContent", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.ScrollBarImageColor3": { "documentation": "Determines how the rendered scroll bar images are colorized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ScrollBarImageColor3", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.ScrollBarImageTransparency": { "documentation": "Determines the opacity of the scroll bar images.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ScrollBarImageTransparency", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.ScrollBarThickness": { "documentation": "Thickness of the scroll bar in pixels; applies to both horizontal and vertical scroll bars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ScrollBarThickness", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.ScrollingDirection": { "documentation": "Determines the direction(s) in which scrolling is allowed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ScrollingDirection", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.ScrollingEnabled": { "documentation": "Determines whether scrolling is allowed on the frame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ScrollingEnabled", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.TopImage": { "documentation": "Image which displays on the top of a vertical scroll bar, or the left of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#TopImage", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.TopImageContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#TopImageContent", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.VerticalScrollBarInset": { "documentation": "Indicates whether CanvasSize is inset by ScrollBarThickness on the vertical axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#VerticalScrollBarInset", "code_sample": "" }, "@roblox/globaltype/ScrollingFrame.VerticalScrollBarPosition": { "documentation": "Indicates whether the vertical scroll bar is positioned to the left or right of the canvas.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#VerticalScrollBarPosition", "code_sample": "" }, "@roblox/globaltype/TerrainWriteOperation": { "documentation": "", "keys": { "CommitBlock": "@roblox/globaltype/TerrainWriteOperation.CommitBlock", "GetBlock": "@roblox/globaltype/TerrainWriteOperation.GetBlock" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation", "code_sample": "" }, "@roblox/globaltype/TerrainWriteOperation.CommitBlock/param/0": { "documentation": "" }, "@roblox/globaltype/TerrainWriteOperation.CommitBlock/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainWriteOperation.CommitBlock/return/0": { "documentation": "" }, "@roblox/globaltype/TerrainWriteOperation.CommitBlock": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainWriteOperation.CommitBlock/param/0" }, { "name": "block", "documentation": "@roblox/globaltype/TerrainWriteOperation.CommitBlock/param/1" } ], "returns": [ "@roblox/globaltype/TerrainWriteOperation.CommitBlock/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#CommitBlock", "code_sample": "" }, "@roblox/globaltype/TerrainWriteOperation.GetBlock/param/0": { "documentation": "" }, "@roblox/globaltype/TerrainWriteOperation.GetBlock/return/0": { "documentation": "" }, "@roblox/globaltype/TerrainWriteOperation.GetBlock": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainWriteOperation.GetBlock/param/0" } ], "returns": [ "@roblox/globaltype/TerrainWriteOperation.GetBlock/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainWriteOperation#GetBlock", "code_sample": "" }, "@roblox/globaltype/PackageService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageService", "code_sample": "" }, "@roblox/globaltype/SkateboardController": { "documentation": "", "keys": { "Steer": "@roblox/globaltype/SkateboardController.Steer", "Throttle": "@roblox/globaltype/SkateboardController.Throttle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardController", "code_sample": "" }, "@roblox/globaltype/SkateboardController.Steer": { "documentation": "The direction of movement, tied to the keys A and D. Must be 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardController#Steer", "code_sample": "" }, "@roblox/globaltype/SkateboardController.Throttle": { "documentation": "The direction of movement, tied to the keys W and S. Must be an integer 1 (forward), 0 (null), or -1 (reverse). Will refresh back to 0 unless constantly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardController#Throttle", "code_sample": "" }, "@roblox/globaltype/SkateboardController.AxisChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardController.AxisChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardController.AxisChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardController.AxisChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardController.AxisChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardController.AxisChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardController.AxisChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardController.AxisChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardController.AxisChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardController.AxisChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardController.AxisChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardController.AxisChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SkateboardController.AxisChanged": { "documentation": "Fired when any input state of the skateboard controller is updated.", "keys": { "Connect": "@roblox/globaltype/SkateboardController.AxisChanged.Connect", "ConnectParallel": "@roblox/globaltype/SkateboardController.AxisChanged.ConnectParallel", "Once": "@roblox/globaltype/SkateboardController.AxisChanged.Once", "Wait": "@roblox/globaltype/SkateboardController.AxisChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardController#AxisChanged", "code_sample": "" }, "@roblox/globaltype/DragDetector": { "documentation": "Instance which facilitates and encourages interaction with 3D objects in an experience.", "keys": { "ActivatedCursorIcon": "@roblox/globaltype/DragDetector.ActivatedCursorIcon", "ActivatedCursorIconContent": "@roblox/globaltype/DragDetector.ActivatedCursorIconContent", "ApplyAtCenterOfMass": "@roblox/globaltype/DragDetector.ApplyAtCenterOfMass", "Axis": "@roblox/globaltype/DragDetector.Axis", "DragFrame": "@roblox/globaltype/DragDetector.DragFrame", "DragStyle": "@roblox/globaltype/DragDetector.DragStyle", "Enabled": "@roblox/globaltype/DragDetector.Enabled", "GamepadModeSwitchKeyCode": "@roblox/globaltype/DragDetector.GamepadModeSwitchKeyCode", "KeyboardModeSwitchKeyCode": "@roblox/globaltype/DragDetector.KeyboardModeSwitchKeyCode", "MaxDragAngle": "@roblox/globaltype/DragDetector.MaxDragAngle", "MaxDragTranslation": "@roblox/globaltype/DragDetector.MaxDragTranslation", "MaxForce": "@roblox/globaltype/DragDetector.MaxForce", "MaxTorque": "@roblox/globaltype/DragDetector.MaxTorque", "MinDragAngle": "@roblox/globaltype/DragDetector.MinDragAngle", "MinDragTranslation": "@roblox/globaltype/DragDetector.MinDragTranslation", "Orientation": "@roblox/globaltype/DragDetector.Orientation", "PermissionPolicy": "@roblox/globaltype/DragDetector.PermissionPolicy", "ReferenceInstance": "@roblox/globaltype/DragDetector.ReferenceInstance", "ResponseStyle": "@roblox/globaltype/DragDetector.ResponseStyle", "Responsiveness": "@roblox/globaltype/DragDetector.Responsiveness", "RunLocally": "@roblox/globaltype/DragDetector.RunLocally", "SecondaryAxis": "@roblox/globaltype/DragDetector.SecondaryAxis", "TrackballRadialPullFactor": "@roblox/globaltype/DragDetector.TrackballRadialPullFactor", "TrackballRollFactor": "@roblox/globaltype/DragDetector.TrackballRollFactor", "VRSwitchKeyCode": "@roblox/globaltype/DragDetector.VRSwitchKeyCode", "WorldAxis": "@roblox/globaltype/DragDetector.WorldAxis", "WorldSecondaryAxis": "@roblox/globaltype/DragDetector.WorldSecondaryAxis", "AddConstraintFunction": "@roblox/globaltype/DragDetector.AddConstraintFunction", "GetReferenceFrame": "@roblox/globaltype/DragDetector.GetReferenceFrame", "RestartDrag": "@roblox/globaltype/DragDetector.RestartDrag", "SetDragStyleFunction": "@roblox/globaltype/DragDetector.SetDragStyleFunction", "SetPermissionPolicyFunction": "@roblox/globaltype/DragDetector.SetPermissionPolicyFunction" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector", "code_sample": "" }, "@roblox/globaltype/DragDetector.ActivatedCursorIcon": { "documentation": "Sets the cursor icon to display when the mouse is activated over the parent of this DragDetector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#ActivatedCursorIcon", "code_sample": "" }, "@roblox/globaltype/DragDetector.ActivatedCursorIconContent": { "documentation": "Sets the cursor icon to display when the mouse is activated over the parent of this DragDetector. Only supports asset URIs", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#ActivatedCursorIconContent", "code_sample": "" }, "@roblox/globaltype/DragDetector.ApplyAtCenterOfMass": { "documentation": "Whether constraint force is applied to the object's center of mass.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#ApplyAtCenterOfMass", "code_sample": "" }, "@roblox/globaltype/DragDetector.Axis": { "documentation": "The primary axis of motion, expressed relative to the reference frame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#Axis", "code_sample": "" }, "@roblox/globaltype/DragDetector.DragFrame": { "documentation": "The CFrame of the pivot, dependent on the drag detector's ReferenceInstance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragFrame", "code_sample": "" }, "@roblox/globaltype/DragDetector.DragStyle": { "documentation": "The paradigm used to generate proposed motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStyle", "code_sample": "" }, "@roblox/globaltype/DragDetector.Enabled": { "documentation": "Whether the DragDetector responds to user input.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#Enabled", "code_sample": "" }, "@roblox/globaltype/DragDetector.GamepadModeSwitchKeyCode": { "documentation": "During gamepad input, the modifier KeyCode for the secondary mode of motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#GamepadModeSwitchKeyCode", "code_sample": "" }, "@roblox/globaltype/DragDetector.KeyboardModeSwitchKeyCode": { "documentation": "During keyboard input, the modifier KeyCode for the secondary mode of motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#KeyboardModeSwitchKeyCode", "code_sample": "" }, "@roblox/globaltype/DragDetector.MaxDragAngle": { "documentation": "Along with MinDragAngle, impedes the drag detector's attempts to generate motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#MaxDragAngle", "code_sample": "" }, "@roblox/globaltype/DragDetector.MaxDragTranslation": { "documentation": "Along with MinDragTranslation, impedes the drag detector's attempts to generate motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#MaxDragTranslation", "code_sample": "" }, "@roblox/globaltype/DragDetector.MaxForce": { "documentation": "Maximum force applied for the object to reach its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#MaxForce", "code_sample": "" }, "@roblox/globaltype/DragDetector.MaxTorque": { "documentation": "Maximum torque applied for the object to reach its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#MaxTorque", "code_sample": "" }, "@roblox/globaltype/DragDetector.MinDragAngle": { "documentation": "Along with MaxDragAngle, impedes the drag detector's attempts to generate motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#MinDragAngle", "code_sample": "" }, "@roblox/globaltype/DragDetector.MinDragTranslation": { "documentation": "Along with MaxDragTranslation, impedes the drag detector's attempts to generate motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#MinDragTranslation", "code_sample": "" }, "@roblox/globaltype/DragDetector.Orientation": { "documentation": "Specifies the YXZ rotation of axes of motion relative to the reference frame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#Orientation", "code_sample": "" }, "@roblox/globaltype/DragDetector.PermissionPolicy": { "documentation": "Controls the permission level for which players can interact with the DragDetector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#PermissionPolicy", "code_sample": "" }, "@roblox/globaltype/DragDetector.ReferenceInstance": { "documentation": "An instance whose CFrame is the reference frame for the drag detector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#ReferenceInstance", "code_sample": "" }, "@roblox/globaltype/DragDetector.ResponseStyle": { "documentation": "The paradigm used to move, or not move, the objects affected by the drag detector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#ResponseStyle", "code_sample": "" }, "@roblox/globaltype/DragDetector.Responsiveness": { "documentation": "Higher values cause the object to reach its goal more rapidly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#Responsiveness", "code_sample": "" }, "@roblox/globaltype/DragDetector.RunLocally": { "documentation": "Whether user input on a DragDetector replicates to the server or remains local to the specific client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#RunLocally", "code_sample": "" }, "@roblox/globaltype/DragDetector.SecondaryAxis": { "documentation": "The secondary axis of the motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#SecondaryAxis", "code_sample": "" }, "@roblox/globaltype/DragDetector.TrackballRadialPullFactor": { "documentation": "If DragStyle is DragDetectorDragStyle.RotateTrackball, multiplier for adding a radial pull rotation as a contribution to the total.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#TrackballRadialPullFactor", "code_sample": "" }, "@roblox/globaltype/DragDetector.TrackballRollFactor": { "documentation": "If DragStyle is DragDetectorDragStyle.RotateTrackball, multiplier for adding roll rotation to the total.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#TrackballRollFactor", "code_sample": "" }, "@roblox/globaltype/DragDetector.VRSwitchKeyCode": { "documentation": "During VR input, the modifier KeyCode for the secondary mode of motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#VRSwitchKeyCode", "code_sample": "" }, "@roblox/globaltype/DragDetector.WorldAxis": { "documentation": "The Axis expressed in world space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#WorldAxis", "code_sample": "" }, "@roblox/globaltype/DragDetector.WorldSecondaryAxis": { "documentation": "The SecondaryAxis expressed in world space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#WorldSecondaryAxis", "code_sample": "" }, "@roblox/globaltype/DragDetector.AddConstraintFunction/param/0": { "documentation": "Instance which facilitates and encourages interaction with 3D objects in an experience." }, "@roblox/globaltype/DragDetector.AddConstraintFunction/param/1": { "documentation": "The order of priority for functions added via this method. Higher values take precedence over lower values." }, "@roblox/globaltype/DragDetector.AddConstraintFunction/param/2": { "documentation": "Function for modifying or constraining proposed motion. This function takes an input CFrame of proposed motion and returns a CFrame of modified or unmodified motion, both relative to the reference frame." }, "@roblox/globaltype/DragDetector.AddConstraintFunction/return/0": { "documentation": "Use this connection object to remove the constraint function." }, "@roblox/globaltype/DragDetector.AddConstraintFunction": { "documentation": "Adds a function to modify or constrain proposed motion.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.AddConstraintFunction/param/0" }, { "name": "priority", "documentation": "@roblox/globaltype/DragDetector.AddConstraintFunction/param/1" }, { "name": "function", "documentation": "@roblox/globaltype/DragDetector.AddConstraintFunction/param/2" } ], "returns": [ "@roblox/globaltype/DragDetector.AddConstraintFunction/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#AddConstraintFunction", "code_sample": "" }, "@roblox/globaltype/DragDetector.GetReferenceFrame/param/0": { "documentation": "Instance which facilitates and encourages interaction with 3D objects in an experience." }, "@roblox/globaltype/DragDetector.GetReferenceFrame/return/0": { "documentation": "The reference CFrame in which motion is expressed." }, "@roblox/globaltype/DragDetector.GetReferenceFrame": { "documentation": "Returns the reference CFrame in which motion is expressed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.GetReferenceFrame/param/0" } ], "returns": [ "@roblox/globaltype/DragDetector.GetReferenceFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#GetReferenceFrame", "code_sample": "" }, "@roblox/globaltype/DragDetector.RestartDrag/param/0": { "documentation": "Instance which facilitates and encourages interaction with 3D objects in an experience." }, "@roblox/globaltype/DragDetector.RestartDrag": { "documentation": "May be invoked from a script to restart the drag using new parameters.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.RestartDrag/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#RestartDrag", "code_sample": "" }, "@roblox/globaltype/DragDetector.SetDragStyleFunction/param/0": { "documentation": "Instance which facilitates and encourages interaction with 3D objects in an experience." }, "@roblox/globaltype/DragDetector.SetDragStyleFunction/param/1": { "documentation": "Function for monitoring DragContinue signals. This function receives the signal's world space cursor ray and it returns a CFrame containing the desired location and orientation of the pivot in world space. If this function returns nil, the object will not be moved." }, "@roblox/globaltype/DragDetector.SetDragStyleFunction": { "documentation": "Passes a function to be used if and only if DragStyle is set to DragDetectorDragStyle.Scriptable.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.SetDragStyleFunction/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/DragDetector.SetDragStyleFunction/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#SetDragStyleFunction", "code_sample": "" }, "@roblox/globaltype/DragDetector.SetPermissionPolicyFunction/param/0": { "documentation": "Instance which facilitates and encourages interaction with 3D objects in an experience." }, "@roblox/globaltype/DragDetector.SetPermissionPolicyFunction/param/1": { "documentation": "Function for setting the detector's interactivity. This function accepts a Player parameter for enabling/disabling the detector for a specific player. It also receives a part parameter indicating which specific BasePart was clicked, such as one part within a draggable Model; this is useful for enabling/disabling the detector based on that part's Name, Color, HasTag() value, or other details." }, "@roblox/globaltype/DragDetector.SetPermissionPolicyFunction": { "documentation": "Passes a function to be used if and only if PermissionPolicy is set to DragDetectorPermissionPolicy.Scriptable.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.SetPermissionPolicyFunction/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/DragDetector.SetPermissionPolicyFunction/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#SetPermissionPolicyFunction", "code_sample": "" }, "@roblox/globaltype/DragDetector.DragContinue.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragContinue.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragContinue.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragContinue.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragContinue.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragContinue.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragContinue.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragContinue.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragContinue.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragContinue.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragContinue.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragContinue.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragContinue.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragContinue.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragContinue.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragContinue.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragContinue.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragContinue.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragContinue": { "documentation": "Fires when a user continues dragging the object after DragStart has been initiated.", "keys": { "Connect": "@roblox/globaltype/DragDetector.DragContinue.Connect", "ConnectParallel": "@roblox/globaltype/DragDetector.DragContinue.ConnectParallel", "Once": "@roblox/globaltype/DragDetector.DragContinue.Once", "Wait": "@roblox/globaltype/DragDetector.DragContinue.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragContinue", "code_sample": "" }, "@roblox/globaltype/DragDetector.DragEnd.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragEnd.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragEnd.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragEnd.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragEnd.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragEnd.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragEnd.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragEnd.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragEnd.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragEnd.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragEnd.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragEnd.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragEnd.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragEnd.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragEnd.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragEnd.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragEnd.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragEnd.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragEnd": { "documentation": "Fires when a user stops dragging the object.", "keys": { "Connect": "@roblox/globaltype/DragDetector.DragEnd.Connect", "ConnectParallel": "@roblox/globaltype/DragDetector.DragEnd.ConnectParallel", "Once": "@roblox/globaltype/DragDetector.DragEnd.Once", "Wait": "@roblox/globaltype/DragDetector.DragEnd.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragEnd", "code_sample": "" }, "@roblox/globaltype/DragDetector.DragStart.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragStart.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragStart.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragStart.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragStart.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragStart.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragStart.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragStart.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragStart.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragStart.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragStart.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragStart.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DragDetector.DragStart.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragStart.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DragDetector.DragStart.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragStart.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DragDetector.DragStart.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DragDetector.DragStart.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DragDetector.DragStart": { "documentation": "Fires when a user starts dragging the object.", "keys": { "Connect": "@roblox/globaltype/DragDetector.DragStart.Connect", "ConnectParallel": "@roblox/globaltype/DragDetector.DragStart.ConnectParallel", "Once": "@roblox/globaltype/DragDetector.DragStart.Once", "Wait": "@roblox/globaltype/DragDetector.DragStart.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DragDetector#DragStart", "code_sample": "" }, "@roblox/globaltype/TextFilterTranslatedResult": { "documentation": "", "keys": { "SourceLanguage": "@roblox/globaltype/TextFilterTranslatedResult.SourceLanguage", "SourceText": "@roblox/globaltype/TextFilterTranslatedResult.SourceText", "GetTranslationForLocale": "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale", "GetTranslations": "@roblox/globaltype/TextFilterTranslatedResult.GetTranslations" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult", "code_sample": "" }, "@roblox/globaltype/TextFilterTranslatedResult.SourceLanguage": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult#SourceLanguage", "code_sample": "" }, "@roblox/globaltype/TextFilterTranslatedResult.SourceText": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult#SourceText", "code_sample": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale/param/0": { "documentation": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale/param/1": { "documentation": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale/return/0": { "documentation": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale/param/0" }, { "name": "locale", "documentation": "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale/param/1" } ], "returns": [ "@roblox/globaltype/TextFilterTranslatedResult.GetTranslationForLocale/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult#GetTranslationForLocale", "code_sample": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslations/param/0": { "documentation": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslations/return/0": { "documentation": "" }, "@roblox/globaltype/TextFilterTranslatedResult.GetTranslations": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextFilterTranslatedResult.GetTranslations/param/0" } ], "returns": [ "@roblox/globaltype/TextFilterTranslatedResult.GetTranslations/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterTranslatedResult#GetTranslations", "code_sample": "" }, "@roblox/globaltype/PitchShiftSoundEffect": { "documentation": "Adjusts the pitch of a sound without changing its playback speed.", "keys": { "Octave": "@roblox/globaltype/PitchShiftSoundEffect.Octave" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PitchShiftSoundEffect", "code_sample": "" }, "@roblox/globaltype/PitchShiftSoundEffect.Octave": { "documentation": "The percentage to shift the original pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PitchShiftSoundEffect#Octave", "code_sample": "" }, "@roblox/globaltype/ExperienceNotificationService": { "documentation": "Service containing methods to validate users and prompt them to enable experience notifications.", "keys": { "CanPromptOptInAsync": "@roblox/globaltype/ExperienceNotificationService.CanPromptOptInAsync", "PromptOptIn": "@roblox/globaltype/ExperienceNotificationService.PromptOptIn" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceNotificationService", "code_sample": "" }, "@roblox/globaltype/ExperienceNotificationService.CanPromptOptInAsync/param/0": { "documentation": "Service containing methods to validate users and prompt them to enable experience notifications." }, "@roblox/globaltype/ExperienceNotificationService.CanPromptOptInAsync/return/0": { "documentation": "Whether the local player can be prompted to enable notifications." }, "@roblox/globaltype/ExperienceNotificationService.CanPromptOptInAsync": { "documentation": "Indicates whether the local player can be prompted to enable notifications.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ExperienceNotificationService.CanPromptOptInAsync/param/0" } ], "returns": [ "@roblox/globaltype/ExperienceNotificationService.CanPromptOptInAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceNotificationService#CanPromptOptInAsync", "code_sample": "" }, "@roblox/globaltype/ExperienceNotificationService.PromptOptIn/param/0": { "documentation": "Service containing methods to validate users and prompt them to enable experience notifications." }, "@roblox/globaltype/ExperienceNotificationService.PromptOptIn": { "documentation": "Shows an in-experience prompt for the local player to enable notifications.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ExperienceNotificationService.PromptOptIn/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceNotificationService#PromptOptIn", "code_sample": "" }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed": { "documentation": "Fires when the local player closes the prompt.", "keys": { "Connect": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Connect", "ConnectParallel": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.ConnectParallel", "Once": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Once", "Wait": "@roblox/globaltype/ExperienceNotificationService.OptInPromptClosed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceNotificationService#OptInPromptClosed", "code_sample": "" }, "@roblox/globaltype/PluginGui": { "documentation": "", "keys": { "Title": "@roblox/globaltype/PluginGui.Title", "BindToClose": "@roblox/globaltype/PluginGui.BindToClose", "GetRelativeMousePosition": "@roblox/globaltype/PluginGui.GetRelativeMousePosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui", "code_sample": "" }, "@roblox/globaltype/PluginGui.Title": { "documentation": "The title that is displayed above the contents of the PluginGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#Title", "code_sample": "" }, "@roblox/globaltype/PluginGui.BindToClose/param/0": { "documentation": "" }, "@roblox/globaltype/PluginGui.BindToClose/param/1": { "documentation": "The function to bind the close button to. If no function is specified then any previously specified function will be unbound." }, "@roblox/globaltype/PluginGui.BindToClose": { "documentation": "Binds a function to the PluginGui close button, overriding the default behavior.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.BindToClose/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/PluginGui.BindToClose/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#BindToClose", "code_sample": "" }, "@roblox/globaltype/PluginGui.GetRelativeMousePosition/param/0": { "documentation": "" }, "@roblox/globaltype/PluginGui.GetRelativeMousePosition/return/0": { "documentation": "The screen position of the mouse relative to the PluginGui in pixels." }, "@roblox/globaltype/PluginGui.GetRelativeMousePosition": { "documentation": "Returns the position of the mouse relative to the PluginGui.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.GetRelativeMousePosition/param/0" } ], "returns": [ "@roblox/globaltype/PluginGui.GetRelativeMousePosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#GetRelativeMousePosition", "code_sample": "" }, "@roblox/globaltype/PluginGui.PluginDragDropped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragDropped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragDropped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragDropped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragDropped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragDropped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragDropped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragDropped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragDropped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragDropped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragDropped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragDropped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragDropped": { "documentation": "Fires when the user releases their mouse when hovering over a PluginGui during a drag operation started by Plugin:StartDrag().", "keys": { "Connect": "@roblox/globaltype/PluginGui.PluginDragDropped.Connect", "ConnectParallel": "@roblox/globaltype/PluginGui.PluginDragDropped.ConnectParallel", "Once": "@roblox/globaltype/PluginGui.PluginDragDropped.Once", "Wait": "@roblox/globaltype/PluginGui.PluginDragDropped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#PluginDragDropped", "code_sample": "" }, "@roblox/globaltype/PluginGui.PluginDragEntered.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragEntered.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragEntered.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragEntered.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragEntered.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragEntered.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragEntered.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragEntered.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragEntered.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragEntered.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragEntered.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragEntered.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragEntered": { "documentation": "Fires when the user's mouse enters a PluginGui during a drag operation started by Plugin:StartDrag().", "keys": { "Connect": "@roblox/globaltype/PluginGui.PluginDragEntered.Connect", "ConnectParallel": "@roblox/globaltype/PluginGui.PluginDragEntered.ConnectParallel", "Once": "@roblox/globaltype/PluginGui.PluginDragEntered.Once", "Wait": "@roblox/globaltype/PluginGui.PluginDragEntered.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#PluginDragEntered", "code_sample": "" }, "@roblox/globaltype/PluginGui.PluginDragLeft.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragLeft.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragLeft.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragLeft.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragLeft.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragLeft.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragLeft.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragLeft.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragLeft.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragLeft.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragLeft.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragLeft.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragLeft": { "documentation": "Fires when the user's mouse leaves a PluginGui during a drag operation started by Plugin:StartDrag().", "keys": { "Connect": "@roblox/globaltype/PluginGui.PluginDragLeft.Connect", "ConnectParallel": "@roblox/globaltype/PluginGui.PluginDragLeft.ConnectParallel", "Once": "@roblox/globaltype/PluginGui.PluginDragLeft.Once", "Wait": "@roblox/globaltype/PluginGui.PluginDragLeft.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#PluginDragLeft", "code_sample": "" }, "@roblox/globaltype/PluginGui.PluginDragMoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragMoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragMoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragMoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragMoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragMoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragMoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragMoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.PluginDragMoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragMoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.PluginDragMoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.PluginDragMoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginGui.PluginDragMoved": { "documentation": "Fires when the user's mouse moves within a PluginGui during a drag operation started by Plugin:StartDrag().", "keys": { "Connect": "@roblox/globaltype/PluginGui.PluginDragMoved.Connect", "ConnectParallel": "@roblox/globaltype/PluginGui.PluginDragMoved.ConnectParallel", "Once": "@roblox/globaltype/PluginGui.PluginDragMoved.Once", "Wait": "@roblox/globaltype/PluginGui.PluginDragMoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#PluginDragMoved", "code_sample": "" }, "@roblox/globaltype/PluginGui.WindowFocused.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocused.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.WindowFocused.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocused.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocused.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.WindowFocused.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocused.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocused.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.WindowFocused.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocused.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocused.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocused.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocused": { "documentation": "Fires when the user begins interacting with the window of the PluginGui.", "keys": { "Connect": "@roblox/globaltype/PluginGui.WindowFocused.Connect", "ConnectParallel": "@roblox/globaltype/PluginGui.WindowFocused.ConnectParallel", "Once": "@roblox/globaltype/PluginGui.WindowFocused.Once", "Wait": "@roblox/globaltype/PluginGui.WindowFocused.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#WindowFocused", "code_sample": "" }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocusReleased.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocusReleased.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.WindowFocusReleased.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginGui.WindowFocusReleased.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginGui.WindowFocusReleased.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginGui.WindowFocusReleased": { "documentation": "Fires when the user stops interacting with the window of the PluginGui.", "keys": { "Connect": "@roblox/globaltype/PluginGui.WindowFocusReleased.Connect", "ConnectParallel": "@roblox/globaltype/PluginGui.WindowFocusReleased.ConnectParallel", "Once": "@roblox/globaltype/PluginGui.WindowFocusReleased.Once", "Wait": "@roblox/globaltype/PluginGui.WindowFocusReleased.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGui#WindowFocusReleased", "code_sample": "" }, "@roblox/globaltype/Animator": { "documentation": "Responsible for the playback and replication of Animations.", "keys": { "EvaluationThrottled": "@roblox/globaltype/Animator.EvaluationThrottled", "PreferLodEnabled": "@roblox/globaltype/Animator.PreferLodEnabled", "RootMotion": "@roblox/globaltype/Animator.RootMotion", "RootMotionWeight": "@roblox/globaltype/Animator.RootMotionWeight", "ApplyJointVelocities": "@roblox/globaltype/Animator.ApplyJointVelocities", "GetPlayingAnimationTracks": "@roblox/globaltype/Animator.GetPlayingAnimationTracks", "LoadAnimation": "@roblox/globaltype/Animator.LoadAnimation", "RegisterEvaluationParallelCallback": "@roblox/globaltype/Animator.RegisterEvaluationParallelCallback", "StepAnimations": "@roblox/globaltype/Animator.StepAnimations" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator", "code_sample": "" }, "@roblox/globaltype/Animator.EvaluationThrottled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#EvaluationThrottled", "code_sample": "" }, "@roblox/globaltype/Animator.PreferLodEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#PreferLodEnabled", "code_sample": "" }, "@roblox/globaltype/Animator.RootMotion": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#RootMotion", "code_sample": "" }, "@roblox/globaltype/Animator.RootMotionWeight": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#RootMotionWeight", "code_sample": "" }, "@roblox/globaltype/Animator.ApplyJointVelocities/param/0": { "documentation": "Responsible for the playback and replication of Animations." }, "@roblox/globaltype/Animator.ApplyJointVelocities/param/1": { "documentation": "" }, "@roblox/globaltype/Animator.ApplyJointVelocities": { "documentation": "Computes relative velocities between parts and apply them to Motor6D.Part1. These relative velocity calculations and assignments happen in the order provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.ApplyJointVelocities/param/0" }, { "name": "motors", "documentation": "@roblox/globaltype/Animator.ApplyJointVelocities/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#ApplyJointVelocities", "code_sample": "" }, "@roblox/globaltype/Animator.GetPlayingAnimationTracks/param/0": { "documentation": "Responsible for the playback and replication of Animations." }, "@roblox/globaltype/Animator.GetPlayingAnimationTracks/return/0": { "documentation": "" }, "@roblox/globaltype/Animator.GetPlayingAnimationTracks": { "documentation": "Returns the list of currently playing AnimationTracks.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.GetPlayingAnimationTracks/param/0" } ], "returns": [ "@roblox/globaltype/Animator.GetPlayingAnimationTracks/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#GetPlayingAnimationTracks", "code_sample": "" }, "@roblox/globaltype/Animator.LoadAnimation/param/0": { "documentation": "Responsible for the playback and replication of Animations." }, "@roblox/globaltype/Animator.LoadAnimation/param/1": { "documentation": "The Animation to be used." }, "@roblox/globaltype/Animator.LoadAnimation/return/0": { "documentation": "" }, "@roblox/globaltype/Animator.LoadAnimation": { "documentation": "Loads an Animation onto an Animator, returning an AnimationTrack.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.LoadAnimation/param/0" }, { "name": "animation", "documentation": "@roblox/globaltype/Animator.LoadAnimation/param/1" } ], "returns": [ "@roblox/globaltype/Animator.LoadAnimation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#LoadAnimation", "code_sample": "" }, "@roblox/globaltype/Animator.RegisterEvaluationParallelCallback/param/0": { "documentation": "Responsible for the playback and replication of Animations." }, "@roblox/globaltype/Animator.RegisterEvaluationParallelCallback/param/1": { "documentation": "" }, "@roblox/globaltype/Animator.RegisterEvaluationParallelCallback": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.RegisterEvaluationParallelCallback/param/0" }, { "name": "callback", "documentation": "@roblox/globaltype/Animator.RegisterEvaluationParallelCallback/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#RegisterEvaluationParallelCallback", "code_sample": "" }, "@roblox/globaltype/Animator.StepAnimations/param/0": { "documentation": "Responsible for the playback and replication of Animations." }, "@roblox/globaltype/Animator.StepAnimations/param/1": { "documentation": "The amount of time in seconds animation playback is to be incremented by." }, "@roblox/globaltype/Animator.StepAnimations": { "documentation": "Increments the AnimationTrack.TimePosition of all playing AnimationTracks that are loaded onto the Animator, applying the offsets to the model associated with the Animator. For use in the command bar or by plugins only.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.StepAnimations/param/0" }, { "name": "deltaTime", "documentation": "@roblox/globaltype/Animator.StepAnimations/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#StepAnimations", "code_sample": "" }, "@roblox/globaltype/Animator.AnimationPlayed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Animator.AnimationPlayed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Animator.AnimationPlayed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Animator.AnimationPlayed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Animator.AnimationPlayed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Animator.AnimationPlayed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Animator.AnimationPlayed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Animator.AnimationPlayed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Animator.AnimationPlayed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Animator.AnimationPlayed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Animator.AnimationPlayed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Animator.AnimationPlayed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Animator.AnimationPlayed": { "documentation": "Fires when the Animator starts playing an AnimationTrack.", "keys": { "Connect": "@roblox/globaltype/Animator.AnimationPlayed.Connect", "ConnectParallel": "@roblox/globaltype/Animator.AnimationPlayed.ConnectParallel", "Once": "@roblox/globaltype/Animator.AnimationPlayed.Once", "Wait": "@roblox/globaltype/Animator.AnimationPlayed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animator#AnimationPlayed", "code_sample": "" }, "@roblox/globaltype/Fire": { "documentation": "A preconfigured particle emitter with the visual aesthetic of fire.", "keys": { "Color": "@roblox/globaltype/Fire.Color", "Enabled": "@roblox/globaltype/Fire.Enabled", "Heat": "@roblox/globaltype/Fire.Heat", "LocalTransparencyModifier": "@roblox/globaltype/Fire.LocalTransparencyModifier", "SecondaryColor": "@roblox/globaltype/Fire.SecondaryColor", "Size": "@roblox/globaltype/Fire.Size", "size": "@roblox/globaltype/Fire.size", "TimeScale": "@roblox/globaltype/Fire.TimeScale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire", "code_sample": "" }, "@roblox/globaltype/Fire.Color": { "documentation": "Determines the color of the primary (outer) flame particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#Color", "code_sample": "" }, "@roblox/globaltype/Fire.Enabled": { "documentation": "Determines whether flame particles are emit.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#Enabled", "code_sample": "" }, "@roblox/globaltype/Fire.Heat": { "documentation": "Determines the velocity at which particles are emit.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#Heat", "code_sample": "" }, "@roblox/globaltype/Fire.LocalTransparencyModifier": { "documentation": "A multiplier for the Fire object's transparency that is only visible to the local client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Fire.SecondaryColor": { "documentation": "Determines the color of the of the secondary (inner) flame particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#SecondaryColor", "code_sample": "" }, "@roblox/globaltype/Fire.Size": { "documentation": "Determines the size of the flame particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#Size", "code_sample": "" }, "@roblox/globaltype/Fire.size": { "documentation": "Deprecated: This property is a deprecated variant of Fire.Size which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#size", "code_sample": "" }, "@roblox/globaltype/Fire.TimeScale": { "documentation": "Controls the speed of the particle effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Fire#TimeScale", "code_sample": "" }, "@roblox/globaltype/ForceField": { "documentation": "Protects a Humanoid from taking damage dealt through the Humanoid:TakeDamage() method and protects BaseParts from having their joints broken due to an Explosion.", "keys": { "Visible": "@roblox/globaltype/ForceField.Visible" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ForceField", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal FORCE_FIELD_DURATION = 15\n\nlocal function giveForcefield(player, duration)\n\tlocal character = player.Character\n\tif character then\n\t\tlocal forceField = Instance.new(\"ForceField\")\n\t\tforceField.Visible = true\n\t\tforceField.Parent = character\n\t\tif duration then\n\t\t\ttask.delay(duration, function()\n\t\t\t\tif forceField then\n\t\t\t\t\tforceField:Destroy()\n\t\t\t\tend\n\t\t\tend)\n\t\tend\n\tend\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(function(_character)\n\t\tgiveForcefield(player, FORCE_FIELD_DURATION)\n\tend)\nend\n\nPlayers.PlayerAdded(onPlayerAdded)" }, "@roblox/globaltype/ForceField.Visible": { "documentation": "Determines whether or not the ForceField particle effect is visible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ForceField#Visible", "code_sample": "" }, "@roblox/globaltype/ClusterPacketCache": { "documentation": "An internal service meant to cache cluster packets.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClusterPacketCache", "code_sample": "" }, "@roblox/globaltype/HSRDataContentProvider": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HSRDataContentProvider", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataEnums": { "documentation": "Acts as a Folder for ReflectionMetadataEnum objects.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataEnums", "code_sample": "" }, "@roblox/globaltype/MemoryStoreHashMapPages": { "documentation": "A special type of Pages object whose pages contain key-value pairs from a MemoryStoreHashMap.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMapPages", "code_sample": "" }, "@roblox/globaltype/Visit": { "documentation": "The Visit service is a backend service used by Roblox. Its functions are not accessible to developers in any form.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Visit", "code_sample": "" }, "@roblox/globaltype/ControllerSensor": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerSensor", "code_sample": "" }, "@roblox/globaltype/TextFilterResult": { "documentation": "", "keys": { "GetChatForUserAsync": "@roblox/globaltype/TextFilterResult.GetChatForUserAsync", "GetNonChatStringForBroadcastAsync": "@roblox/globaltype/TextFilterResult.GetNonChatStringForBroadcastAsync", "GetNonChatStringForUserAsync": "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterResult", "code_sample": "" }, "@roblox/globaltype/TextFilterResult.GetChatForUserAsync/param/0": { "documentation": "" }, "@roblox/globaltype/TextFilterResult.GetChatForUserAsync/param/1": { "documentation": "Player.UserId of the user being chatted." }, "@roblox/globaltype/TextFilterResult.GetChatForUserAsync/return/0": { "documentation": "Filtered text string." }, "@roblox/globaltype/TextFilterResult.GetChatForUserAsync": { "documentation": "Deprecated: This method is deprecated and returns an empty string. Text filtering pertaining to chat should be done through TextChatService, and experiences that do not properly filter player-generated chat text may be subject to moderation.
Returns the text in a properly filtered manner for the specified Player.UserId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextFilterResult.GetChatForUserAsync/param/0" }, { "name": "toUserId", "documentation": "@roblox/globaltype/TextFilterResult.GetChatForUserAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextFilterResult.GetChatForUserAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterResult#GetChatForUserAsync", "code_sample": "" }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForBroadcastAsync/param/0": { "documentation": "" }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForBroadcastAsync/return/0": { "documentation": "Filtered text string." }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForBroadcastAsync": { "documentation": "Returns the text in a properly filtered manner for all users.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextFilterResult.GetNonChatStringForBroadcastAsync/param/0" } ], "returns": [ "@roblox/globaltype/TextFilterResult.GetNonChatStringForBroadcastAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterResult#GetNonChatStringForBroadcastAsync", "code_sample": "" }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync/param/0": { "documentation": "" }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync/param/1": { "documentation": "Player.UserId of the user intended to see/receive the text." }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync/return/0": { "documentation": "Filtered text string." }, "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync": { "documentation": "Returns the text in a properly filtered manner for the specified Player.UserId based on age and other details.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync/param/0" }, { "name": "toUserId", "documentation": "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextFilterResult.GetNonChatStringForUserAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextFilterResult#GetNonChatStringForUserAsync", "code_sample": "" }, "@roblox/globaltype/TrussPart": { "documentation": "Similar to a Part but with a different visual Style and the important distinction that default characters are able to climb it.", "keys": { "Style": "@roblox/globaltype/TrussPart.Style" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TrussPart", "code_sample": "" }, "@roblox/globaltype/TrussPart.Style": { "documentation": "Sets what the truss looks like.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TrussPart#Style", "code_sample": "" }, "@roblox/globaltype/ImageButton": { "documentation": "A 2D user interface element that displays an interactive image.", "keys": { "HoverImage": "@roblox/globaltype/ImageButton.HoverImage", "HoverImageContent": "@roblox/globaltype/ImageButton.HoverImageContent", "Image": "@roblox/globaltype/ImageButton.Image", "ImageColor3": "@roblox/globaltype/ImageButton.ImageColor3", "ImageContent": "@roblox/globaltype/ImageButton.ImageContent", "ImageRectOffset": "@roblox/globaltype/ImageButton.ImageRectOffset", "ImageRectSize": "@roblox/globaltype/ImageButton.ImageRectSize", "ImageTransparency": "@roblox/globaltype/ImageButton.ImageTransparency", "IsLoaded": "@roblox/globaltype/ImageButton.IsLoaded", "PressedImage": "@roblox/globaltype/ImageButton.PressedImage", "PressedImageContent": "@roblox/globaltype/ImageButton.PressedImageContent", "ResampleMode": "@roblox/globaltype/ImageButton.ResampleMode", "ScaleType": "@roblox/globaltype/ImageButton.ScaleType", "SliceCenter": "@roblox/globaltype/ImageButton.SliceCenter", "SliceScale": "@roblox/globaltype/ImageButton.SliceScale", "TileSize": "@roblox/globaltype/ImageButton.TileSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton", "code_sample": "" }, "@roblox/globaltype/ImageButton.HoverImage": { "documentation": "A texture ID that will be used when the ImageButton is being hovered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#HoverImage", "code_sample": "" }, "@roblox/globaltype/ImageButton.HoverImageContent": { "documentation": "The image content that will be used when the ImageButton is being hovered. Only supports asset URIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#HoverImageContent", "code_sample": "" }, "@roblox/globaltype/ImageButton.Image": { "documentation": "The image content displayed by the ImageButton element. Reads and writes to ImageContent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#Image", "code_sample": "local imageLabel = script.Parent\n\n-- The images in this example are 64x64\nimageLabel.Size = UDim2.new(0, 64, 0, 64)\n\nlocal function unlock()\n\timageLabel.Image = \"rbxassetid://284402785\" -- Unlocked padlock (64x64)\n\timageLabel.ImageColor3 = Color3.new(0, 0.5, 0) -- Dark green\nend\n\nlocal function lock()\n\timageLabel.Image = \"rbxassetid://284402752\" -- Locked padlock (64x64)\n\timageLabel.ImageColor3 = Color3.new(0.5, 0, 0) -- Dark red\nend\n\n-- Connect events; our default state is locked\nimageLabel.MouseEnter:Connect(unlock)\nimageLabel.MouseLeave:Connect(lock)\nlock()" }, "@roblox/globaltype/ImageButton.ImageColor3": { "documentation": "Determines how a rendered image will be colorized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageColor3", "code_sample": "local imageLabel = script.Parent\n\n-- The images in this example are 64x64\nimageLabel.Size = UDim2.new(0, 64, 0, 64)\n\nlocal function unlock()\n\timageLabel.Image = \"rbxassetid://284402785\" -- Unlocked padlock (64x64)\n\timageLabel.ImageColor3 = Color3.new(0, 0.5, 0) -- Dark green\nend\n\nlocal function lock()\n\timageLabel.Image = \"rbxassetid://284402752\" -- Locked padlock (64x64)\n\timageLabel.ImageColor3 = Color3.new(0.5, 0, 0) -- Dark red\nend\n\n-- Connect events; our default state is locked\nimageLabel.MouseEnter:Connect(unlock)\nimageLabel.MouseLeave:Connect(lock)\nlock()" }, "@roblox/globaltype/ImageButton.ImageContent": { "documentation": "The image content displayed by the UI element. Supports asset URIs and EditableImage objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageContent", "code_sample": "" }, "@roblox/globaltype/ImageButton.ImageRectOffset": { "documentation": "The offset in pixels of the sub-area of an image to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageRectOffset", "code_sample": "" }, "@roblox/globaltype/ImageButton.ImageRectSize": { "documentation": "Determines the size in pixels of the sub-area of an image to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageRectSize", "code_sample": "" }, "@roblox/globaltype/ImageButton.ImageTransparency": { "documentation": "Determines the transparency of the rendered image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ImageTransparency", "code_sample": "" }, "@roblox/globaltype/ImageButton.IsLoaded": { "documentation": "Indicates whether the Image has finished loading from the Roblox website.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#IsLoaded", "code_sample": "local imageLabel = script.Parent\n\nlocal startTime = workspace.DistributedGameTime\n\n-- Wait for the image to load\nwhile not imageLabel.IsLoaded do\n\ttask.wait()\nend\n\n-- Measure and display how long it took to load\nlocal deltaTime = workspace.DistributedGameTime - startTime\nprint((\"Image loaded in %.3f seconds\"):format(deltaTime))" }, "@roblox/globaltype/ImageButton.PressedImage": { "documentation": "A texture ID that will be used when an ImageButton is being pressed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#PressedImage", "code_sample": "" }, "@roblox/globaltype/ImageButton.PressedImageContent": { "documentation": "The image content that will be used when an ImageButton is being pressed. Only supports asset URIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#PressedImageContent", "code_sample": "" }, "@roblox/globaltype/ImageButton.ResampleMode": { "documentation": "Selects the image resampling mode for the button.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ResampleMode", "code_sample": "" }, "@roblox/globaltype/ImageButton.ScaleType": { "documentation": "Determines how an image will scale if displayed in a UI element whose size differs from the source image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#ScaleType", "code_sample": "" }, "@roblox/globaltype/ImageButton.SliceCenter": { "documentation": "Sets the slice boundaries of a 9-sliced image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#SliceCenter", "code_sample": "" }, "@roblox/globaltype/ImageButton.SliceScale": { "documentation": "Scales the 9-slice edges by the specified ratio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#SliceScale", "code_sample": "" }, "@roblox/globaltype/ImageButton.TileSize": { "documentation": "Sets the tiling scale of the ImageButton.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageButton#TileSize", "code_sample": "" }, "@roblox/globaltype/AudioGate": { "documentation": "", "keys": { "Attack": "@roblox/globaltype/AudioGate.Attack", "Bypass": "@roblox/globaltype/AudioGate.Bypass", "Release": "@roblox/globaltype/AudioGate.Release", "Threshold": "@roblox/globaltype/AudioGate.Threshold", "GetConnectedWires": "@roblox/globaltype/AudioGate.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioGate.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioGate.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate", "code_sample": "" }, "@roblox/globaltype/AudioGate.Attack": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#Attack", "code_sample": "" }, "@roblox/globaltype/AudioGate.Bypass": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioGate.Release": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#Release", "code_sample": "" }, "@roblox/globaltype/AudioGate.Threshold": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#Threshold", "code_sample": "" }, "@roblox/globaltype/AudioGate.GetConnectedWires/param/0": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetConnectedWires": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioGate.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioGate.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioGate.GetInputPins/param/0": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioGate.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioGate.GetOutputPins/param/0": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioGate.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioGate.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioGate.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioGate.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioGate.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioGate.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioGate.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioGate.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioGate.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioGate.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioGate.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioGate.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioGate.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioGate.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioGate.WiringChanged": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/AudioGate.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioGate.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioGate.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioGate.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioGate#WiringChanged", "code_sample": "" }, "@roblox/globaltype/RecommendationService": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations.", "keys": { "GenerateItemListAsync": "@roblox/globaltype/RecommendationService.GenerateItemListAsync", "GetRecommendationItemAsync": "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync", "LogActionEvent": "@roblox/globaltype/RecommendationService.LogActionEvent", "LogImpressionEvent": "@roblox/globaltype/RecommendationService.LogImpressionEvent", "RegisterItemAsync": "@roblox/globaltype/RecommendationService.RegisterItemAsync", "RemoveItemAsync": "@roblox/globaltype/RecommendationService.RemoveItemAsync", "UpdateItemAsync": "@roblox/globaltype/RecommendationService.UpdateItemAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService", "code_sample": "" }, "@roblox/globaltype/RecommendationService.GenerateItemListAsync/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.GenerateItemListAsync/param/1": { "documentation": "A dictionary containing the following fields: " }, "@roblox/globaltype/RecommendationService.GenerateItemListAsync/return/0": { "documentation": "" }, "@roblox/globaltype/RecommendationService.GenerateItemListAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.GenerateItemListAsync/param/0" }, { "name": "generateRecommendationItemListRequest", "documentation": "@roblox/globaltype/RecommendationService.GenerateItemListAsync/param/1" } ], "returns": [ "@roblox/globaltype/RecommendationService.GenerateItemListAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GenerateItemListAsync", "code_sample": "local RecommendationService = game:GetService(\"RecommendationService\")\n\n-- Define the request for generating a recommendation list\nlocal request: GenerateRecommendationItemListRequest = {\n\tConfigName = \"MaximizeEngagement\",\n\tLocationId = \"Lobby\",\n\tPageSize = 10\n -- NOTE: Uncomment and set CustomContexts.UserId for Server script. \n -- No need to set for Local script.\n -- CustomContexts = {\n -- [\"UserId\"] = tostring(player.UserId),\n -- }\n}\n\n-- Call GenerateItemListAsync to get the recommendation pages\nlocal success, recommendationPages = pcall(function()\n return RecommendationService:GenerateItemListAsync(request)\nend)" }, "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync/param/1": { "documentation": "The ID of the item to retrieve." }, "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync/return/0": { "documentation": "A dictionary representing the recommendation item with the following fields: " }, "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync/param/1" } ], "returns": [ "@roblox/globaltype/RecommendationService.GetRecommendationItemAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GetRecommendationItemAsync", "code_sample": "" }, "@roblox/globaltype/RecommendationService.LogActionEvent/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.LogActionEvent/param/1": { "documentation": "The enum for the type of action." }, "@roblox/globaltype/RecommendationService.LogActionEvent/param/2": { "documentation": "The item ID returned from registration and GenerateItemListAsync." }, "@roblox/globaltype/RecommendationService.LogActionEvent/param/3": { "documentation": "The tracing ID returned from the GenerateItemListAsync response. Each item has a TracingId." }, "@roblox/globaltype/RecommendationService.LogActionEvent/param/4": { "documentation": "A dictionary containing the following fields: " }, "@roblox/globaltype/RecommendationService.LogActionEvent": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.LogActionEvent/param/0" }, { "name": "actionType", "documentation": "@roblox/globaltype/RecommendationService.LogActionEvent/param/1" }, { "name": "itemId", "documentation": "@roblox/globaltype/RecommendationService.LogActionEvent/param/2" }, { "name": "tracingId", "documentation": "@roblox/globaltype/RecommendationService.LogActionEvent/param/3" }, { "name": "actionEventDetails", "documentation": "@roblox/globaltype/RecommendationService.LogActionEvent/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogActionEvent", "code_sample": "" }, "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/1": { "documentation": "The enum for the type of the impression." }, "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/2": { "documentation": "The item ID returned from registration and GenerateItemListAsync." }, "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/3": { "documentation": "The tracing ID returned from the GenerateItemListAsync response. Each item has a TracingId." }, "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/4": { "documentation": "A dictionary containing the following fields: " }, "@roblox/globaltype/RecommendationService.LogImpressionEvent": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/0" }, { "name": "impressionType", "documentation": "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/1" }, { "name": "itemId", "documentation": "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/2" }, { "name": "tracingId", "documentation": "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/3" }, { "name": "impressionEventDetails", "documentation": "@roblox/globaltype/RecommendationService.LogImpressionEvent/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogImpressionEvent", "code_sample": "" }, "@roblox/globaltype/RecommendationService.RegisterItemAsync/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.RegisterItemAsync/param/1": { "documentation": "The player who created the item." }, "@roblox/globaltype/RecommendationService.RegisterItemAsync/param/2": { "documentation": "A dictionary containing the following fields: " }, "@roblox/globaltype/RecommendationService.RegisterItemAsync/return/0": { "documentation": "A table with only two fields: ItemId and ReferenceId." }, "@roblox/globaltype/RecommendationService.RegisterItemAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.RegisterItemAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/RecommendationService.RegisterItemAsync/param/1" }, { "name": "registerRecommendationItemsRequest", "documentation": "@roblox/globaltype/RecommendationService.RegisterItemAsync/param/2" } ], "returns": [ "@roblox/globaltype/RecommendationService.RegisterItemAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync", "code_sample": "" }, "@roblox/globaltype/RecommendationService.RemoveItemAsync/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.RemoveItemAsync/param/1": { "documentation": "The itemId to remove." }, "@roblox/globaltype/RecommendationService.RemoveItemAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.RemoveItemAsync/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/RecommendationService.RemoveItemAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RemoveItemAsync", "code_sample": "" }, "@roblox/globaltype/RecommendationService.UpdateItemAsync/param/0": { "documentation": "A service that provides an interface for you to manage and display personalized content recommendations." }, "@roblox/globaltype/RecommendationService.UpdateItemAsync/param/1": { "documentation": "A dictionary containing the following fields: " }, "@roblox/globaltype/RecommendationService.UpdateItemAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RecommendationService.UpdateItemAsync/param/0" }, { "name": "updateRecommendationItemRequest", "documentation": "@roblox/globaltype/RecommendationService.UpdateItemAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationService#UpdateItemAsync", "code_sample": "" }, "@roblox/globaltype/Feature": { "documentation": "The base class for the legacy motor system.", "keys": { "FaceId": "@roblox/globaltype/Feature.FaceId", "InOut": "@roblox/globaltype/Feature.InOut", "LeftRight": "@roblox/globaltype/Feature.LeftRight", "TopBottom": "@roblox/globaltype/Feature.TopBottom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Feature", "code_sample": "" }, "@roblox/globaltype/Feature.FaceId": { "documentation": "Sets what side of the Parent the object is on.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Feature#FaceId", "code_sample": "" }, "@roblox/globaltype/Feature.InOut": { "documentation": "Controls how the Feature is positioned on it's parent's surface, in correspondence to the Feature's Feature.LeftRight and Feature.TopBottom properties.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Feature#InOut", "code_sample": "" }, "@roblox/globaltype/Feature.LeftRight": { "documentation": "Controls whether the feature is shifted to the left, center, or right on the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Feature#LeftRight", "code_sample": "" }, "@roblox/globaltype/Feature.TopBottom": { "documentation": "Controls whether the feature is shifted to the top, center, or bottom on the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Feature#TopBottom", "code_sample": "" }, "@roblox/globaltype/HeapProfilerService": { "documentation": "", "keys": { "ClientRequestDataAsync": "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync", "ServerRequestDataAsync": "@roblox/globaltype/HeapProfilerService.ServerRequestDataAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService", "code_sample": "" }, "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync/param/0": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync/param/1": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync/return/0": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync/param/1" } ], "returns": [ "@roblox/globaltype/HeapProfilerService.ClientRequestDataAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#ClientRequestDataAsync", "code_sample": "" }, "@roblox/globaltype/HeapProfilerService.ServerRequestDataAsync/param/0": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.ServerRequestDataAsync/return/0": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.ServerRequestDataAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HeapProfilerService.ServerRequestDataAsync/param/0" } ], "returns": [ "@roblox/globaltype/HeapProfilerService.ServerRequestDataAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#ServerRequestDataAsync", "code_sample": "" }, "@roblox/globaltype/HeapProfilerService.OnNewData.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HeapProfilerService.OnNewData.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.OnNewData.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HeapProfilerService.OnNewData.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HeapProfilerService.OnNewData.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.OnNewData.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HeapProfilerService.OnNewData.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HeapProfilerService.OnNewData.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HeapProfilerService.OnNewData.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HeapProfilerService.OnNewData.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HeapProfilerService.OnNewData.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HeapProfilerService.OnNewData.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HeapProfilerService.OnNewData": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/HeapProfilerService.OnNewData.Connect", "ConnectParallel": "@roblox/globaltype/HeapProfilerService.OnNewData.ConnectParallel", "Once": "@roblox/globaltype/HeapProfilerService.OnNewData.Once", "Wait": "@roblox/globaltype/HeapProfilerService.OnNewData.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HeapProfilerService#OnNewData", "code_sample": "" }, "@roblox/globaltype/Folder": { "documentation": "A simple container used to hold and organize Roblox instances.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Folder", "code_sample": "" }, "@roblox/globaltype/Model": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality.", "keys": { "LevelOfDetail": "@roblox/globaltype/Model.LevelOfDetail", "ModelStreamingMode": "@roblox/globaltype/Model.ModelStreamingMode", "PrimaryPart": "@roblox/globaltype/Model.PrimaryPart", "Scale": "@roblox/globaltype/Model.Scale", "WorldPivot": "@roblox/globaltype/Model.WorldPivot", "AddPersistentPlayer": "@roblox/globaltype/Model.AddPersistentPlayer", "BreakJoints": "@roblox/globaltype/Model.BreakJoints", "breakJoints": "@roblox/globaltype/Model.breakJoints", "GetBoundingBox": "@roblox/globaltype/Model.GetBoundingBox", "GetExtentsSize": "@roblox/globaltype/Model.GetExtentsSize", "GetModelCFrame": "@roblox/globaltype/Model.GetModelCFrame", "GetModelSize": "@roblox/globaltype/Model.GetModelSize", "GetPersistentPlayers": "@roblox/globaltype/Model.GetPersistentPlayers", "GetPrimaryPartCFrame": "@roblox/globaltype/Model.GetPrimaryPartCFrame", "GetScale": "@roblox/globaltype/Model.GetScale", "MakeJoints": "@roblox/globaltype/Model.MakeJoints", "makeJoints": "@roblox/globaltype/Model.makeJoints", "move": "@roblox/globaltype/Model.move", "MoveTo": "@roblox/globaltype/Model.MoveTo", "moveTo": "@roblox/globaltype/Model.moveTo", "RemovePersistentPlayer": "@roblox/globaltype/Model.RemovePersistentPlayer", "ResetOrientationToIdentity": "@roblox/globaltype/Model.ResetOrientationToIdentity", "ScaleTo": "@roblox/globaltype/Model.ScaleTo", "SetIdentityOrientation": "@roblox/globaltype/Model.SetIdentityOrientation", "SetPrimaryPartCFrame": "@roblox/globaltype/Model.SetPrimaryPartCFrame", "TranslateBy": "@roblox/globaltype/Model.TranslateBy" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model", "code_sample": "local function groupObjects(objectTable)\n\tlocal model = Instance.new(\"Model\")\n\tfor _, object in pairs(objectTable) do\n\t\tobject.Parent = model\n\tend\n\treturn model\nend\n\nlocal objects = {\n\tInstance.new(\"Part\"),\n\tInstance.new(\"Part\"),\n}\n\ngroupObjects(objects)" }, "@roblox/globaltype/Model.LevelOfDetail": { "documentation": "Sets the level of detail on the model for experiences with instance streaming enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#LevelOfDetail", "code_sample": "" }, "@roblox/globaltype/Model.ModelStreamingMode": { "documentation": "Controls the model streaming behavior on Models when instance streaming is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#ModelStreamingMode", "code_sample": "" }, "@roblox/globaltype/Model.PrimaryPart": { "documentation": "The primary part of the Model, or nil if not explicitly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#PrimaryPart", "code_sample": "" }, "@roblox/globaltype/Model.Scale": { "documentation": "Editor-only property used to scale the model around its pivot. Setting this property will move the scale as though Model:ScaleTo() was called on it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#Scale", "code_sample": "" }, "@roblox/globaltype/Model.WorldPivot": { "documentation": "Determines where the pivot of a Model which does not have a set Model.PrimaryPart is located.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#WorldPivot", "code_sample": "" }, "@roblox/globaltype/Model.AddPersistentPlayer/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.AddPersistentPlayer/param/1": { "documentation": "The Player to make this model persistent for." }, "@roblox/globaltype/Model.AddPersistentPlayer": { "documentation": "Sets this model to be persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of addition.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.AddPersistentPlayer/param/0" }, { "name": "playerInstance", "documentation": "@roblox/globaltype/Model.AddPersistentPlayer/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#AddPersistentPlayer", "code_sample": "" }, "@roblox/globaltype/Model.BreakJoints/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.BreakJoints": { "documentation": "Deprecated:
Breaks connections between BaseParts, including surface connections with any adjacent parts, WeldConstraints and all Welds and other JointInstances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.BreakJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#BreakJoints", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterAdded(character)\n\ttask.wait(3)\n\tcharacter:BreakJoints()\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Model.breakJoints/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.breakJoints": { "documentation": "Deprecated: This deprecated function is a variant of Model:BreakJoints() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.breakJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#breakJoints", "code_sample": "" }, "@roblox/globaltype/Model.GetBoundingBox/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetBoundingBox/return/0": { "documentation": "A CFrame representing the orientation of the volume followed by a Vector3 representing the size of the volume." }, "@roblox/globaltype/Model.GetBoundingBox": { "documentation": "Returns a description of a volume that contains all parts of a Model.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetBoundingBox/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetBoundingBox/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetBoundingBox", "code_sample": "" }, "@roblox/globaltype/Model.GetExtentsSize/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetExtentsSize/return/0": { "documentation": "The Vector3 extents size of the Model." }, "@roblox/globaltype/Model.GetExtentsSize": { "documentation": "Returns the size of the smallest bounding box that contains all of the BaseParts in the Model, aligned with the Model.PrimaryPart if it is set.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetExtentsSize/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetExtentsSize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetExtentsSize", "code_sample": "" }, "@roblox/globaltype/Model.GetModelCFrame/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetModelCFrame/return/0": { "documentation": "" }, "@roblox/globaltype/Model.GetModelCFrame": { "documentation": "Deprecated: This function has been deprecated as it did not provide reliable results. You can instead use Model:GetPrimaryPartCFrame() to retrieve the CFrame of the model's primary part.
This value historically returned the CFrame of a central position in the model.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetModelCFrame/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetModelCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetModelCFrame", "code_sample": "" }, "@roblox/globaltype/Model.GetModelSize/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetModelSize/return/0": { "documentation": "" }, "@roblox/globaltype/Model.GetModelSize": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work. Developers can instead use Model.GetExtentsSize.
Returns the Vector3 size of the Model.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetModelSize/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetModelSize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetModelSize", "code_sample": "" }, "@roblox/globaltype/Model.GetPersistentPlayers/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetPersistentPlayers/return/0": { "documentation": "A table with all the Player objects that this model object is persistent for." }, "@roblox/globaltype/Model.GetPersistentPlayers": { "documentation": "Returns all the Player objects that this model object is persistent for. Behavior varies based on whether this method is called from a Script or a LocalScript.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetPersistentPlayers/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetPersistentPlayers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetPersistentPlayers", "code_sample": "" }, "@roblox/globaltype/Model.GetPrimaryPartCFrame/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetPrimaryPartCFrame/return/0": { "documentation": "" }, "@roblox/globaltype/Model.GetPrimaryPartCFrame": { "documentation": "Deprecated:
Returns the CFrame of the model's Model.PrimaryPart. This function will throw an error if no primary part exists for the Model.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetPrimaryPartCFrame/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetPrimaryPartCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetPrimaryPartCFrame", "code_sample": "local START_POSITION = Vector3.new(0, 10, 0)\n\nlocal model = Instance.new(\"Model\")\n\nlocal part1 = Instance.new(\"Part\")\npart1.Size = Vector3.new(4, 4, 4)\npart1.CFrame = CFrame.new(START_POSITION)\npart1.Anchored = true\npart1.BrickColor = BrickColor.new(\"Bright yellow\")\npart1.Parent = model\n\nlocal part2 = Instance.new(\"Part\")\npart2.Size = Vector3.new(2, 2, 2)\npart2.CFrame = part1.CFrame * CFrame.new(0, 3, 0)\npart2.Anchored = true\npart2.BrickColor = BrickColor.new(\"Bright blue\")\npart2.Parent = model\n\n-- set the primary part\nmodel.PrimaryPart = part1\nmodel.Parent = workspace\n\nwhile true do\n\tlocal primaryPartCFrame = model:GetPrimaryPartCFrame()\n\tlocal newCFrame = primaryPartCFrame * CFrame.Angles(0, math.rad(1), 0)\n\tmodel:SetPrimaryPartCFrame(newCFrame)\n\ttask.wait()\nend" }, "@roblox/globaltype/Model.GetScale/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.GetScale/return/0": { "documentation": "The current canonical scale factor of the model." }, "@roblox/globaltype/Model.GetScale": { "documentation": "Returns the canonical scale of the model, which defaults to 1 for newly created models and will change as it is scaled via Model:ScaleTo().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.GetScale/param/0" } ], "returns": [ "@roblox/globaltype/Model.GetScale/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#GetScale", "code_sample": "local CollectionService = game:GetService(\"CollectionService\")\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\n\n-- Find all the models with the tag we want to replace\nlocal items = CollectionService:GetTagged(\"Tree\")\nlocal newModel = ReplicatedStorage.FancyTreeReplacementModel\nfor _, item in items do\n\t-- Make the new item and scale / position it where the old one was\n\tlocal newItem = newModel:Clone()\n\tnewItem:ScaleTo(item:GetScale())\n\tnewItem:PivotTo(item:GetPivot())\n\n\t-- Add the same tag to the replacement\n\tCollectionService:AddTag(newItem, \"Tree\")\n\n\t-- Delete the old item and parent the new one\n\tnewItem.Parent = item.Parent\n\titem:Destroy()\nend" }, "@roblox/globaltype/Model.MakeJoints/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.MakeJoints": { "documentation": "Deprecated: This joint type has been deprecated. Don't use it for new work. Use WeldConstraints and HingeConstraints instead.
Goes through all BaseParts in the Model. If any part's side has a SurfaceType that can make a joint it will create a joint with any adjacent parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.MakeJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#MakeJoints", "code_sample": "" }, "@roblox/globaltype/Model.makeJoints/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.makeJoints": { "documentation": "Deprecated: This deprecated function is a variant of Model:MakeJoints() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.makeJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#makeJoints", "code_sample": "" }, "@roblox/globaltype/Model.move/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.move/param/1": { "documentation": "" }, "@roblox/globaltype/Model.move": { "documentation": "Deprecated: This item has been superseded by Model:MoveTo() which should be used in all new work", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.move/param/0" }, { "name": "location", "documentation": "@roblox/globaltype/Model.move/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#move", "code_sample": "" }, "@roblox/globaltype/Model.MoveTo/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.MoveTo/param/1": { "documentation": "The Vector3 the Model is moved to." }, "@roblox/globaltype/Model.MoveTo": { "documentation": "Moves the PrimaryPart to the given position. If a primary part has not been specified, the root part of the model will be used.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.MoveTo/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/Model.MoveTo/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#MoveTo", "code_sample": "" }, "@roblox/globaltype/Model.moveTo/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.moveTo/param/1": { "documentation": "" }, "@roblox/globaltype/Model.moveTo": { "documentation": "Deprecated: This deprecated function is a variant of Model:MoveTo() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.moveTo/param/0" }, { "name": "location", "documentation": "@roblox/globaltype/Model.moveTo/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#moveTo", "code_sample": "" }, "@roblox/globaltype/Model.RemovePersistentPlayer/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.RemovePersistentPlayer/param/1": { "documentation": "The Player to make this model no longer persistent for." }, "@roblox/globaltype/Model.RemovePersistentPlayer": { "documentation": "Makes this model no longer persistent for the specified player. ModelStreamingMode must be set to PersistentPerPlayer for behavior to be changed as a result of removal.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.RemovePersistentPlayer/param/0" }, { "name": "playerInstance", "documentation": "@roblox/globaltype/Model.RemovePersistentPlayer/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#RemovePersistentPlayer", "code_sample": "" }, "@roblox/globaltype/Model.ResetOrientationToIdentity/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.ResetOrientationToIdentity": { "documentation": "Deprecated: This function has been deprecated; it remains to prevent legacy scripts from throwing errors, but it does nothing when called.
Resets the rotation of the model's parts to the previously set identity rotation, which is done through the Model:SetIdentityOrientation() method.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.ResetOrientationToIdentity/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#ResetOrientationToIdentity", "code_sample": "" }, "@roblox/globaltype/Model.ScaleTo/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.ScaleTo/param/1": { "documentation": "" }, "@roblox/globaltype/Model.ScaleTo": { "documentation": "Sets the scale factor of the model, adjusting the sizing and location of all descendant Instances such that they have that scale factor relative to their initial sizes and locations when scale factor was 1.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.ScaleTo/param/0" }, { "name": "newScaleFactor", "documentation": "@roblox/globaltype/Model.ScaleTo/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#ScaleTo", "code_sample": "" }, "@roblox/globaltype/Model.SetIdentityOrientation/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.SetIdentityOrientation": { "documentation": "Deprecated: This function has been deprecated; it remains to prevent legacy scripts from throwing errors, but it does nothing when called.
Sets the identity rotation of the given model, allowing you to reset the rotation of the entire model later, through the use of the ResetOrientationToIdentity method.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.SetIdentityOrientation/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#SetIdentityOrientation", "code_sample": "" }, "@roblox/globaltype/Model.SetPrimaryPartCFrame/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.SetPrimaryPartCFrame/param/1": { "documentation": "The CFrame to be set." }, "@roblox/globaltype/Model.SetPrimaryPartCFrame": { "documentation": "Deprecated:
Sets the BasePart.CFrame of the model's Model.PrimaryPart. All other parts in the model will also be moved and will maintain their orientation and offset respective to the Model.PrimaryPart.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.SetPrimaryPartCFrame/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/Model.SetPrimaryPartCFrame/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#SetPrimaryPartCFrame", "code_sample": "" }, "@roblox/globaltype/Model.TranslateBy/param/0": { "documentation": "Models are container objects, meaning they group objects together. They are best used to hold collections of BaseParts and have a number of functions that extend their functionality." }, "@roblox/globaltype/Model.TranslateBy/param/1": { "documentation": "The Vector3 to translate the Model by." }, "@roblox/globaltype/Model.TranslateBy": { "documentation": "Shifts a Model by the given Vector3 offset, preserving the model's orientation. If another BasePart or Terrain already exists at the new position then the Model will overlap said object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Model.TranslateBy/param/0" }, { "name": "delta", "documentation": "@roblox/globaltype/Model.TranslateBy/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Model#TranslateBy", "code_sample": "" }, "@roblox/globaltype/CFrameValue": { "documentation": "A container object for a single CFrame value.", "keys": { "Value": "@roblox/globaltype/CFrameValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CFrameValue", "code_sample": "-- Create a CFrame that stores the camera's current position/orientation\nlocal vSnapshot = Instance.new(\"CFrameValue\")\nvSnapshot.Value = workspace.CurrentCamera.CFrame\nvSnapshot.Name = \"Snapshot\"\nvSnapshot.Parent = workspace\n\n-- Later, we can load the CFrame back into the camera\nworkspace.CurrentCamera.CFrame = vSnapshot.Value" }, "@roblox/globaltype/CFrameValue.Value": { "documentation": "Used to hold a CFrame value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CFrameValue#Value", "code_sample": "" }, "@roblox/globaltype/CFrameValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CFrameValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CFrameValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CFrameValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CFrameValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CFrameValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CFrameValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.Changed": { "documentation": "Fired whenever the CFrameValue.Value of the CFrameValue is changed.", "keys": { "Connect": "@roblox/globaltype/CFrameValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/CFrameValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/CFrameValue.Changed.Once", "Wait": "@roblox/globaltype/CFrameValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CFrameValue#Changed", "code_sample": "local cframeValue = script.Parent.CFrameValue\n\ncframeValue.Changed:Connect(print)\n\ncframeValue.Value = CFrame.new(1, 2, 3)" }, "@roblox/globaltype/CFrameValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CFrameValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CFrameValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CFrameValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CFrameValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CFrameValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CFrameValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CFrameValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CFrameValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CFrameValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of CFrameValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/CFrameValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/CFrameValue.changed.ConnectParallel", "Once": "@roblox/globaltype/CFrameValue.changed.Once", "Wait": "@roblox/globaltype/CFrameValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CFrameValue#changed", "code_sample": "" }, "@roblox/globaltype/PluginCapabilities": { "documentation": "", "keys": { "Manifest": "@roblox/globaltype/PluginCapabilities.Manifest" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginCapabilities", "code_sample": "" }, "@roblox/globaltype/PluginCapabilities.Manifest": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginCapabilities#Manifest", "code_sample": "" }, "@roblox/globaltype/ServerStorage": { "documentation": "A container whose contents are only accessible on the server. Objects descending from ServerStorage will not replicate to the client and will not be accessible from LocalScripts.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServerStorage", "code_sample": "" }, "@roblox/globaltype/DepthOfFieldEffect": { "documentation": "Simulates a camera lens by blurring parts of a scene not in focus.", "keys": { "FarIntensity": "@roblox/globaltype/DepthOfFieldEffect.FarIntensity", "FocusDistance": "@roblox/globaltype/DepthOfFieldEffect.FocusDistance", "InFocusRadius": "@roblox/globaltype/DepthOfFieldEffect.InFocusRadius", "NearIntensity": "@roblox/globaltype/DepthOfFieldEffect.NearIntensity" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DepthOfFieldEffect", "code_sample": "" }, "@roblox/globaltype/DepthOfFieldEffect.FarIntensity": { "documentation": "Intensity of the far field blur.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DepthOfFieldEffect#FarIntensity", "code_sample": "" }, "@roblox/globaltype/DepthOfFieldEffect.FocusDistance": { "documentation": "Distance away from the camera where objects are in focus.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DepthOfFieldEffect#FocusDistance", "code_sample": "" }, "@roblox/globaltype/DepthOfFieldEffect.InFocusRadius": { "documentation": "Controls the distance away from the FocusDistance where no blur is applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DepthOfFieldEffect#InFocusRadius", "code_sample": "" }, "@roblox/globaltype/DepthOfFieldEffect.NearIntensity": { "documentation": "Intensity of the near field blur.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DepthOfFieldEffect#NearIntensity", "code_sample": "" }, "@roblox/globaltype/VirtualInputManager": { "documentation": "An internal service that offers no functionality to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VirtualInputManager", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration": { "documentation": "Configures properties of the default chat input bar.", "keys": { "AbsolutePosition": "@roblox/globaltype/ChatInputBarConfiguration.AbsolutePosition", "AbsoluteSize": "@roblox/globaltype/ChatInputBarConfiguration.AbsoluteSize", "AutocompleteEnabled": "@roblox/globaltype/ChatInputBarConfiguration.AutocompleteEnabled", "BackgroundColor3": "@roblox/globaltype/ChatInputBarConfiguration.BackgroundColor3", "BackgroundTransparency": "@roblox/globaltype/ChatInputBarConfiguration.BackgroundTransparency", "Enabled": "@roblox/globaltype/ChatInputBarConfiguration.Enabled", "FontFace": "@roblox/globaltype/ChatInputBarConfiguration.FontFace", "IsFocused": "@roblox/globaltype/ChatInputBarConfiguration.IsFocused", "KeyboardKeyCode": "@roblox/globaltype/ChatInputBarConfiguration.KeyboardKeyCode", "PlaceholderColor3": "@roblox/globaltype/ChatInputBarConfiguration.PlaceholderColor3", "TargetTextChannel": "@roblox/globaltype/ChatInputBarConfiguration.TargetTextChannel", "TextBox": "@roblox/globaltype/ChatInputBarConfiguration.TextBox", "TextColor3": "@roblox/globaltype/ChatInputBarConfiguration.TextColor3", "TextSize": "@roblox/globaltype/ChatInputBarConfiguration.TextSize", "TextStrokeColor3": "@roblox/globaltype/ChatInputBarConfiguration.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/ChatInputBarConfiguration.TextStrokeTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.AbsolutePosition": { "documentation": "Actual screen position of the default chat input bar in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#AbsolutePosition", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.AbsoluteSize": { "documentation": "Actual screen size of the default chat input bar in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#AbsoluteSize", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.AutocompleteEnabled": { "documentation": "Whether to enable autocomplete for the chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#AutocompleteEnabled", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.BackgroundColor3": { "documentation": "Background color of the default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#BackgroundColor3", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.BackgroundTransparency": { "documentation": "Background transparency of the default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#BackgroundTransparency", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.Enabled": { "documentation": "Whether to show the default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#Enabled", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.FontFace": { "documentation": "Font used to render text in the default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#FontFace", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.IsFocused": { "documentation": "Whether the default chat input bar is focused or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#IsFocused", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.KeyboardKeyCode": { "documentation": "Additional key users can press to trigger focusing on the default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#KeyboardKeyCode", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.PlaceholderColor3": { "documentation": "Color of the text of the placeholder text in the default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#PlaceholderColor3", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.TargetTextChannel": { "documentation": "A reference to the target TextChannel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#TargetTextChannel", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.TextBox": { "documentation": "Reference to a designated TextBox instance that sends messages on behalf of the user.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#TextBox", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.TextColor3": { "documentation": "Color of the text in default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#TextColor3", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.TextSize": { "documentation": "Size of the text in default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#TextSize", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.TextStrokeColor3": { "documentation": "Color of the text stroke for text in default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/ChatInputBarConfiguration.TextStrokeTransparency": { "documentation": "Transparency of the text stroke for text in default chat input bar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatInputBarConfiguration#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/Geometry": { "documentation": "An internal Roblox service which cannot be used by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Geometry", "code_sample": "" }, "@roblox/globaltype/SpecialMesh": { "documentation": "The SpecialMesh object applies a mesh to a BasePart depending on the MeshType property.", "keys": { "MeshType": "@roblox/globaltype/SpecialMesh.MeshType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpecialMesh", "code_sample": "" }, "@roblox/globaltype/SpecialMesh.MeshType": { "documentation": "Determines the type of mesh that will be applied to the BasePart the SpecialMesh is parented to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpecialMesh#MeshType", "code_sample": "" }, "@roblox/globaltype/BadgeService": { "documentation": "Provides information on badges and awards them.", "keys": { "AwardBadgeAsync": "@roblox/globaltype/BadgeService.AwardBadgeAsync", "AwardBadge": "@roblox/globaltype/BadgeService.AwardBadge", "CheckUserBadgesAsync": "@roblox/globaltype/BadgeService.CheckUserBadgesAsync", "GetBadgeInfoAsync": "@roblox/globaltype/BadgeService.GetBadgeInfoAsync", "IsDisabled": "@roblox/globaltype/BadgeService.IsDisabled", "IsLegal": "@roblox/globaltype/BadgeService.IsLegal", "UserHasBadge": "@roblox/globaltype/BadgeService.UserHasBadge", "UserHasBadgeAsync": "@roblox/globaltype/BadgeService.UserHasBadgeAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService", "code_sample": "" }, "@roblox/globaltype/BadgeService.AwardBadgeAsync/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.AwardBadgeAsync/param/1": { "documentation": "The Player.UserId of the user the badge is to be awarded to." }, "@roblox/globaltype/BadgeService.AwardBadgeAsync/param/2": { "documentation": "The ID of the badge to be awarded." }, "@roblox/globaltype/BadgeService.AwardBadgeAsync/return/0": { "documentation": "Boolean of true if the badge was awarded successfully." }, "@roblox/globaltype/BadgeService.AwardBadgeAsync": { "documentation": "Award a badge to a player given the ID of each.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.AwardBadgeAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/BadgeService.AwardBadgeAsync/param/1" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.AwardBadgeAsync/param/2" } ], "returns": [ "@roblox/globaltype/BadgeService.AwardBadgeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#AwardBadgeAsync", "code_sample": "" }, "@roblox/globaltype/BadgeService.AwardBadge/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.AwardBadge/param/1": { "documentation": "The Player.UserId of the user the badge is to be awarded to." }, "@roblox/globaltype/BadgeService.AwardBadge/param/2": { "documentation": "The ID of the badge to be awarded." }, "@roblox/globaltype/BadgeService.AwardBadge/return/0": { "documentation": "Boolean of true if the badge was awarded successfully." }, "@roblox/globaltype/BadgeService.AwardBadge": { "documentation": "Deprecated:
Award a badge to a player given the ID of each.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.AwardBadge/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/BadgeService.AwardBadge/param/1" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.AwardBadge/param/2" } ], "returns": [ "@roblox/globaltype/BadgeService.AwardBadge/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#AwardBadge", "code_sample": "" }, "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/param/1": { "documentation": "The UserId of the player to check for ownership of the specified badges." }, "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/param/2": { "documentation": "The list of IDs of the badges to check ownership of. Maximum length of 10." }, "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/return/0": { "documentation": "The list of badge IDs the given user owns out of the provided badge IDs. Empty if none of the provided badges are owned by the given user. Not guaranteed to be in the same order as the input list." }, "@roblox/globaltype/BadgeService.CheckUserBadgesAsync": { "documentation": "Checks a list of badge IDs against a UserId and returns a list of badge IDs that the player owns.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/param/1" }, { "name": "badgeIds", "documentation": "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/param/2" } ], "returns": [ "@roblox/globaltype/BadgeService.CheckUserBadgesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#CheckUserBadgesAsync", "code_sample": "" }, "@roblox/globaltype/BadgeService.GetBadgeInfoAsync/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.GetBadgeInfoAsync/param/1": { "documentation": "The badge ID of the badge whose information should be fetched." }, "@roblox/globaltype/BadgeService.GetBadgeInfoAsync/return/0": { "documentation": "A dictionary of information about the specified badge." }, "@roblox/globaltype/BadgeService.GetBadgeInfoAsync": { "documentation": "Fetch information about a badge given its ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.GetBadgeInfoAsync/param/0" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.GetBadgeInfoAsync/param/1" } ], "returns": [ "@roblox/globaltype/BadgeService.GetBadgeInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#GetBadgeInfoAsync", "code_sample": "" }, "@roblox/globaltype/BadgeService.IsDisabled/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.IsDisabled/param/1": { "documentation": "The ID of the badge." }, "@roblox/globaltype/BadgeService.IsDisabled/return/0": { "documentation": "True if the specified badge is not available to be awarded." }, "@roblox/globaltype/BadgeService.IsDisabled": { "documentation": "Deprecated: This function is deprecated. Do not use it for new work. Instead, it can be checked by calling BadgeService:GetBadgeInfoAsync() and checking the IsEnabled field.
Returns whether a given badge is disabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.IsDisabled/param/0" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.IsDisabled/param/1" } ], "returns": [ "@roblox/globaltype/BadgeService.IsDisabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#IsDisabled", "code_sample": "local BadgeService = game:GetService(\"BadgeService\")\n\nprint(BadgeService:IsDisabled(17468517))" }, "@roblox/globaltype/BadgeService.IsLegal/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.IsLegal/param/1": { "documentation": "The badge ID of the badge." }, "@roblox/globaltype/BadgeService.IsLegal/return/0": { "documentation": "True if the badge is associated with the current game." }, "@roblox/globaltype/BadgeService.IsLegal": { "documentation": "Deprecated: This function is deprecated and will always return true. Do not use it for new work.
Determines if a given badge is associated with the current game.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.IsLegal/param/0" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.IsLegal/param/1" } ], "returns": [ "@roblox/globaltype/BadgeService.IsLegal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#IsLegal", "code_sample": "" }, "@roblox/globaltype/BadgeService.UserHasBadge/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.UserHasBadge/param/1": { "documentation": "The user ID of the user." }, "@roblox/globaltype/BadgeService.UserHasBadge/param/2": { "documentation": "The badge ID of the badge." }, "@roblox/globaltype/BadgeService.UserHasBadge/return/0": { "documentation": "True if the user has the badge." }, "@roblox/globaltype/BadgeService.UserHasBadge": { "documentation": "Deprecated: This method has been superseded by BadgeService:UserHasBadgeAsync() which should be used for new instead.
Checks whether a user has the badge given the Player.UserId and the badge ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.UserHasBadge/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/BadgeService.UserHasBadge/param/1" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.UserHasBadge/param/2" } ], "returns": [ "@roblox/globaltype/BadgeService.UserHasBadge/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#UserHasBadge", "code_sample": "" }, "@roblox/globaltype/BadgeService.UserHasBadgeAsync/param/0": { "documentation": "Provides information on badges and awards them." }, "@roblox/globaltype/BadgeService.UserHasBadgeAsync/param/1": { "documentation": "The Player.UserId of the player to check for ownership of the specified badge." }, "@roblox/globaltype/BadgeService.UserHasBadgeAsync/param/2": { "documentation": "The badge ID of the badge whose ownership will be checked." }, "@roblox/globaltype/BadgeService.UserHasBadgeAsync/return/0": { "documentation": "Indicates if the specified user has the specified badge." }, "@roblox/globaltype/BadgeService.UserHasBadgeAsync": { "documentation": "Checks whether a player has the badge given the Player.UserId and the badge ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BadgeService.UserHasBadgeAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/BadgeService.UserHasBadgeAsync/param/1" }, { "name": "badgeId", "documentation": "@roblox/globaltype/BadgeService.UserHasBadgeAsync/param/2" } ], "returns": [ "@roblox/globaltype/BadgeService.UserHasBadgeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BadgeService#UserHasBadgeAsync", "code_sample": "local BadgeService = game:GetService(\"BadgeService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal badgeId = 00000000 -- Change this to your badge ID\n\nlocal function onPlayerAdded(player)\n\t-- Check if the player has the badge\n\tlocal success, hasBadge = pcall(function()\n\t\treturn BadgeService:UserHasBadgeAsync(player.UserId, badgeId)\n\tend)\n\n\t-- If there's an error, issue a warning and exit the function\n\tif not success then\n\t\twarn(\"Error while checking if player has badge!\")\n\t\treturn\n\tend\n\n\tif hasBadge then\n\t\t-- Handle player's badge ownership as needed\n\t\tprint(player.Name, \"has badge\", badgeId)\n\tend\nend\n\n-- Connect \"PlayerAdded\" events to the \"onPlayerAdded()\" function\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/BasePart": { "documentation": "The abstract base class for in-world objects that physically interact.", "keys": { "Anchored": "@roblox/globaltype/BasePart.Anchored", "AssemblyAngularVelocity": "@roblox/globaltype/BasePart.AssemblyAngularVelocity", "AssemblyCenterOfMass": "@roblox/globaltype/BasePart.AssemblyCenterOfMass", "AssemblyLinearVelocity": "@roblox/globaltype/BasePart.AssemblyLinearVelocity", "AssemblyMass": "@roblox/globaltype/BasePart.AssemblyMass", "AssemblyRootPart": "@roblox/globaltype/BasePart.AssemblyRootPart", "AudioCanCollide": "@roblox/globaltype/BasePart.AudioCanCollide", "BackParamA": "@roblox/globaltype/BasePart.BackParamA", "BackParamB": "@roblox/globaltype/BasePart.BackParamB", "BackSurface": "@roblox/globaltype/BasePart.BackSurface", "BackSurfaceInput": "@roblox/globaltype/BasePart.BackSurfaceInput", "BottomParamA": "@roblox/globaltype/BasePart.BottomParamA", "BottomParamB": "@roblox/globaltype/BasePart.BottomParamB", "BottomSurface": "@roblox/globaltype/BasePart.BottomSurface", "BottomSurfaceInput": "@roblox/globaltype/BasePart.BottomSurfaceInput", "BrickColor": "@roblox/globaltype/BasePart.BrickColor", "brickColor": "@roblox/globaltype/BasePart.brickColor", "CanCollide": "@roblox/globaltype/BasePart.CanCollide", "CanQuery": "@roblox/globaltype/BasePart.CanQuery", "CanTouch": "@roblox/globaltype/BasePart.CanTouch", "CastShadow": "@roblox/globaltype/BasePart.CastShadow", "CenterOfMass": "@roblox/globaltype/BasePart.CenterOfMass", "CFrame": "@roblox/globaltype/BasePart.CFrame", "CollisionGroup": "@roblox/globaltype/BasePart.CollisionGroup", "CollisionGroupId": "@roblox/globaltype/BasePart.CollisionGroupId", "Color": "@roblox/globaltype/BasePart.Color", "CurrentPhysicalProperties": "@roblox/globaltype/BasePart.CurrentPhysicalProperties", "CustomPhysicalProperties": "@roblox/globaltype/BasePart.CustomPhysicalProperties", "Elasticity": "@roblox/globaltype/BasePart.Elasticity", "EnableFluidForces": "@roblox/globaltype/BasePart.EnableFluidForces", "ExtentsCFrame": "@roblox/globaltype/BasePart.ExtentsCFrame", "ExtentsSize": "@roblox/globaltype/BasePart.ExtentsSize", "Friction": "@roblox/globaltype/BasePart.Friction", "FrontParamA": "@roblox/globaltype/BasePart.FrontParamA", "FrontParamB": "@roblox/globaltype/BasePart.FrontParamB", "FrontSurface": "@roblox/globaltype/BasePart.FrontSurface", "FrontSurfaceInput": "@roblox/globaltype/BasePart.FrontSurfaceInput", "LeftParamA": "@roblox/globaltype/BasePart.LeftParamA", "LeftParamB": "@roblox/globaltype/BasePart.LeftParamB", "LeftSurface": "@roblox/globaltype/BasePart.LeftSurface", "LeftSurfaceInput": "@roblox/globaltype/BasePart.LeftSurfaceInput", "LocalTransparencyModifier": "@roblox/globaltype/BasePart.LocalTransparencyModifier", "Locked": "@roblox/globaltype/BasePart.Locked", "Mass": "@roblox/globaltype/BasePart.Mass", "Massless": "@roblox/globaltype/BasePart.Massless", "Material": "@roblox/globaltype/BasePart.Material", "MaterialVariant": "@roblox/globaltype/BasePart.MaterialVariant", "Orientation": "@roblox/globaltype/BasePart.Orientation", "PivotOffset": "@roblox/globaltype/BasePart.PivotOffset", "Position": "@roblox/globaltype/BasePart.Position", "ReceiveAge": "@roblox/globaltype/BasePart.ReceiveAge", "Reflectance": "@roblox/globaltype/BasePart.Reflectance", "ResizeableFaces": "@roblox/globaltype/BasePart.ResizeableFaces", "ResizeIncrement": "@roblox/globaltype/BasePart.ResizeIncrement", "RightParamA": "@roblox/globaltype/BasePart.RightParamA", "RightParamB": "@roblox/globaltype/BasePart.RightParamB", "RightSurface": "@roblox/globaltype/BasePart.RightSurface", "RightSurfaceInput": "@roblox/globaltype/BasePart.RightSurfaceInput", "RootPriority": "@roblox/globaltype/BasePart.RootPriority", "Rotation": "@roblox/globaltype/BasePart.Rotation", "RotVelocity": "@roblox/globaltype/BasePart.RotVelocity", "Size": "@roblox/globaltype/BasePart.Size", "SpecificGravity": "@roblox/globaltype/BasePart.SpecificGravity", "TopParamA": "@roblox/globaltype/BasePart.TopParamA", "TopParamB": "@roblox/globaltype/BasePart.TopParamB", "TopSurface": "@roblox/globaltype/BasePart.TopSurface", "TopSurfaceInput": "@roblox/globaltype/BasePart.TopSurfaceInput", "Transparency": "@roblox/globaltype/BasePart.Transparency", "Velocity": "@roblox/globaltype/BasePart.Velocity", "AngularAccelerationToTorque": "@roblox/globaltype/BasePart.AngularAccelerationToTorque", "ApplyAngularImpulse": "@roblox/globaltype/BasePart.ApplyAngularImpulse", "ApplyImpulse": "@roblox/globaltype/BasePart.ApplyImpulse", "ApplyImpulseAtPosition": "@roblox/globaltype/BasePart.ApplyImpulseAtPosition", "BreakJoints": "@roblox/globaltype/BasePart.BreakJoints", "breakJoints": "@roblox/globaltype/BasePart.breakJoints", "CanCollideWith": "@roblox/globaltype/BasePart.CanCollideWith", "CanSetNetworkOwnership": "@roblox/globaltype/BasePart.CanSetNetworkOwnership", "GetClosestPointOnSurface": "@roblox/globaltype/BasePart.GetClosestPointOnSurface", "GetConnectedParts": "@roblox/globaltype/BasePart.GetConnectedParts", "GetJoints": "@roblox/globaltype/BasePart.GetJoints", "GetMass": "@roblox/globaltype/BasePart.GetMass", "getMass": "@roblox/globaltype/BasePart.getMass", "GetNetworkOwner": "@roblox/globaltype/BasePart.GetNetworkOwner", "GetNetworkOwnershipAuto": "@roblox/globaltype/BasePart.GetNetworkOwnershipAuto", "GetNoCollisionConstraints": "@roblox/globaltype/BasePart.GetNoCollisionConstraints", "GetRenderCFrame": "@roblox/globaltype/BasePart.GetRenderCFrame", "GetRootPart": "@roblox/globaltype/BasePart.GetRootPart", "GetTouchingParts": "@roblox/globaltype/BasePart.GetTouchingParts", "GetVelocityAtPosition": "@roblox/globaltype/BasePart.GetVelocityAtPosition", "IntersectAsync": "@roblox/globaltype/BasePart.IntersectAsync", "IsGrounded": "@roblox/globaltype/BasePart.IsGrounded", "MakeJoints": "@roblox/globaltype/BasePart.MakeJoints", "makeJoints": "@roblox/globaltype/BasePart.makeJoints", "Resize": "@roblox/globaltype/BasePart.Resize", "resize": "@roblox/globaltype/BasePart.resize", "SetNetworkOwner": "@roblox/globaltype/BasePart.SetNetworkOwner", "SetNetworkOwnershipAuto": "@roblox/globaltype/BasePart.SetNetworkOwnershipAuto", "SubtractAsync": "@roblox/globaltype/BasePart.SubtractAsync", "TorqueToAngularAcceleration": "@roblox/globaltype/BasePart.TorqueToAngularAcceleration", "UnionAsync": "@roblox/globaltype/BasePart.UnionAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart", "code_sample": "" }, "@roblox/globaltype/BasePart.Anchored": { "documentation": "Determines whether a part is immovable by physics.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Anchored", "code_sample": "local part = script.Parent\n\n-- Create a ClickDetector so we can tell when the part is clicked\nlocal cd = Instance.new(\"ClickDetector\", part)\n\n-- This function updates how the part looks based on its Anchored state\nlocal function updateVisuals()\n\tif part.Anchored then\n\t\t-- When the part is anchored...\n\t\tpart.BrickColor = BrickColor.new(\"Bright red\")\n\t\tpart.Material = Enum.Material.DiamondPlate\n\telse\n\t\t-- When the part is unanchored...\n\t\tpart.BrickColor = BrickColor.new(\"Bright yellow\")\n\t\tpart.Material = Enum.Material.Wood\n\tend\nend\n\nlocal function onToggle()\n\t-- Toggle the anchored property\n\tpart.Anchored = not part.Anchored\n\n\t-- Update visual state of the brick\n\tupdateVisuals()\nend\n\n-- Update, then start listening for clicks\nupdateVisuals()\ncd.MouseClick:Connect(onToggle)" }, "@roblox/globaltype/BasePart.AssemblyAngularVelocity": { "documentation": "The angular velocity of the part's assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AssemblyAngularVelocity", "code_sample": "" }, "@roblox/globaltype/BasePart.AssemblyCenterOfMass": { "documentation": "The center of mass of the part's assembly in world space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AssemblyCenterOfMass", "code_sample": "" }, "@roblox/globaltype/BasePart.AssemblyLinearVelocity": { "documentation": "The linear velocity of the part's assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AssemblyLinearVelocity", "code_sample": "" }, "@roblox/globaltype/BasePart.AssemblyMass": { "documentation": "The total mass of the part's assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AssemblyMass", "code_sample": "" }, "@roblox/globaltype/BasePart.AssemblyRootPart": { "documentation": "A reference to the root part of the assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AssemblyRootPart", "code_sample": "" }, "@roblox/globaltype/BasePart.AudioCanCollide": { "documentation": "Determines whether the part will physically interact with audio simulation, similar to CastShadow for lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AudioCanCollide", "code_sample": "" }, "@roblox/globaltype/BasePart.BackParamA": { "documentation": "Deprecated:
Determines the first parameter for the SurfaceType on the Back face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BackParamA", "code_sample": "" }, "@roblox/globaltype/BasePart.BackParamB": { "documentation": "Deprecated:
Determines the second parameter for the SurfaceType on the Back face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BackParamB", "code_sample": "" }, "@roblox/globaltype/BasePart.BackSurface": { "documentation": "Determines the type of surface for the back face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BackSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.BackSurfaceInput": { "documentation": "Deprecated:
Determines the kind of input for the Back face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BackSurfaceInput", "code_sample": "" }, "@roblox/globaltype/BasePart.BottomParamA": { "documentation": "Deprecated:
Determines the first parameter for the SurfaceType on the Bottom face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BottomParamA", "code_sample": "" }, "@roblox/globaltype/BasePart.BottomParamB": { "documentation": "Deprecated:
Determines the second parameter for the SurfaceType on the Bottom face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BottomParamB", "code_sample": "" }, "@roblox/globaltype/BasePart.BottomSurface": { "documentation": "Determines the type of surface for the bottom face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BottomSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.BottomSurfaceInput": { "documentation": "Deprecated:
Determines the kind of input for the Bottom face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BottomSurfaceInput", "code_sample": "" }, "@roblox/globaltype/BasePart.BrickColor": { "documentation": "Determines the color of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BrickColor", "code_sample": "" }, "@roblox/globaltype/BasePart.brickColor": { "documentation": "Deprecated: This deprecated property is an old Camel Case variant of the Pascal Case BasePart.BrickColor, which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#brickColor", "code_sample": "" }, "@roblox/globaltype/BasePart.CanCollide": { "documentation": "Determines whether a part may collide with other parts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CanCollide", "code_sample": "" }, "@roblox/globaltype/BasePart.CanQuery": { "documentation": "Determines whether the part is considered during spatial query operations.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CanQuery", "code_sample": "" }, "@roblox/globaltype/BasePart.CanTouch": { "documentation": "Determines if Touched and TouchEnded events fire on the part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CanTouch", "code_sample": "" }, "@roblox/globaltype/BasePart.CastShadow": { "documentation": "Determines whether or not a part casts a shadow.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CastShadow", "code_sample": "" }, "@roblox/globaltype/BasePart.CenterOfMass": { "documentation": "Describes the world position in which a part's center of mass is located.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CenterOfMass", "code_sample": "" }, "@roblox/globaltype/BasePart.CFrame": { "documentation": "Determines the position and orientation of the BasePart in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CFrame", "code_sample": "" }, "@roblox/globaltype/BasePart.CollisionGroup": { "documentation": "Describes the name of a part's collision group.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CollisionGroup", "code_sample": "" }, "@roblox/globaltype/BasePart.CollisionGroupId": { "documentation": "Deprecated:
Describes the automatically set ID number of a part's collision group.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CollisionGroupId", "code_sample": "" }, "@roblox/globaltype/BasePart.Color": { "documentation": "Determines the color of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Color", "code_sample": "" }, "@roblox/globaltype/BasePart.CurrentPhysicalProperties": { "documentation": "Indicates the current physical properties of the part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CurrentPhysicalProperties", "code_sample": "" }, "@roblox/globaltype/BasePart.CustomPhysicalProperties": { "documentation": "Determines several physical properties of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CustomPhysicalProperties", "code_sample": "" }, "@roblox/globaltype/BasePart.Elasticity": { "documentation": "Deprecated: This is only one of multiple physics-related properties. It has been deprecated in favor of BasePart.CustomPhysicalProperties, which combines these properties into one.
Used to control the Elasticity of the part, but it no longer does anything.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Elasticity", "code_sample": "" }, "@roblox/globaltype/BasePart.EnableFluidForces": { "documentation": "Used to enable or disable aerodynamic forces on parts and assemblies.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#EnableFluidForces", "code_sample": "" }, "@roblox/globaltype/BasePart.ExtentsCFrame": { "documentation": "The CFrame of the physical extents of the BasePart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ExtentsCFrame", "code_sample": "" }, "@roblox/globaltype/BasePart.ExtentsSize": { "documentation": "The actual physical size of the BasePart as regarded by the physics engine.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ExtentsSize", "code_sample": "" }, "@roblox/globaltype/BasePart.Friction": { "documentation": "Deprecated: This is only one of multiple physics-related properties. It has been deprecated in favor of BasePart.CustomPhysicalProperties, which combines these properties into one.
Used to control the Friction of the part, but now it no longer does anything.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Friction", "code_sample": "" }, "@roblox/globaltype/BasePart.FrontParamA": { "documentation": "Deprecated:
Determines the first parameter for the SurfaceType on the Front face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#FrontParamA", "code_sample": "" }, "@roblox/globaltype/BasePart.FrontParamB": { "documentation": "Deprecated:
Determines the second parameter for the SurfaceType on the Front face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#FrontParamB", "code_sample": "" }, "@roblox/globaltype/BasePart.FrontSurface": { "documentation": "Determines the type of surface for the front face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#FrontSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.FrontSurfaceInput": { "documentation": "Deprecated:
Determines the kind of input for the Front face of a part (-Z direction).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#FrontSurfaceInput", "code_sample": "" }, "@roblox/globaltype/BasePart.LeftParamA": { "documentation": "Deprecated:
Determines the first parameter for the SurfaceType on the Left face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#LeftParamA", "code_sample": "" }, "@roblox/globaltype/BasePart.LeftParamB": { "documentation": "Deprecated:
Determines the second parameter for the SurfaceType on the Left face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#LeftParamB", "code_sample": "" }, "@roblox/globaltype/BasePart.LeftSurface": { "documentation": "Determines the type of surface for the left face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#LeftSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.LeftSurfaceInput": { "documentation": "Deprecated:
Determines the kind of input for the Left face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#LeftSurfaceInput", "code_sample": "" }, "@roblox/globaltype/BasePart.LocalTransparencyModifier": { "documentation": "Determines a multiplier for BasePart.Transparency that is only visible to the local client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/BasePart.Locked": { "documentation": "Determines whether a part is selectable in Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Locked", "code_sample": "-- Paste into a Script within a Model you want to unlock\nlocal model = script.Parent\n\n-- This function recurses through a model's heirarchy and unlocks\n-- every part that it encounters.\nlocal function recursiveUnlock(object)\n\tif object:IsA(\"BasePart\") then\n\t\tobject.Locked = false\n\tend\n\n\t-- Call the same function on the children of the object\n\t-- The recursive process stops if an object has no children\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecursiveUnlock(child)\n\tend\nend\n\nrecursiveUnlock(model)" }, "@roblox/globaltype/BasePart.Mass": { "documentation": "Describes the mass of the part, the product of its density and volume.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Mass", "code_sample": "" }, "@roblox/globaltype/BasePart.Massless": { "documentation": "Determines whether the part contributes to the total mass or inertia of its rigid body.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Massless", "code_sample": "" }, "@roblox/globaltype/BasePart.Material": { "documentation": "Determines the texture and default physical properties of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Material", "code_sample": "" }, "@roblox/globaltype/BasePart.MaterialVariant": { "documentation": "The name of MaterialVariant.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#MaterialVariant", "code_sample": "" }, "@roblox/globaltype/BasePart.Orientation": { "documentation": "Describes the rotation of the part in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Orientation", "code_sample": "" }, "@roblox/globaltype/BasePart.PivotOffset": { "documentation": "Specifies the offset of the part's pivot from its CFrame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#PivotOffset", "code_sample": "" }, "@roblox/globaltype/BasePart.Position": { "documentation": "Describes the position of the part in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Position", "code_sample": "" }, "@roblox/globaltype/BasePart.ReceiveAge": { "documentation": "Time since last recorded physics update.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ReceiveAge", "code_sample": "" }, "@roblox/globaltype/BasePart.Reflectance": { "documentation": "Determines how much a part reflects the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Reflectance", "code_sample": "" }, "@roblox/globaltype/BasePart.ResizeableFaces": { "documentation": "Describes the faces on which a part may be resized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ResizeableFaces", "code_sample": "" }, "@roblox/globaltype/BasePart.ResizeIncrement": { "documentation": "Describes the smallest change in size allowable by the Resize() method.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ResizeIncrement", "code_sample": "" }, "@roblox/globaltype/BasePart.RightParamA": { "documentation": "Deprecated:
Determines the first parameter for the SurfaceType on the Right face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#RightParamA", "code_sample": "" }, "@roblox/globaltype/BasePart.RightParamB": { "documentation": "Deprecated:
Determines the second parameter for the SurfaceType on the Right face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#RightParamB", "code_sample": "" }, "@roblox/globaltype/BasePart.RightSurface": { "documentation": "Determines the type of surface for the right face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#RightSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.RightSurfaceInput": { "documentation": "Deprecated:
Determines the kind of input for the Right face of a part (-X direction).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#RightSurfaceInput", "code_sample": "" }, "@roblox/globaltype/BasePart.RootPriority": { "documentation": "The main rule in determining the root part of an assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#RootPriority", "code_sample": "" }, "@roblox/globaltype/BasePart.Rotation": { "documentation": "The rotation of the part in degrees for the three axes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Rotation", "code_sample": "" }, "@roblox/globaltype/BasePart.RotVelocity": { "documentation": "Deprecated: This property is deprecated. Use AssemblyAngularVelocity instead.
Determines a part's change in orientation over time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#RotVelocity", "code_sample": "local RunService = game:GetService(\"RunService\")\n\nlocal part = Instance.new(\"Part\")\npart.Name = \"RotatingPart\"\npart.Position = Vector3.new(0, 1, 0)\npart.Parent = workspace\n\nlocal function renderStepped()\n\tpart.RotVelocity = Vector3.new(0, 10, 0)\nend\n\nRunService.RenderStepped:Connect(renderStepped)" }, "@roblox/globaltype/BasePart.Size": { "documentation": "Determines the dimensions of a part (length, width, height).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Size", "code_sample": "local TOWER_BASE_SIZE = 30\n\nlocal position = Vector3.new(50, 50, 50)\n\nlocal hue = math.random()\nlocal color0 = Color3.fromHSV(hue, 1, 1)\nlocal color1 = Color3.fromHSV((hue + 0.35) % 1, 1, 1)\n\nlocal model = Instance.new(\"Model\")\nmodel.Name = \"Tower\"\n\nfor i = TOWER_BASE_SIZE, 1, -2 do\n\tlocal part = Instance.new(\"Part\")\n\tpart.Size = Vector3.new(i, 2, i)\n\tpart.Position = position\n\tpart.Anchored = true\n\tpart.Parent = model\n\t-- Tween from color0 and color1\n\tlocal perc = i / TOWER_BASE_SIZE\n\tpart.Color = Color3.new(\n\t\tcolor0.R * perc + color1.R * (1 - perc),\n\t\tcolor0.G * perc + color1.G * (1 - perc),\n\t\tcolor0.B * perc + color1.B * (1 - perc)\n\t)\n\n\tposition = position + Vector3.new(0, part.Size.Y, 0)\nend\nmodel.Parent = workspace" }, "@roblox/globaltype/BasePart.SpecificGravity": { "documentation": "Deprecated: This item is deprecated. See BasePart.CustomPhysicalProperties to see how to configure the physical properties of BaseParts. Do not use it for new work.
The ratio of the part's density to the density of water determined by the BasePart.Material.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#SpecificGravity", "code_sample": "" }, "@roblox/globaltype/BasePart.TopParamA": { "documentation": "Deprecated:
Determines the first parameter for the SurfaceType on the Top face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#TopParamA", "code_sample": "" }, "@roblox/globaltype/BasePart.TopParamB": { "documentation": "Deprecated:
Determines the second parameter for the SurfaceType on the Top face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#TopParamB", "code_sample": "" }, "@roblox/globaltype/BasePart.TopSurface": { "documentation": "Determines the type of surface for the top face of a part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#TopSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.TopSurfaceInput": { "documentation": "Deprecated:
Determines the kind of input for the Top face of a part (+Y direction).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#TopSurfaceInput", "code_sample": "" }, "@roblox/globaltype/BasePart.Transparency": { "documentation": "Determines how much a part can be seen through (the inverse of part opacity).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Transparency", "code_sample": "" }, "@roblox/globaltype/BasePart.Velocity": { "documentation": "Deprecated: This property is deprecated. Use AssemblyLinearVelocity instead.
Determines a part's change in position over time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Velocity", "code_sample": "" }, "@roblox/globaltype/BasePart.AngularAccelerationToTorque/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.AngularAccelerationToTorque/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.AngularAccelerationToTorque/param/2": { "documentation": "" }, "@roblox/globaltype/BasePart.AngularAccelerationToTorque/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.AngularAccelerationToTorque": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.AngularAccelerationToTorque/param/0" }, { "name": "angAcceleration", "documentation": "@roblox/globaltype/BasePart.AngularAccelerationToTorque/param/1" }, { "name": "angVelocity", "documentation": "@roblox/globaltype/BasePart.AngularAccelerationToTorque/param/2" } ], "returns": [ "@roblox/globaltype/BasePart.AngularAccelerationToTorque/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#AngularAccelerationToTorque", "code_sample": "" }, "@roblox/globaltype/BasePart.ApplyAngularImpulse/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.ApplyAngularImpulse/param/1": { "documentation": "An angular impulse vector to be applied to the assembly." }, "@roblox/globaltype/BasePart.ApplyAngularImpulse": { "documentation": "Apply an angular impulse to the assembly.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.ApplyAngularImpulse/param/0" }, { "name": "impulse", "documentation": "@roblox/globaltype/BasePart.ApplyAngularImpulse/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ApplyAngularImpulse", "code_sample": "" }, "@roblox/globaltype/BasePart.ApplyImpulse/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.ApplyImpulse/param/1": { "documentation": "A linear impulse vector to be applied to the assembly." }, "@roblox/globaltype/BasePart.ApplyImpulse": { "documentation": "Apply an impulse to the assembly at the assembly's center of mass.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.ApplyImpulse/param/0" }, { "name": "impulse", "documentation": "@roblox/globaltype/BasePart.ApplyImpulse/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ApplyImpulse", "code_sample": "" }, "@roblox/globaltype/BasePart.ApplyImpulseAtPosition/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.ApplyImpulseAtPosition/param/1": { "documentation": "An impulse vector to be applied to the assembly." }, "@roblox/globaltype/BasePart.ApplyImpulseAtPosition/param/2": { "documentation": "The position, in world space, to apply the impulse." }, "@roblox/globaltype/BasePart.ApplyImpulseAtPosition": { "documentation": "Apply an impulse to the assembly at specified position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.ApplyImpulseAtPosition/param/0" }, { "name": "impulse", "documentation": "@roblox/globaltype/BasePart.ApplyImpulseAtPosition/param/1" }, { "name": "position", "documentation": "@roblox/globaltype/BasePart.ApplyImpulseAtPosition/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#ApplyImpulseAtPosition", "code_sample": "" }, "@roblox/globaltype/BasePart.BreakJoints/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.BreakJoints": { "documentation": "Deprecated:
Breaks any surface connection with any adjacent part, including Weld and other JointInstance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.BreakJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#BreakJoints", "code_sample": "" }, "@roblox/globaltype/BasePart.breakJoints/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.breakJoints": { "documentation": "Deprecated: This deprecated function is a variant of BasePart:BreakJoints() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.breakJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#breakJoints", "code_sample": "" }, "@roblox/globaltype/BasePart.CanCollideWith/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.CanCollideWith/param/1": { "documentation": "The specified part being checked for collidability." }, "@roblox/globaltype/BasePart.CanCollideWith/return/0": { "documentation": "Whether the parts can collide with each other." }, "@roblox/globaltype/BasePart.CanCollideWith": { "documentation": "Returns whether the parts can collide with each other.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.CanCollideWith/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/BasePart.CanCollideWith/param/1" } ], "returns": [ "@roblox/globaltype/BasePart.CanCollideWith/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CanCollideWith", "code_sample": "" }, "@roblox/globaltype/BasePart.CanSetNetworkOwnership/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.CanSetNetworkOwnership/return/0": { "documentation": "Whether you can modify or read the network ownership and the reason." }, "@roblox/globaltype/BasePart.CanSetNetworkOwnership": { "documentation": "Checks whether you can set a part's network ownership.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.CanSetNetworkOwnership/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.CanSetNetworkOwnership/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#CanSetNetworkOwnership", "code_sample": "" }, "@roblox/globaltype/BasePart.GetClosestPointOnSurface/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetClosestPointOnSurface/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.GetClosestPointOnSurface/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.GetClosestPointOnSurface": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetClosestPointOnSurface/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/BasePart.GetClosestPointOnSurface/param/1" } ], "returns": [ "@roblox/globaltype/BasePart.GetClosestPointOnSurface/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetClosestPointOnSurface", "code_sample": "" }, "@roblox/globaltype/BasePart.GetConnectedParts/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetConnectedParts/param/1": { "documentation": "A table of parts connected to the object by any kind of joint." }, "@roblox/globaltype/BasePart.GetConnectedParts/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.GetConnectedParts": { "documentation": "Returns a table of parts connected to the object by any kind of rigid joint.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetConnectedParts/param/0" }, { "name": "recursive", "documentation": "@roblox/globaltype/BasePart.GetConnectedParts/param/1" } ], "returns": [ "@roblox/globaltype/BasePart.GetConnectedParts/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetConnectedParts", "code_sample": "" }, "@roblox/globaltype/BasePart.GetJoints/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetJoints/return/0": { "documentation": "An array of all Joints or Constraints connected to the Part." }, "@roblox/globaltype/BasePart.GetJoints": { "documentation": "Return all Joints or Constraints that is connected to this Part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetJoints/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetJoints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetJoints", "code_sample": "" }, "@roblox/globaltype/BasePart.GetMass/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetMass/return/0": { "documentation": "The part's mass." }, "@roblox/globaltype/BasePart.GetMass": { "documentation": "Returns the value of the Mass property.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetMass/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetMass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetMass", "code_sample": "local myPart = Instance.new(\"Part\")\nmyPart.Size = Vector3.new(4, 6, 4)\nmyPart.Anchored = true\nmyPart.Parent = workspace\n\nlocal myMass = myPart:GetMass()\n\nprint(\"My part's mass is \" .. myMass)" }, "@roblox/globaltype/BasePart.getMass/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.getMass/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.getMass": { "documentation": "Deprecated: This Camel Case property has been deprecated in favor of its Pascal Case variant, BasePart:GetMass().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.getMass/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.getMass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#getMass", "code_sample": "" }, "@roblox/globaltype/BasePart.GetNetworkOwner/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetNetworkOwner/return/0": { "documentation": "The current player who is the network owner of this part, or nil in case of the server." }, "@roblox/globaltype/BasePart.GetNetworkOwner": { "documentation": "Returns the current player who is the network owner of this part, or nil in case of the server.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetNetworkOwner/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetNetworkOwner/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetNetworkOwner", "code_sample": "" }, "@roblox/globaltype/BasePart.GetNetworkOwnershipAuto/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetNetworkOwnershipAuto/return/0": { "documentation": "Whether the game engine automatically decides the network owner for this part." }, "@roblox/globaltype/BasePart.GetNetworkOwnershipAuto": { "documentation": "Returns true if the game engine automatically decides the network owner for this part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetNetworkOwnershipAuto/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetNetworkOwnershipAuto/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetNetworkOwnershipAuto", "code_sample": "" }, "@roblox/globaltype/BasePart.GetNoCollisionConstraints/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetNoCollisionConstraints/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.GetNoCollisionConstraints": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetNoCollisionConstraints/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetNoCollisionConstraints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetNoCollisionConstraints", "code_sample": "" }, "@roblox/globaltype/BasePart.GetRenderCFrame/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetRenderCFrame/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.GetRenderCFrame": { "documentation": "Deprecated: This item is been deprecated since interpolation is now applied to the CFrame directly. Do not use it for new work.
OBSOLETE. Returns a CFrame describing where the part is being rendered at.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetRenderCFrame/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetRenderCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetRenderCFrame", "code_sample": "" }, "@roblox/globaltype/BasePart.GetRootPart/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetRootPart/return/0": { "documentation": "The base part of an assembly (a collection of parts connected together)." }, "@roblox/globaltype/BasePart.GetRootPart": { "documentation": "Deprecated:
Returns the base part of an assembly of parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetRootPart/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetRootPart/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetRootPart", "code_sample": "" }, "@roblox/globaltype/BasePart.GetTouchingParts/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetTouchingParts/return/0": { "documentation": "A table of all parts that intersect and can collide with this part." }, "@roblox/globaltype/BasePart.GetTouchingParts": { "documentation": "Returns a table of all BasePart.CanCollide true parts that intersect with this part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetTouchingParts/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.GetTouchingParts/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetTouchingParts", "code_sample": "" }, "@roblox/globaltype/BasePart.GetVelocityAtPosition/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.GetVelocityAtPosition/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.GetVelocityAtPosition/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.GetVelocityAtPosition": { "documentation": "Returns the linear velocity of the part's assembly at the given position relative to this part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.GetVelocityAtPosition/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/BasePart.GetVelocityAtPosition/param/1" } ], "returns": [ "@roblox/globaltype/BasePart.GetVelocityAtPosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#GetVelocityAtPosition", "code_sample": "" }, "@roblox/globaltype/BasePart.IntersectAsync/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.IntersectAsync/param/1": { "documentation": "The objects taking part in the intersection." }, "@roblox/globaltype/BasePart.IntersectAsync/param/2": { "documentation": "The CollisionFidelity value for the resulting IntersectOperation." }, "@roblox/globaltype/BasePart.IntersectAsync/param/3": { "documentation": "The RenderFidelity value of the resulting PartOperation." }, "@roblox/globaltype/BasePart.IntersectAsync/return/0": { "documentation": "Resulting IntersectOperation with default name Intersect." }, "@roblox/globaltype/BasePart.IntersectAsync": { "documentation": "Creates a new IntersectOperation from the overlapping geometry of the part and the other parts in the given array.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.IntersectAsync/param/0" }, { "name": "parts", "documentation": "@roblox/globaltype/BasePart.IntersectAsync/param/1" }, { "name": "collisionfidelity", "documentation": "@roblox/globaltype/BasePart.IntersectAsync/param/2" }, { "name": "renderFidelity", "documentation": "@roblox/globaltype/BasePart.IntersectAsync/param/3" } ], "returns": [ "@roblox/globaltype/BasePart.IntersectAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#IntersectAsync", "code_sample": "" }, "@roblox/globaltype/BasePart.IsGrounded/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.IsGrounded/return/0": { "documentation": "Whether the object is connected to a part that will hold it in place." }, "@roblox/globaltype/BasePart.IsGrounded": { "documentation": "Returns true if the object is connected to a part that will hold it in place (eg an Anchored part), otherwise returns false.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.IsGrounded/param/0" } ], "returns": [ "@roblox/globaltype/BasePart.IsGrounded/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#IsGrounded", "code_sample": "" }, "@roblox/globaltype/BasePart.MakeJoints/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.MakeJoints": { "documentation": "Deprecated: SurfaceType based joining is deprecated, do not use MakeJoints for new projects. WeldConstraints and HingeConstraints should be used instead.
Creates a joint on any side of the object that has a surface ID that can make a joint.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.MakeJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#MakeJoints", "code_sample": "" }, "@roblox/globaltype/BasePart.makeJoints/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.makeJoints": { "documentation": "Deprecated: This deprecated function is a variant of BasePart:MakeJoints() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.makeJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#makeJoints", "code_sample": "" }, "@roblox/globaltype/BasePart.Resize/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.Resize/param/1": { "documentation": "The side to resize." }, "@roblox/globaltype/BasePart.Resize/param/2": { "documentation": "How much to grow/shrink on the specified side." }, "@roblox/globaltype/BasePart.Resize/return/0": { "documentation": "Whether the part is resized." }, "@roblox/globaltype/BasePart.Resize": { "documentation": "Changes the size of an object just like using the Studio resize tool.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.Resize/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/BasePart.Resize/param/1" }, { "name": "deltaAmount", "documentation": "@roblox/globaltype/BasePart.Resize/param/2" } ], "returns": [ "@roblox/globaltype/BasePart.Resize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Resize", "code_sample": "" }, "@roblox/globaltype/BasePart.resize/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.resize/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.resize/param/2": { "documentation": "" }, "@roblox/globaltype/BasePart.resize/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.resize": { "documentation": "Deprecated: This deprecated function is a variant of BasePart:Resize() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.resize/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/BasePart.resize/param/1" }, { "name": "deltaAmount", "documentation": "@roblox/globaltype/BasePart.resize/param/2" } ], "returns": [ "@roblox/globaltype/BasePart.resize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#resize", "code_sample": "" }, "@roblox/globaltype/BasePart.SetNetworkOwner/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.SetNetworkOwner/param/1": { "documentation": "The player being given network ownership of the part." }, "@roblox/globaltype/BasePart.SetNetworkOwner": { "documentation": "Sets the given player as network owner for this and all connected parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.SetNetworkOwner/param/0" }, { "name": "playerInstance", "documentation": "@roblox/globaltype/BasePart.SetNetworkOwner/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#SetNetworkOwner", "code_sample": "" }, "@roblox/globaltype/BasePart.SetNetworkOwnershipAuto/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.SetNetworkOwnershipAuto": { "documentation": "Lets the game engine dynamically decide who will handle the part's physics (one of the clients or the server).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.SetNetworkOwnershipAuto/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#SetNetworkOwnershipAuto", "code_sample": "" }, "@roblox/globaltype/BasePart.SubtractAsync/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.SubtractAsync/param/1": { "documentation": "The objects taking part in the subtraction." }, "@roblox/globaltype/BasePart.SubtractAsync/param/2": { "documentation": "The CollisionFidelity value for the resulting UnionOperation." }, "@roblox/globaltype/BasePart.SubtractAsync/param/3": { "documentation": "The RenderFidelity value of the resulting PartOperation." }, "@roblox/globaltype/BasePart.SubtractAsync/return/0": { "documentation": "Resulting UnionOperation with default name Union." }, "@roblox/globaltype/BasePart.SubtractAsync": { "documentation": "Creates a new UnionOperation from the part, minus the geometry occupied by the parts in the given array.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.SubtractAsync/param/0" }, { "name": "parts", "documentation": "@roblox/globaltype/BasePart.SubtractAsync/param/1" }, { "name": "collisionfidelity", "documentation": "@roblox/globaltype/BasePart.SubtractAsync/param/2" }, { "name": "renderFidelity", "documentation": "@roblox/globaltype/BasePart.SubtractAsync/param/3" } ], "returns": [ "@roblox/globaltype/BasePart.SubtractAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#SubtractAsync", "code_sample": "" }, "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/param/2": { "documentation": "" }, "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/return/0": { "documentation": "" }, "@roblox/globaltype/BasePart.TorqueToAngularAcceleration": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/param/0" }, { "name": "torque", "documentation": "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/param/1" }, { "name": "angVelocity", "documentation": "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/param/2" } ], "returns": [ "@roblox/globaltype/BasePart.TorqueToAngularAcceleration/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#TorqueToAngularAcceleration", "code_sample": "" }, "@roblox/globaltype/BasePart.UnionAsync/param/0": { "documentation": "The abstract base class for in-world objects that physically interact." }, "@roblox/globaltype/BasePart.UnionAsync/param/1": { "documentation": "The objects taking part in the union with the calling part." }, "@roblox/globaltype/BasePart.UnionAsync/param/2": { "documentation": "The CollisionFidelity value for the resulting UnionOperation." }, "@roblox/globaltype/BasePart.UnionAsync/param/3": { "documentation": "The RenderFidelity value of the resulting PartOperation." }, "@roblox/globaltype/BasePart.UnionAsync/return/0": { "documentation": "Resulting UnionOperation with default name Union." }, "@roblox/globaltype/BasePart.UnionAsync": { "documentation": "Creates a new UnionOperation from the part, plus the geometry occupied by the parts in the given array.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.UnionAsync/param/0" }, { "name": "parts", "documentation": "@roblox/globaltype/BasePart.UnionAsync/param/1" }, { "name": "collisionfidelity", "documentation": "@roblox/globaltype/BasePart.UnionAsync/param/2" }, { "name": "renderFidelity", "documentation": "@roblox/globaltype/BasePart.UnionAsync/param/3" } ], "returns": [ "@roblox/globaltype/BasePart.UnionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#UnionAsync", "code_sample": "" }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.LocalSimulationTouched.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.LocalSimulationTouched.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.LocalSimulationTouched.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.LocalSimulationTouched.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.LocalSimulationTouched.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BasePart.LocalSimulationTouched": { "documentation": "Deprecated: This event is deprecated in favor of BasePart.Touched.", "keys": { "Connect": "@roblox/globaltype/BasePart.LocalSimulationTouched.Connect", "ConnectParallel": "@roblox/globaltype/BasePart.LocalSimulationTouched.ConnectParallel", "Once": "@roblox/globaltype/BasePart.LocalSimulationTouched.Once", "Wait": "@roblox/globaltype/BasePart.LocalSimulationTouched.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#LocalSimulationTouched", "code_sample": "workspace.Part.LocalSimulationTouched:Connect(function(part)\n\tprint(part.Name)\nend)" }, "@roblox/globaltype/BasePart.OutfitChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.OutfitChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.OutfitChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.OutfitChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.OutfitChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.OutfitChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.OutfitChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.OutfitChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.OutfitChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.OutfitChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.OutfitChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.OutfitChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BasePart.OutfitChanged": { "documentation": "Deprecated: This event is deprecated. Do not use it for new work.", "keys": { "Connect": "@roblox/globaltype/BasePart.OutfitChanged.Connect", "ConnectParallel": "@roblox/globaltype/BasePart.OutfitChanged.ConnectParallel", "Once": "@roblox/globaltype/BasePart.OutfitChanged.Once", "Wait": "@roblox/globaltype/BasePart.OutfitChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#OutfitChanged", "code_sample": "" }, "@roblox/globaltype/BasePart.StoppedTouching.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.StoppedTouching.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.StoppedTouching.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.StoppedTouching.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.StoppedTouching.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.StoppedTouching.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.StoppedTouching.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.StoppedTouching.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.StoppedTouching.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.StoppedTouching.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.StoppedTouching.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.StoppedTouching.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BasePart.StoppedTouching": { "documentation": "Deprecated: This event is deprecated in favor of BasePart.TouchEnded, which should be used instead.", "keys": { "Connect": "@roblox/globaltype/BasePart.StoppedTouching.Connect", "ConnectParallel": "@roblox/globaltype/BasePart.StoppedTouching.ConnectParallel", "Once": "@roblox/globaltype/BasePart.StoppedTouching.Once", "Wait": "@roblox/globaltype/BasePart.StoppedTouching.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#StoppedTouching", "code_sample": "" }, "@roblox/globaltype/BasePart.Touched.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.Touched.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.Touched.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.Touched.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.Touched.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.Touched.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.Touched.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.Touched.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.Touched.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.Touched.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.Touched.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.Touched.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.Touched.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.Touched.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.Touched.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.Touched.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.Touched.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.Touched.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BasePart.Touched": { "documentation": "Fires when a part touches another part as a result of physical movement.", "keys": { "Connect": "@roblox/globaltype/BasePart.Touched.Connect", "ConnectParallel": "@roblox/globaltype/BasePart.Touched.ConnectParallel", "Once": "@roblox/globaltype/BasePart.Touched.Once", "Wait": "@roblox/globaltype/BasePart.Touched.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#Touched", "code_sample": "local part = script.Parent\n\nlocal billboardGui = Instance.new(\"BillboardGui\")\nbillboardGui.Size = UDim2.new(0, 200, 0, 50)\nbillboardGui.Adornee = part\nbillboardGui.AlwaysOnTop = true\nbillboardGui.Parent = part\n\nlocal tl = Instance.new(\"TextLabel\")\ntl.Size = UDim2.new(1, 0, 1, 0)\ntl.BackgroundTransparency = 1\ntl.Parent = billboardGui\n\nlocal numTouchingParts = 0\n\nlocal function onTouch(otherPart)\n\tprint(\"Touch started: \" .. otherPart.Name)\n\tnumTouchingParts = numTouchingParts + 1\n\ttl.Text = numTouchingParts\nend\n\nlocal function onTouchEnded(otherPart)\n\tprint(\"Touch ended: \" .. otherPart.Name)\n\tnumTouchingParts = numTouchingParts - 1\n\ttl.Text = numTouchingParts\nend\n\npart.Touched:Connect(onTouch)\npart.TouchEnded:Connect(onTouchEnded)" }, "@roblox/globaltype/BasePart.TouchEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.TouchEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.TouchEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.TouchEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.TouchEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.TouchEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.TouchEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.TouchEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.TouchEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.TouchEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.TouchEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.TouchEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BasePart.TouchEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.TouchEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BasePart.TouchEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BasePart.TouchEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BasePart.TouchEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePart.TouchEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BasePart.TouchEnded": { "documentation": "Fires when a part stops touching another part as a result of physical movement.", "keys": { "Connect": "@roblox/globaltype/BasePart.TouchEnded.Connect", "ConnectParallel": "@roblox/globaltype/BasePart.TouchEnded.ConnectParallel", "Once": "@roblox/globaltype/BasePart.TouchEnded.Once", "Wait": "@roblox/globaltype/BasePart.TouchEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePart#TouchEnded", "code_sample": "local part = script.Parent\n\nlocal billboardGui = Instance.new(\"BillboardGui\")\nbillboardGui.Size = UDim2.new(0, 200, 0, 50)\nbillboardGui.Adornee = part\nbillboardGui.AlwaysOnTop = true\nbillboardGui.Parent = part\n\nlocal tl = Instance.new(\"TextLabel\")\ntl.Size = UDim2.new(1, 0, 1, 0)\ntl.BackgroundTransparency = 1\ntl.Parent = billboardGui\n\nlocal numTouchingParts = 0\n\nlocal function onTouch(otherPart)\n\tprint(\"Touch started: \" .. otherPart.Name)\n\tnumTouchingParts = numTouchingParts + 1\n\ttl.Text = numTouchingParts\nend\n\nlocal function onTouchEnded(otherPart)\n\tprint(\"Touch ended: \" .. otherPart.Name)\n\tnumTouchingParts = numTouchingParts - 1\n\ttl.Text = numTouchingParts\nend\n\npart.Touched:Connect(onTouch)\npart.TouchEnded:Connect(onTouchEnded)" }, "@roblox/globaltype/Humanoid": { "documentation": "A special object that gives models the functionality of a character.", "keys": { "AutoJumpEnabled": "@roblox/globaltype/Humanoid.AutoJumpEnabled", "AutomaticScalingEnabled": "@roblox/globaltype/Humanoid.AutomaticScalingEnabled", "AutoRotate": "@roblox/globaltype/Humanoid.AutoRotate", "BreakJointsOnDeath": "@roblox/globaltype/Humanoid.BreakJointsOnDeath", "CameraOffset": "@roblox/globaltype/Humanoid.CameraOffset", "CollisionType": "@roblox/globaltype/Humanoid.CollisionType", "DisplayDistanceType": "@roblox/globaltype/Humanoid.DisplayDistanceType", "DisplayName": "@roblox/globaltype/Humanoid.DisplayName", "EvaluateStateMachine": "@roblox/globaltype/Humanoid.EvaluateStateMachine", "FloorMaterial": "@roblox/globaltype/Humanoid.FloorMaterial", "Health": "@roblox/globaltype/Humanoid.Health", "HealthDisplayDistance": "@roblox/globaltype/Humanoid.HealthDisplayDistance", "HealthDisplayType": "@roblox/globaltype/Humanoid.HealthDisplayType", "HipHeight": "@roblox/globaltype/Humanoid.HipHeight", "Jump": "@roblox/globaltype/Humanoid.Jump", "JumpHeight": "@roblox/globaltype/Humanoid.JumpHeight", "JumpPower": "@roblox/globaltype/Humanoid.JumpPower", "LeftLeg": "@roblox/globaltype/Humanoid.LeftLeg", "MaxHealth": "@roblox/globaltype/Humanoid.MaxHealth", "maxHealth": "@roblox/globaltype/Humanoid.maxHealth", "MaxSlopeAngle": "@roblox/globaltype/Humanoid.MaxSlopeAngle", "MoveDirection": "@roblox/globaltype/Humanoid.MoveDirection", "NameDisplayDistance": "@roblox/globaltype/Humanoid.NameDisplayDistance", "NameOcclusion": "@roblox/globaltype/Humanoid.NameOcclusion", "PlatformStand": "@roblox/globaltype/Humanoid.PlatformStand", "RequiresNeck": "@roblox/globaltype/Humanoid.RequiresNeck", "RightLeg": "@roblox/globaltype/Humanoid.RightLeg", "RigType": "@roblox/globaltype/Humanoid.RigType", "RootPart": "@roblox/globaltype/Humanoid.RootPart", "SeatPart": "@roblox/globaltype/Humanoid.SeatPart", "Sit": "@roblox/globaltype/Humanoid.Sit", "TargetPoint": "@roblox/globaltype/Humanoid.TargetPoint", "Torso": "@roblox/globaltype/Humanoid.Torso", "UseJumpPower": "@roblox/globaltype/Humanoid.UseJumpPower", "WalkSpeed": "@roblox/globaltype/Humanoid.WalkSpeed", "WalkToPart": "@roblox/globaltype/Humanoid.WalkToPart", "WalkToPoint": "@roblox/globaltype/Humanoid.WalkToPoint", "AddAccessory": "@roblox/globaltype/Humanoid.AddAccessory", "AddCustomStatus": "@roblox/globaltype/Humanoid.AddCustomStatus", "AddStatus": "@roblox/globaltype/Humanoid.AddStatus", "ApplyDescriptionAsync": "@roblox/globaltype/Humanoid.ApplyDescriptionAsync", "ApplyDescription": "@roblox/globaltype/Humanoid.ApplyDescription", "ApplyDescriptionResetAsync": "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync", "ApplyDescriptionReset": "@roblox/globaltype/Humanoid.ApplyDescriptionReset", "BuildRigFromAttachments": "@roblox/globaltype/Humanoid.BuildRigFromAttachments", "ChangeState": "@roblox/globaltype/Humanoid.ChangeState", "EquipTool": "@roblox/globaltype/Humanoid.EquipTool", "GetAccessories": "@roblox/globaltype/Humanoid.GetAccessories", "GetAppliedDescription": "@roblox/globaltype/Humanoid.GetAppliedDescription", "GetBodyPartR15": "@roblox/globaltype/Humanoid.GetBodyPartR15", "GetLimb": "@roblox/globaltype/Humanoid.GetLimb", "GetMoveVelocity": "@roblox/globaltype/Humanoid.GetMoveVelocity", "GetPlayingAnimationTracks": "@roblox/globaltype/Humanoid.GetPlayingAnimationTracks", "GetState": "@roblox/globaltype/Humanoid.GetState", "GetStateEnabled": "@roblox/globaltype/Humanoid.GetStateEnabled", "GetStatuses": "@roblox/globaltype/Humanoid.GetStatuses", "HasCustomStatus": "@roblox/globaltype/Humanoid.HasCustomStatus", "HasStatus": "@roblox/globaltype/Humanoid.HasStatus", "LoadAnimation": "@roblox/globaltype/Humanoid.LoadAnimation", "loadAnimation": "@roblox/globaltype/Humanoid.loadAnimation", "Move": "@roblox/globaltype/Humanoid.Move", "MoveTo": "@roblox/globaltype/Humanoid.MoveTo", "PlayEmoteAsync": "@roblox/globaltype/Humanoid.PlayEmoteAsync", "PlayEmote": "@roblox/globaltype/Humanoid.PlayEmote", "RemoveAccessories": "@roblox/globaltype/Humanoid.RemoveAccessories", "RemoveCustomStatus": "@roblox/globaltype/Humanoid.RemoveCustomStatus", "RemoveStatus": "@roblox/globaltype/Humanoid.RemoveStatus", "ReplaceBodyPartR15": "@roblox/globaltype/Humanoid.ReplaceBodyPartR15", "SetStateEnabled": "@roblox/globaltype/Humanoid.SetStateEnabled", "TakeDamage": "@roblox/globaltype/Humanoid.TakeDamage", "takeDamage": "@roblox/globaltype/Humanoid.takeDamage", "UnequipTools": "@roblox/globaltype/Humanoid.UnequipTools" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid", "code_sample": "" }, "@roblox/globaltype/Humanoid.AutoJumpEnabled": { "documentation": "Sets whether the character will automatically jump when they hit an obstacle as a player on a mobile device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AutoJumpEnabled", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal button = script.Parent\n\nlocal function update()\n\t-- Update button text\n\tif player.AutoJumpEnabled then\n\t\tbutton.Text = \"Auto-Jump is ON\"\n\telse\n\t\tbutton.Text = \"Auto-Jump is OFF\"\n\tend\n\t-- Reflect the property in the player's character, if they have one\n\tif player.Character then\n\t\tlocal human = player.Character:FindFirstChild(\"Humanoid\")\n\t\tif human then\n\t\t\thuman.AutoJumpEnabled = player.AutoJumpEnabled\n\t\tend\n\tend\nend\n\nlocal function onActivated()\n\t-- Toggle auto-jump\n\tplayer.AutoJumpEnabled = not player.AutoJumpEnabled\n\t-- Update everything else\n\tupdate()\nend\n\nbutton.Activated:Connect(onActivated)\nupdate()" }, "@roblox/globaltype/Humanoid.AutomaticScalingEnabled": { "documentation": "When Enabled, AutomaticScalingEnabled causes the size of the character to change in response to the values in the humanoid's child scale values changing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AutomaticScalingEnabled", "code_sample": "" }, "@roblox/globaltype/Humanoid.AutoRotate": { "documentation": "AutoRotate sets whether or not the Humanoid will automatically rotate to face in the direction they are moving in.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AutoRotate", "code_sample": "" }, "@roblox/globaltype/Humanoid.BreakJointsOnDeath": { "documentation": "Determines whether the humanoid's joints break when in the HumanoidStateType.Dead state.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#BreakJointsOnDeath", "code_sample": "" }, "@roblox/globaltype/Humanoid.CameraOffset": { "documentation": "An offset applied to the Camera's subject position when its CameraSubject is set to this Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#CameraOffset", "code_sample": "" }, "@roblox/globaltype/Humanoid.CollisionType": { "documentation": "Deprecated:
Selects the HumanoidCollisionType for R15 and Rthro non-player characters.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#CollisionType", "code_sample": "" }, "@roblox/globaltype/Humanoid.DisplayDistanceType": { "documentation": "Controls the distance behavior of the humanoid's name and health display.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#DisplayDistanceType", "code_sample": "local humanoid = script.Parent\n\nhumanoid.DisplayDistanceType = Enum.HumanoidDisplayDistanceType.Viewer\nhumanoid.HealthDisplayDistance = 0\nhumanoid.NameDisplayDistance = 100" }, "@roblox/globaltype/Humanoid.DisplayName": { "documentation": "Sets the text of a Humanoid, displayed above their head.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#DisplayName", "code_sample": "" }, "@roblox/globaltype/Humanoid.EvaluateStateMachine": { "documentation": "Used to disable the internal physics and state machine of the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#EvaluateStateMachine", "code_sample": "" }, "@roblox/globaltype/Humanoid.FloorMaterial": { "documentation": "Describes the Material that the Humanoid is currently standing on. If the Humanoid isn't standing on anything, the value of this property will be Air.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#FloorMaterial", "code_sample": "" }, "@roblox/globaltype/Humanoid.Health": { "documentation": "Describes the current health of the Humanoid on the range [0, Humanoid.MaxHealth].", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Health", "code_sample": "" }, "@roblox/globaltype/Humanoid.HealthDisplayDistance": { "documentation": "Used in conjunction with the DisplayDistanceType property to control the distance from which a humanoid's health bar can be seen.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#HealthDisplayDistance", "code_sample": "" }, "@roblox/globaltype/Humanoid.HealthDisplayType": { "documentation": "Controls when the humanoid's health bar is allowed to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#HealthDisplayType", "code_sample": "" }, "@roblox/globaltype/Humanoid.HipHeight": { "documentation": "Determines the distance off the ground the Humanoid.RootPart should be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#HipHeight", "code_sample": "" }, "@roblox/globaltype/Humanoid.Jump": { "documentation": "If true, the Humanoid jumps with an upwards force.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Jump", "code_sample": "" }, "@roblox/globaltype/Humanoid.JumpHeight": { "documentation": "Provides control over the height that the Humanoid jumps to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#JumpHeight", "code_sample": "" }, "@roblox/globaltype/Humanoid.JumpPower": { "documentation": "Determines how much upwards force is applied to the Humanoid when jumping.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#JumpPower", "code_sample": "" }, "@roblox/globaltype/Humanoid.LeftLeg": { "documentation": "Deprecated: This instance only works with the old R6 rig. It will not work with the R15 rig and should not be used in new work not using the R6 rig.
A reference to the humanoid's Left Leg part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#LeftLeg", "code_sample": "" }, "@roblox/globaltype/Humanoid.MaxHealth": { "documentation": "The maximum value of a humanoid's Health.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#MaxHealth", "code_sample": "" }, "@roblox/globaltype/Humanoid.maxHealth": { "documentation": "Deprecated: This deprecated property is a variant of Humanoid.MaxHealth which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#maxHealth", "code_sample": "" }, "@roblox/globaltype/Humanoid.MaxSlopeAngle": { "documentation": "The maximum slope angle that a humanoid can walk on without slipping.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#MaxSlopeAngle", "code_sample": "local player = game.Players.LocalPlayer\nlocal char = player.CharacterAdded:wait()\nlocal h = char:FindFirstChild(\"Humanoid\")\n\nh.MaxSlopeAngle = 30" }, "@roblox/globaltype/Humanoid.MoveDirection": { "documentation": "Describes the direction that the Humanoid is walking in.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#MoveDirection", "code_sample": "" }, "@roblox/globaltype/Humanoid.NameDisplayDistance": { "documentation": "Used in conjunction with the Humanoid.DisplayDistanceType property to control the distance from which a humanoid's name can be seen.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#NameDisplayDistance", "code_sample": "" }, "@roblox/globaltype/Humanoid.NameOcclusion": { "documentation": "Controls whether a humanoid's name and health bar can be seen behind walls or other objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#NameOcclusion", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterAdded(character)\n\tlocal humanoid = character:WaitForChild(\"Humanoid\")\n\thumanoid.NamOcclusion = Enum.NameOcclusion.OccludeAll\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Humanoid.PlatformStand": { "documentation": "Determines whether the Humanoid is currently in the HumanoidStateType.PlatformStanding state.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlatformStand", "code_sample": "" }, "@roblox/globaltype/Humanoid.RequiresNeck": { "documentation": "Allows developers to disable the behavior where a player Character|character dies if the Neck Motor6D is removed or disconnected even momentarily.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RequiresNeck", "code_sample": "" }, "@roblox/globaltype/Humanoid.RightLeg": { "documentation": "Deprecated: This instance only works with the old R6 rig. It will not work with the R15 rig and should not be used in new work not using the R6 rig.
A reference to the humanoid's Right Leg part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RightLeg", "code_sample": "" }, "@roblox/globaltype/Humanoid.RigType": { "documentation": "Describes whether this Humanoid is utilizing the legacy R6 character rig, or the new R15 character rig.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RigType", "code_sample": "" }, "@roblox/globaltype/Humanoid.RootPart": { "documentation": "A reference to the humanoid's HumanoidRootPart object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RootPart", "code_sample": "" }, "@roblox/globaltype/Humanoid.SeatPart": { "documentation": "A reference to the seat that a Humanoid is currently sitting in, if any.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#SeatPart", "code_sample": "" }, "@roblox/globaltype/Humanoid.Sit": { "documentation": "Describes whether the Humanoid is currently sitting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Sit", "code_sample": "" }, "@roblox/globaltype/Humanoid.TargetPoint": { "documentation": "Describes the 3D position where the Player controlling the Humanoid last clicked in the world while using a Tool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#TargetPoint", "code_sample": "" }, "@roblox/globaltype/Humanoid.Torso": { "documentation": "Deprecated: This instance only works with the old R6 rig. It will not work with the R15 rig and should not be used in new work not using the R6 rig.
A reference to a humanoid's root driving part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Torso", "code_sample": "" }, "@roblox/globaltype/Humanoid.UseJumpPower": { "documentation": "Determines whether the JumpHeight (false) or Humanoid.JumpPower (true) property is used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#UseJumpPower", "code_sample": "" }, "@roblox/globaltype/Humanoid.WalkSpeed": { "documentation": "Describes the humanoid's maximum movement speed in studs per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#WalkSpeed", "code_sample": "" }, "@roblox/globaltype/Humanoid.WalkToPart": { "documentation": "A reference to a part whose position is trying to be reached by a humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#WalkToPart", "code_sample": "" }, "@roblox/globaltype/Humanoid.WalkToPoint": { "documentation": "The position that a humanoid is trying to reach, after a call to Humanoid:MoveTo() is made.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#WalkToPoint", "code_sample": "" }, "@roblox/globaltype/Humanoid.AddAccessory/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.AddAccessory/param/1": { "documentation": "The Accessory to be attached." }, "@roblox/globaltype/Humanoid.AddAccessory": { "documentation": "Attaches the specified Accessory to the humanoid's parent.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AddAccessory/param/0" }, { "name": "accessory", "documentation": "@roblox/globaltype/Humanoid.AddAccessory/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AddAccessory", "code_sample": "local playerModel = script.Parent\nlocal humanoid = playerModel:WaitForChild(\"Humanoid\")\n\nlocal clockworksShades = Instance.new(\"Accessory\")\nclockworksShades.Name = \"ClockworksShades\"\n\nlocal handle = Instance.new(\"Part\")\nhandle.Name = \"Handle\"\nhandle.Size = Vector3.new(1, 1.6, 1)\nhandle.Parent = clockworksShades\n\nlocal faceFrontAttachment = Instance.new(\"Attachment\")\nfaceFrontAttachment.Name = \"FaceFrontAttachment\"\nfaceFrontAttachment.Position = Vector3.new(0, -0.24, -0.45)\nfaceFrontAttachment.Parent = handle\n\nlocal mesh = Instance.new(\"SpecialMesh\")\nmesh.Name = \"Mesh\"\nmesh.Scale = Vector3.new(1, 1.3, 1)\nmesh.MeshId = \"rbxassetid://1577360\"\nmesh.TextureId = \"rbxassetid://1577349\"\nmesh.Parent = handle\n\nhumanoid:AddAccessory(clockworksShades)" }, "@roblox/globaltype/Humanoid.AddCustomStatus/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.AddCustomStatus/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.AddCustomStatus/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.AddCustomStatus": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Adds a custom status to the Humanoid.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AddCustomStatus/param/0" }, { "name": "status", "documentation": "@roblox/globaltype/Humanoid.AddCustomStatus/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.AddCustomStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AddCustomStatus", "code_sample": "" }, "@roblox/globaltype/Humanoid.AddStatus/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.AddStatus/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.AddStatus/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.AddStatus": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Adds a BoolValue to the Humanoid's Status object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AddStatus/param/0" }, { "name": "status", "documentation": "@roblox/globaltype/Humanoid.AddStatus/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.AddStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AddStatus", "code_sample": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionAsync/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.ApplyDescriptionAsync/param/1": { "documentation": "The HumanoidDescription instance which you want to set the character to match." }, "@roblox/globaltype/Humanoid.ApplyDescriptionAsync/param/2": { "documentation": "The asset type verification mode." }, "@roblox/globaltype/Humanoid.ApplyDescriptionAsync": { "documentation": "Makes the character's look match that of the passed in HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionAsync/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionAsync/param/1" }, { "name": "assetTypeVerification", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionAsync", "code_sample": "" }, "@roblox/globaltype/Humanoid.ApplyDescription/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.ApplyDescription/param/1": { "documentation": "The HumanoidDescription instance which you want to set the character to match." }, "@roblox/globaltype/Humanoid.ApplyDescription/param/2": { "documentation": "The asset type verification mode." }, "@roblox/globaltype/Humanoid.ApplyDescription": { "documentation": "Deprecated: This method has been superseded by ApplyDescriptionAsync().
Makes the character's look match that of the passed in HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescription/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/Humanoid.ApplyDescription/param/1" }, { "name": "assetTypeVerification", "documentation": "@roblox/globaltype/Humanoid.ApplyDescription/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescription", "code_sample": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync/param/1": { "documentation": "The HumanoidDescription instance which you want to set the character to match." }, "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync/param/2": { "documentation": "The asset type verification mode." }, "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync": { "documentation": "Makes the character's look match that of the passed in HumanoidDescription, even after external changes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync/param/1" }, { "name": "assetTypeVerification", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionResetAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionResetAsync", "code_sample": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionReset/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.ApplyDescriptionReset/param/1": { "documentation": "The HumanoidDescription instance which you want to set the character to match." }, "@roblox/globaltype/Humanoid.ApplyDescriptionReset/param/2": { "documentation": "The asset type verification mode." }, "@roblox/globaltype/Humanoid.ApplyDescriptionReset": { "documentation": "Deprecated: This method has been superseded by ApplyDescriptionResetAsync().
Makes the character's look match that of the passed in HumanoidDescription, even after external changes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionReset/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionReset/param/1" }, { "name": "assetTypeVerification", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionReset/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionReset", "code_sample": "" }, "@roblox/globaltype/Humanoid.BuildRigFromAttachments/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.BuildRigFromAttachments": { "documentation": "Assembles a tree of Motor6D joints by attaching together Attachment objects in a humanoid's character.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.BuildRigFromAttachments/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#BuildRigFromAttachments", "code_sample": "" }, "@roblox/globaltype/Humanoid.ChangeState/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.ChangeState/param/1": { "documentation": "The HumanoidStateType that the Humanoid is to perform." }, "@roblox/globaltype/Humanoid.ChangeState": { "documentation": "Sets the Humanoid to enter the given HumanoidStateType.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ChangeState/param/0" }, { "name": "state", "documentation": "@roblox/globaltype/Humanoid.ChangeState/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ChangeState", "code_sample": "" }, "@roblox/globaltype/Humanoid.EquipTool/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.EquipTool/param/1": { "documentation": "The Tool to equip." }, "@roblox/globaltype/Humanoid.EquipTool": { "documentation": "Makes the Humanoid equip the given Tool.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.EquipTool/param/0" }, { "name": "tool", "documentation": "@roblox/globaltype/Humanoid.EquipTool/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#EquipTool", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetAccessories/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetAccessories/return/0": { "documentation": "An array of Accessory objects that are parented to the humanoid's parent." }, "@roblox/globaltype/Humanoid.GetAccessories": { "documentation": "Returns an array of Accessory objects that the humanoid's parent is currently wearing.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetAccessories/param/0" } ], "returns": [ "@roblox/globaltype/Humanoid.GetAccessories/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetAccessories", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetAppliedDescription/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetAppliedDescription/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.GetAppliedDescription": { "documentation": "Returns a copy of the humanoid's cached HumanoidDescription which describes its current look.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetAppliedDescription/param/0" } ], "returns": [ "@roblox/globaltype/Humanoid.GetAppliedDescription/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetAppliedDescription", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetBodyPartR15/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetBodyPartR15/param/1": { "documentation": "The specified part being checked to see if it is an R15 body part." }, "@roblox/globaltype/Humanoid.GetBodyPartR15/return/0": { "documentation": "The specified part's R15 body part type or unknown if the part is not a body part." }, "@roblox/globaltype/Humanoid.GetBodyPartR15": { "documentation": "Pass a body part to this method (the body part should be a sibling of Humanoid, and a child of a Model) to get the BodyPartR15 of the Part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetBodyPartR15/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/Humanoid.GetBodyPartR15/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.GetBodyPartR15/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetBodyPartR15", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetLimb/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetLimb/param/1": { "documentation": "The Part for which the Enum.Limb is to be retrieved." }, "@roblox/globaltype/Humanoid.GetLimb/return/0": { "documentation": "The Limb the part corresponds with." }, "@roblox/globaltype/Humanoid.GetLimb": { "documentation": "Returns the Limb enum that is associated with the given Part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetLimb/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/Humanoid.GetLimb/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.GetLimb/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetLimb", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nfor _, child in pairs(character:GetChildren()) do\n\tlocal limb = humanoid:GetLimb(child)\n\tif limb ~= Enum.Limb.Unknown then\n\t\tprint(child.Name .. \" is part of limb \" .. limb.Name)\n\tend\nend" }, "@roblox/globaltype/Humanoid.GetMoveVelocity/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetMoveVelocity/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.GetMoveVelocity": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetMoveVelocity/param/0" } ], "returns": [ "@roblox/globaltype/Humanoid.GetMoveVelocity/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetMoveVelocity", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetPlayingAnimationTracks/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetPlayingAnimationTracks/return/0": { "documentation": "An array of currently playing AnimationTracks." }, "@roblox/globaltype/Humanoid.GetPlayingAnimationTracks": { "documentation": "Deprecated:
Returns an array of all AnimationTracks that are currently being played on the Humanoid.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetPlayingAnimationTracks/param/0" } ], "returns": [ "@roblox/globaltype/Humanoid.GetPlayingAnimationTracks/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetPlayingAnimationTracks", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetState/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetState/return/0": { "documentation": "The current HumanoidStateType of the Humanoid." }, "@roblox/globaltype/Humanoid.GetState": { "documentation": "Returns the humanoid's current HumanoidStateType.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetState/param/0" } ], "returns": [ "@roblox/globaltype/Humanoid.GetState/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetState", "code_sample": "" }, "@roblox/globaltype/Humanoid.GetStateEnabled/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetStateEnabled/param/1": { "documentation": "The given HumanoidStateType." }, "@roblox/globaltype/Humanoid.GetStateEnabled/return/0": { "documentation": "Whether the given HumanoidStateType is enabled." }, "@roblox/globaltype/Humanoid.GetStateEnabled": { "documentation": "Returns whether a HumanoidStateType is enabled for the Humanoid.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetStateEnabled/param/0" }, { "name": "state", "documentation": "@roblox/globaltype/Humanoid.GetStateEnabled/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.GetStateEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetStateEnabled", "code_sample": "local humanoid = script.Parent:WaitForChild(\"Humanoid\")\n\n-- Set state\nhumanoid:SetStateEnabled(Enum.HumanoidStateType.Jumping, false)\n\n-- Get state\nprint(humanoid:GetStateEnabled(Enum.HumanoidStateType.Jumping)) -- false" }, "@roblox/globaltype/Humanoid.GetStatuses/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.GetStatuses/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.GetStatuses": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Returns a table of the Humanoid's statuses, and custom statuses.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GetStatuses/param/0" } ], "returns": [ "@roblox/globaltype/Humanoid.GetStatuses/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GetStatuses", "code_sample": "" }, "@roblox/globaltype/Humanoid.HasCustomStatus/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.HasCustomStatus/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.HasCustomStatus/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.HasCustomStatus": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Returns boolean based on if custom statuses exist.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.HasCustomStatus/param/0" }, { "name": "status", "documentation": "@roblox/globaltype/Humanoid.HasCustomStatus/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.HasCustomStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#HasCustomStatus", "code_sample": "" }, "@roblox/globaltype/Humanoid.HasStatus/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.HasStatus/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.HasStatus/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.HasStatus": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Returns a boolean based on if a status exists.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.HasStatus/param/0" }, { "name": "status", "documentation": "@roblox/globaltype/Humanoid.HasStatus/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.HasStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#HasStatus", "code_sample": "" }, "@roblox/globaltype/Humanoid.LoadAnimation/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.LoadAnimation/param/1": { "documentation": "The Animation to load." }, "@roblox/globaltype/Humanoid.LoadAnimation/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.LoadAnimation": { "documentation": "Deprecated: This function is deprecated in favor of using Animator:LoadAnimation() directly (the Animator may be created while editing or at runtime).
Loads an Animation onto a Humanoid, returning an AnimationTrack that can be used for playback.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.LoadAnimation/param/0" }, { "name": "animation", "documentation": "@roblox/globaltype/Humanoid.LoadAnimation/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.LoadAnimation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#LoadAnimation", "code_sample": "" }, "@roblox/globaltype/Humanoid.loadAnimation/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.loadAnimation/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.loadAnimation/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.loadAnimation": { "documentation": "Deprecated: This deprecated method is a variant of Humanoid:LoadAnimation(). Animator:LoadAnimation() should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.loadAnimation/param/0" }, { "name": "animation", "documentation": "@roblox/globaltype/Humanoid.loadAnimation/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.loadAnimation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#loadAnimation", "code_sample": "" }, "@roblox/globaltype/Humanoid.Move/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.Move/param/1": { "documentation": "The direction to walk in." }, "@roblox/globaltype/Humanoid.Move/param/2": { "documentation": "Set to true if the moveDirection parameter should be taken as relative to the CurrentCamera." }, "@roblox/globaltype/Humanoid.Move": { "documentation": "Causes the Humanoid to walk in the given direction.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Move/param/0" }, { "name": "moveDirection", "documentation": "@roblox/globaltype/Humanoid.Move/param/1" }, { "name": "relativeToCamera", "documentation": "@roblox/globaltype/Humanoid.Move/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Move", "code_sample": "" }, "@roblox/globaltype/Humanoid.MoveTo/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.MoveTo/param/1": { "documentation": "The position to set Humanoid.WalkToPoint to." }, "@roblox/globaltype/Humanoid.MoveTo/param/2": { "documentation": "The BasePart to set Humanoid.WalkToPart to." }, "@roblox/globaltype/Humanoid.MoveTo": { "documentation": "Causes the Humanoid to attempt to walk to the given location by setting the Humanoid.WalkToPoint and Humanoid.WalkToPart properties.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.MoveTo/param/0" }, { "name": "location", "documentation": "@roblox/globaltype/Humanoid.MoveTo/param/1" }, { "name": "part", "documentation": "@roblox/globaltype/Humanoid.MoveTo/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#MoveTo", "code_sample": "" }, "@roblox/globaltype/Humanoid.PlayEmoteAsync/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.PlayEmoteAsync/param/1": { "documentation": "name of the emote to play." }, "@roblox/globaltype/Humanoid.PlayEmoteAsync/return/0": { "documentation": "successfully played." }, "@roblox/globaltype/Humanoid.PlayEmoteAsync": { "documentation": "Plays emotes and returns if was successfully ran.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.PlayEmoteAsync/param/0" }, { "name": "emoteName", "documentation": "@roblox/globaltype/Humanoid.PlayEmoteAsync/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.PlayEmoteAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlayEmoteAsync", "code_sample": "" }, "@roblox/globaltype/Humanoid.PlayEmote/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.PlayEmote/param/1": { "documentation": "name of the emote to play." }, "@roblox/globaltype/Humanoid.PlayEmote/return/0": { "documentation": "successfully played." }, "@roblox/globaltype/Humanoid.PlayEmote": { "documentation": "Deprecated: This method has been superseded by PlayEmoteAsync().
Plays emotes and returns if was successfully ran.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.PlayEmote/param/0" }, { "name": "emoteName", "documentation": "@roblox/globaltype/Humanoid.PlayEmote/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.PlayEmote/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlayEmote", "code_sample": "" }, "@roblox/globaltype/Humanoid.RemoveAccessories/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.RemoveAccessories": { "documentation": "Removes all Accessory objects worn by the humanoid's parent.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.RemoveAccessories/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RemoveAccessories", "code_sample": "" }, "@roblox/globaltype/Humanoid.RemoveCustomStatus/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.RemoveCustomStatus/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.RemoveCustomStatus/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.RemoveCustomStatus": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Removes the defined custom status from the Status model in the Humanoid..", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.RemoveCustomStatus/param/0" }, { "name": "status", "documentation": "@roblox/globaltype/Humanoid.RemoveCustomStatus/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.RemoveCustomStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RemoveCustomStatus", "code_sample": "" }, "@roblox/globaltype/Humanoid.RemoveStatus/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.RemoveStatus/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.RemoveStatus/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.RemoveStatus": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Removes the defined status from the Status model in the Humanoid.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.RemoveStatus/param/0" }, { "name": "status", "documentation": "@roblox/globaltype/Humanoid.RemoveStatus/param/1" } ], "returns": [ "@roblox/globaltype/Humanoid.RemoveStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#RemoveStatus", "code_sample": "" }, "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/param/1": { "documentation": "The body part to replace. BodyPartR15.Unknown will fail." }, "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/param/2": { "documentation": "The Part Instance which will be parented to the character." }, "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/return/0": { "documentation": "" }, "@roblox/globaltype/Humanoid.ReplaceBodyPartR15": { "documentation": "Dynamically replaces a Humanoid body part with a different part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/param/0" }, { "name": "bodyPart", "documentation": "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/param/1" }, { "name": "part", "documentation": "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/param/2" } ], "returns": [ "@roblox/globaltype/Humanoid.ReplaceBodyPartR15/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ReplaceBodyPartR15", "code_sample": "" }, "@roblox/globaltype/Humanoid.SetStateEnabled/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.SetStateEnabled/param/1": { "documentation": "The HumanoidStateType to be enabled or disabled." }, "@roblox/globaltype/Humanoid.SetStateEnabled/param/2": { "documentation": "true if state is to be enabled, false if state is to be disabled." }, "@roblox/globaltype/Humanoid.SetStateEnabled": { "documentation": "Sets whether a given HumanoidStateType is enabled for the Humanoid.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.SetStateEnabled/param/0" }, { "name": "state", "documentation": "@roblox/globaltype/Humanoid.SetStateEnabled/param/1" }, { "name": "enabled", "documentation": "@roblox/globaltype/Humanoid.SetStateEnabled/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#SetStateEnabled", "code_sample": "local character = script.Parent\n\nlocal JUMP_DEBOUNCE = 1\n\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal isJumping = false\nhumanoid.StateChanged:Connect(function(_oldState, newState)\n\tif newState == Enum.HumanoidStateType.Jumping then\n\t\tif not isJumping then\n\t\t\tisJumping = true\n\t\t\thumanoid:SetStateEnabled(Enum.HumanoidStateType.Jumping, false)\n\t\tend\n\telseif newState == Enum.HumanoidStateType.Landed then\n\t\tif isJumping then\n\t\t\tisJumping = false\n\t\t\ttask.wait(JUMP_DEBOUNCE)\n\t\t\thumanoid:SetStateEnabled(Enum.HumanoidStateType.Jumping, true)\n\t\tend\n\tend\nend)" }, "@roblox/globaltype/Humanoid.TakeDamage/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.TakeDamage/param/1": { "documentation": "The damage, or amount to be deduced from the Humanoid.Health." }, "@roblox/globaltype/Humanoid.TakeDamage": { "documentation": "Lowers the Humanoid.Health of the Humanoid by the given amount if it is not protected by a ForceField.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.TakeDamage/param/0" }, { "name": "amount", "documentation": "@roblox/globaltype/Humanoid.TakeDamage/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#TakeDamage", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nhumanoid:TakeDamage(99)" }, "@roblox/globaltype/Humanoid.takeDamage/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.takeDamage/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.takeDamage": { "documentation": "Deprecated: This deprecated method is a variant of Humanoid:TakeDamage(), which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.takeDamage/param/0" }, { "name": "amount", "documentation": "@roblox/globaltype/Humanoid.takeDamage/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#takeDamage", "code_sample": "" }, "@roblox/globaltype/Humanoid.UnequipTools/param/0": { "documentation": "A special object that gives models the functionality of a character." }, "@roblox/globaltype/Humanoid.UnequipTools": { "documentation": "Unequips any Tool currently equipped by the Humanoid.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.UnequipTools/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#UnequipTools", "code_sample": "" }, "@roblox/globaltype/Humanoid.AnimationPlayed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.AnimationPlayed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.AnimationPlayed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.AnimationPlayed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.AnimationPlayed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.AnimationPlayed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.AnimationPlayed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.AnimationPlayed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.AnimationPlayed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.AnimationPlayed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.AnimationPlayed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.AnimationPlayed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.AnimationPlayed": { "documentation": "Deprecated:
Fires when an AnimationTrack begins playing on the Humanoid.", "keys": { "Connect": "@roblox/globaltype/Humanoid.AnimationPlayed.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.AnimationPlayed.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.AnimationPlayed.Once", "Wait": "@roblox/globaltype/Humanoid.AnimationPlayed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#AnimationPlayed", "code_sample": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.ApplyDescriptionFinished": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Once", "Wait": "@roblox/globaltype/Humanoid.ApplyDescriptionFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionFinished", "code_sample": "" }, "@roblox/globaltype/Humanoid.Climbing.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Climbing.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Climbing.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Climbing.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Climbing.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Climbing.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Climbing.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Climbing.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Climbing.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Climbing.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Climbing.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Climbing.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Climbing.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Climbing.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Climbing.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Climbing.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Climbing.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Climbing.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Climbing": { "documentation": "Fires when the speed at which a Humanoid is climbing changes.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Climbing.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Climbing.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Climbing.Once", "Wait": "@roblox/globaltype/Humanoid.Climbing.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Climbing", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterClimbing(character, speed)\n\tprint(character.Name, \"is climbing at a speed of\", speed, \"studs / second.\")\nend\n\nlocal function onCharacterAdded(character)\n\tcharacter.Humanoid.Climbing:Connect(function(speed)\n\t\tonCharacterClimbing(character, speed)\n\tend)\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.CustomStatusAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusAdded": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Fired when a status is added to the Humanoid.", "keys": { "Connect": "@roblox/globaltype/Humanoid.CustomStatusAdded.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.CustomStatusAdded.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.CustomStatusAdded.Once", "Wait": "@roblox/globaltype/Humanoid.CustomStatusAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#CustomStatusAdded", "code_sample": "" }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.CustomStatusRemoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.CustomStatusRemoved": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Fired when a status is removed from the Humanoid.", "keys": { "Connect": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.CustomStatusRemoved.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Once", "Wait": "@roblox/globaltype/Humanoid.CustomStatusRemoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#CustomStatusRemoved", "code_sample": "" }, "@roblox/globaltype/Humanoid.Died.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Died.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Died.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Died.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Died.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Died.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Died.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Died.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Died.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Died.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Died.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Died.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Died.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Died.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Died.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Died.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Died.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Died.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Died": { "documentation": "Fires when the Humanoid dies.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Died.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Died.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Died.Once", "Wait": "@roblox/globaltype/Humanoid.Died.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Died", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tlocal function onCharacterAdded(character)\n\t\tlocal humanoid = character:WaitForChild(\"Humanoid\")\n\n\t\tlocal function onDied()\n\t\t\tprint(player.Name, \"has died!\")\n\t\tend\n\n\t\thumanoid.Died:Connect(onDied)\n\tend\n\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Humanoid.FallingDown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FallingDown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.FallingDown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FallingDown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.FallingDown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FallingDown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FallingDown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.FallingDown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FallingDown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.FallingDown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FallingDown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FallingDown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.FallingDown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FallingDown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.FallingDown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FallingDown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FallingDown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FallingDown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FallingDown": { "documentation": "Fires when the Humanoid enters or leaves the FallingDown HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.FallingDown.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.FallingDown.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.FallingDown.Once", "Wait": "@roblox/globaltype/Humanoid.FallingDown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#FallingDown", "code_sample": "" }, "@roblox/globaltype/Humanoid.FreeFalling.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FreeFalling.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.FreeFalling.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FreeFalling.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FreeFalling.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.FreeFalling.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FreeFalling.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FreeFalling.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.FreeFalling.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FreeFalling.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.FreeFalling.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.FreeFalling.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.FreeFalling": { "documentation": "Fires when the Humanoid enters or leaves the Freefall HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.FreeFalling.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.FreeFalling.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.FreeFalling.Once", "Wait": "@roblox/globaltype/Humanoid.FreeFalling.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#FreeFalling", "code_sample": "" }, "@roblox/globaltype/Humanoid.GettingUp.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.GettingUp.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.GettingUp.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GettingUp.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.GettingUp.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.GettingUp.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.GettingUp.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.GettingUp.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GettingUp.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.GettingUp.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.GettingUp.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.GettingUp.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.GettingUp.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GettingUp.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.GettingUp.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.GettingUp.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.GettingUp.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.GettingUp.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.GettingUp": { "documentation": "Fires when the Humanoid enters or leaves the GettingUp HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.GettingUp.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.GettingUp.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.GettingUp.Once", "Wait": "@roblox/globaltype/Humanoid.GettingUp.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#GettingUp", "code_sample": "" }, "@roblox/globaltype/Humanoid.HealthChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.HealthChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.HealthChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.HealthChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.HealthChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.HealthChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.HealthChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.HealthChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.HealthChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.HealthChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.HealthChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.HealthChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.HealthChanged": { "documentation": "Fires when the Humanoid.Health changes (or when the Humanoid.MaxHealth is set).", "keys": { "Connect": "@roblox/globaltype/Humanoid.HealthChanged.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.HealthChanged.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.HealthChanged.Once", "Wait": "@roblox/globaltype/Humanoid.HealthChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#HealthChanged", "code_sample": "" }, "@roblox/globaltype/Humanoid.Jumping.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Jumping.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Jumping.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Jumping.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Jumping.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Jumping.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Jumping.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Jumping.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Jumping.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Jumping.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Jumping.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Jumping.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Jumping.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Jumping.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Jumping.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Jumping.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Jumping.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Jumping.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Jumping": { "documentation": "Fires when the Humanoid enters and leaves the Jumping HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Jumping.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Jumping.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Jumping.Once", "Wait": "@roblox/globaltype/Humanoid.Jumping.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Jumping", "code_sample": "" }, "@roblox/globaltype/Humanoid.MoveToFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.MoveToFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.MoveToFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.MoveToFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.MoveToFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.MoveToFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.MoveToFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.MoveToFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.MoveToFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.MoveToFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.MoveToFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.MoveToFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.MoveToFinished": { "documentation": "Fires when the Humanoid finishes walking to a goal declared by Humanoid:MoveTo().", "keys": { "Connect": "@roblox/globaltype/Humanoid.MoveToFinished.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.MoveToFinished.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.MoveToFinished.Once", "Wait": "@roblox/globaltype/Humanoid.MoveToFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#MoveToFinished", "code_sample": "" }, "@roblox/globaltype/Humanoid.PlatformStanding.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.PlatformStanding.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.PlatformStanding.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.PlatformStanding.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.PlatformStanding.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.PlatformStanding.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.PlatformStanding.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.PlatformStanding.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.PlatformStanding.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.PlatformStanding.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.PlatformStanding.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.PlatformStanding.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.PlatformStanding": { "documentation": "Fires when the Humanoid enters or leaves the PlatformStanding HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.PlatformStanding.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.PlatformStanding.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.PlatformStanding.Once", "Wait": "@roblox/globaltype/Humanoid.PlatformStanding.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlatformStanding", "code_sample": "" }, "@roblox/globaltype/Humanoid.Ragdoll.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Ragdoll.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Ragdoll.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Ragdoll.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Ragdoll.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Ragdoll.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Ragdoll.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Ragdoll.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Ragdoll.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Ragdoll.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Ragdoll.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Ragdoll.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Ragdoll": { "documentation": "Fires when the Humanoid enters or leaves the Ragdoll HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Ragdoll.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Ragdoll.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Ragdoll.Once", "Wait": "@roblox/globaltype/Humanoid.Ragdoll.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Ragdoll", "code_sample": "" }, "@roblox/globaltype/Humanoid.Running.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Running.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Running.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Running.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Running.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Running.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Running.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Running.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Running.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Running.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Running.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Running.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Running.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Running.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Running.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Running.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Running.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Running.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Running": { "documentation": "Fires when the speed at which a Humanoid is running changes.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Running.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Running.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Running.Once", "Wait": "@roblox/globaltype/Humanoid.Running.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Running", "code_sample": "local Players = game:GetService(\"Players\")\nlocal localPlayer = Players.LocalPlayer\n\nlocal character = localPlayer.Character or localPlayer.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal function onRunning(speed: number)\n\tif speed > 0 then\n\t\tprint(`{localPlayer.Name} is running`)\n\telse\n\t\tprint(`{localPlayer.Name} has stopped`)\n\tend\nend\n\nhumanoid.Running:Connect(function(speed: number)\n\tonRunning(speed)\nend)" }, "@roblox/globaltype/Humanoid.Seated.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Seated.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Seated.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Seated.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Seated.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Seated.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Seated.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Seated.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Seated.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Seated.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Seated.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Seated.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Seated.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Seated.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Seated.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Seated.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Seated.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Seated.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Seated": { "documentation": "Fired when a Humanoid either sits in a Seat or VehicleSeat or gets up.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Seated.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Seated.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Seated.Once", "Wait": "@roblox/globaltype/Humanoid.Seated.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Seated", "code_sample": "local character = script.Parent\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal function onSeated(isSeated, seat)\n\tif isSeated then\n\t\tprint(\"I'm now sitting on: \" .. seat.Name .. \"!\")\n\telse\n\t\tprint(\"I'm not sitting on anything\")\n\tend\nend\n\nhumanoid.Seated:Connect(onSeated)" }, "@roblox/globaltype/Humanoid.StateChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StateChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StateChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StateChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StateChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StateChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StateChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateChanged": { "documentation": "Fires when the state of the Humanoid is changed.", "keys": { "Connect": "@roblox/globaltype/Humanoid.StateChanged.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.StateChanged.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.StateChanged.Once", "Wait": "@roblox/globaltype/Humanoid.StateChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#StateChanged", "code_sample": "" }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateEnabledChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateEnabledChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StateEnabledChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StateEnabledChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StateEnabledChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StateEnabledChanged": { "documentation": "Fires when Humanoid:SetStateEnabled() is called on the Humanoid.", "keys": { "Connect": "@roblox/globaltype/Humanoid.StateEnabledChanged.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.StateEnabledChanged.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.StateEnabledChanged.Once", "Wait": "@roblox/globaltype/Humanoid.StateEnabledChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#StateEnabledChanged", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal function onStateEnabledChanged(state, enabled)\n\tif enabled then\n\t\tprint(state.Name .. \" has been enabled\")\n\telse\n\t\tprint(state.Name .. \" has been disabled\")\n\tend\nend\n\nhumanoid.StateEnabledChanged:Connect(onStateEnabledChanged)" }, "@roblox/globaltype/Humanoid.StatusAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StatusAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StatusAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StatusAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusAdded": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Fired when a status is added to the Humanoid.", "keys": { "Connect": "@roblox/globaltype/Humanoid.StatusAdded.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.StatusAdded.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.StatusAdded.Once", "Wait": "@roblox/globaltype/Humanoid.StatusAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#StatusAdded", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal function onStatusAdded(status)\n\tif status == Enum.Status.Poison then\n\t\tprint(\"The humanoid is now poisoned!\")\n\telseif status == Enum.Status.Confusion then\n\t\tprint(\"The humanoid is now confused!\")\n\tend\nend\n\nhumanoid.StatusAdded:Connect(onStatusAdded)\n\nhumanoid:AddStatus(Enum.Status.Poison) --> The humanoid is now poisoned!" }, "@roblox/globaltype/Humanoid.StatusRemoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusRemoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StatusRemoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusRemoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusRemoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StatusRemoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusRemoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusRemoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.StatusRemoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusRemoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.StatusRemoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.StatusRemoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.StatusRemoved": { "documentation": "Deprecated: This item is deprecated, as it was a part of the unfinished RbxStatus library which would have allowed you to add conditions to a Humanoid. Do not use it for new work.
Fired when a status is removed from the Humanoid.", "keys": { "Connect": "@roblox/globaltype/Humanoid.StatusRemoved.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.StatusRemoved.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.StatusRemoved.Once", "Wait": "@roblox/globaltype/Humanoid.StatusRemoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#StatusRemoved", "code_sample": "" }, "@roblox/globaltype/Humanoid.Strafing.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Strafing.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Strafing.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Strafing.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Strafing.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Strafing.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Strafing.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Strafing.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Strafing.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Strafing.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Strafing.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Strafing.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Strafing.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Strafing.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Strafing.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Strafing.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Strafing.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Strafing.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Strafing": { "documentation": "Fires when the Humanoid enters or leaves the StrafingNoPhysics HumanoidStateType.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Strafing.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Strafing.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Strafing.Once", "Wait": "@roblox/globaltype/Humanoid.Strafing.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Strafing", "code_sample": "" }, "@roblox/globaltype/Humanoid.Swimming.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Swimming.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Swimming.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Swimming.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Swimming.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Swimming.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Swimming.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Swimming.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Swimming.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Swimming.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Swimming.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Swimming.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Swimming.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Swimming.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Swimming.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Swimming.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Swimming.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Swimming.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Swimming": { "documentation": "Fires when the speed at which a Humanoid is swimming in Terrain water changes.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Swimming.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Swimming.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Swimming.Once", "Wait": "@roblox/globaltype/Humanoid.Swimming.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Swimming", "code_sample": "" }, "@roblox/globaltype/Humanoid.Touched.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Touched.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Touched.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Touched.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Touched.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Touched.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Touched.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Touched.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Touched.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Touched.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Touched.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Touched.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Humanoid.Touched.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Touched.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Humanoid.Touched.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Touched.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Humanoid.Touched.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Humanoid.Touched.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Humanoid.Touched": { "documentation": "Fires when one of the humanoid's limbs come in contact with another BasePart.", "keys": { "Connect": "@roblox/globaltype/Humanoid.Touched.Connect", "ConnectParallel": "@roblox/globaltype/Humanoid.Touched.ConnectParallel", "Once": "@roblox/globaltype/Humanoid.Touched.Once", "Wait": "@roblox/globaltype/Humanoid.Touched.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Humanoid#Touched", "code_sample": "" }, "@roblox/globaltype/UIScale": { "documentation": "An object that acts as a multiplier for the size of the parent UI element's scale.", "keys": { "Scale": "@roblox/globaltype/UIScale.Scale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIScale", "code_sample": "" }, "@roblox/globaltype/UIScale.Scale": { "documentation": "Determines the multiplier to apply to the parent UI element's size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIScale#Scale", "code_sample": "" }, "@roblox/globaltype/FeatureRestrictionManager": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FeatureRestrictionManager", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings": { "documentation": "", "keys": { "AllowSleep": "@roblox/globaltype/PhysicsSettings.AllowSleep", "AreAnchorsShown": "@roblox/globaltype/PhysicsSettings.AreAnchorsShown", "AreAssembliesShown": "@roblox/globaltype/PhysicsSettings.AreAssembliesShown", "AreAssemblyCentersOfMassShown": "@roblox/globaltype/PhysicsSettings.AreAssemblyCentersOfMassShown", "AreAwakePartsHighlighted": "@roblox/globaltype/PhysicsSettings.AreAwakePartsHighlighted", "AreBodyTypesShown": "@roblox/globaltype/PhysicsSettings.AreBodyTypesShown", "AreCollisionCostsShown": "@roblox/globaltype/PhysicsSettings.AreCollisionCostsShown", "AreConstraintForcesShownForSelectedOrHoveredInstances": "@roblox/globaltype/PhysicsSettings.AreConstraintForcesShownForSelectedOrHoveredInstances", "AreConstraintTorquesShownForSelectedOrHoveredInstances": "@roblox/globaltype/PhysicsSettings.AreConstraintTorquesShownForSelectedOrHoveredInstances", "AreContactForcesShownForSelectedOrHoveredAssemblies": "@roblox/globaltype/PhysicsSettings.AreContactForcesShownForSelectedOrHoveredAssemblies", "AreContactIslandsShown": "@roblox/globaltype/PhysicsSettings.AreContactIslandsShown", "AreContactPointsShown": "@roblox/globaltype/PhysicsSettings.AreContactPointsShown", "AreGravityForcesShownForSelectedOrHoveredAssemblies": "@roblox/globaltype/PhysicsSettings.AreGravityForcesShownForSelectedOrHoveredAssemblies", "AreJointCoordinatesShown": "@roblox/globaltype/PhysicsSettings.AreJointCoordinatesShown", "AreMagnitudesShownForDrawnForcesAndTorques": "@roblox/globaltype/PhysicsSettings.AreMagnitudesShownForDrawnForcesAndTorques", "AreMechanismsShown": "@roblox/globaltype/PhysicsSettings.AreMechanismsShown", "AreModelCoordsShown": "@roblox/globaltype/PhysicsSettings.AreModelCoordsShown", "AreNonAnchorsShown": "@roblox/globaltype/PhysicsSettings.AreNonAnchorsShown", "AreOwnersShown": "@roblox/globaltype/PhysicsSettings.AreOwnersShown", "ArePartCoordsShown": "@roblox/globaltype/PhysicsSettings.ArePartCoordsShown", "AreRegionsShown": "@roblox/globaltype/PhysicsSettings.AreRegionsShown", "AreSolverIslandsShown": "@roblox/globaltype/PhysicsSettings.AreSolverIslandsShown", "AreTerrainReplicationRegionsShown": "@roblox/globaltype/PhysicsSettings.AreTerrainReplicationRegionsShown", "AreTimestepsShown": "@roblox/globaltype/PhysicsSettings.AreTimestepsShown", "AreUnalignedPartsShown": "@roblox/globaltype/PhysicsSettings.AreUnalignedPartsShown", "AreWorldCoordsShown": "@roblox/globaltype/PhysicsSettings.AreWorldCoordsShown", "DisableCSGv2": "@roblox/globaltype/PhysicsSettings.DisableCSGv2", "DisableCSGv3ForPlugins": "@roblox/globaltype/PhysicsSettings.DisableCSGv3ForPlugins", "DrawConstraintsNetForce": "@roblox/globaltype/PhysicsSettings.DrawConstraintsNetForce", "DrawContactsNetForce": "@roblox/globaltype/PhysicsSettings.DrawContactsNetForce", "DrawTotalNetForce": "@roblox/globaltype/PhysicsSettings.DrawTotalNetForce", "EnableForceVisualizationSmoothing": "@roblox/globaltype/PhysicsSettings.EnableForceVisualizationSmoothing", "FluidForceDrawScale": "@roblox/globaltype/PhysicsSettings.FluidForceDrawScale", "ForceCSGv2": "@roblox/globaltype/PhysicsSettings.ForceCSGv2", "ForceDrawScale": "@roblox/globaltype/PhysicsSettings.ForceDrawScale", "ForceVisualizationSmoothingSteps": "@roblox/globaltype/PhysicsSettings.ForceVisualizationSmoothingSteps", "IsInterpolationThrottleShown": "@roblox/globaltype/PhysicsSettings.IsInterpolationThrottleShown", "IsReceiveAgeShown": "@roblox/globaltype/PhysicsSettings.IsReceiveAgeShown", "IsTreeShown": "@roblox/globaltype/PhysicsSettings.IsTreeShown", "PhysicsEnvironmentalThrottle": "@roblox/globaltype/PhysicsSettings.PhysicsEnvironmentalThrottle", "ShowDecompositionGeometry": "@roblox/globaltype/PhysicsSettings.ShowDecompositionGeometry", "ShowFluidForcesForSelectedOrHoveredMechanisms": "@roblox/globaltype/PhysicsSettings.ShowFluidForcesForSelectedOrHoveredMechanisms", "ShowInstanceNamesForDrawnForcesAndTorques": "@roblox/globaltype/PhysicsSettings.ShowInstanceNamesForDrawnForcesAndTorques", "SolverConvergenceMetricType": "@roblox/globaltype/PhysicsSettings.SolverConvergenceMetricType", "SolverConvergenceVisualizationMode": "@roblox/globaltype/PhysicsSettings.SolverConvergenceVisualizationMode", "ThrottleAdjustTime": "@roblox/globaltype/PhysicsSettings.ThrottleAdjustTime", "TorqueDrawScale": "@roblox/globaltype/PhysicsSettings.TorqueDrawScale", "UseCSGv2": "@roblox/globaltype/PhysicsSettings.UseCSGv2" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AllowSleep": { "documentation": "When set to true, physically simulated objects will stop being simulated if they have little to no motion for a set period of time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AllowSleep", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreAnchorsShown": { "documentation": "When set to true, parts that are BasePart.Anchored will show a gray surface outline on the surface of the part's bounding box that is currently facing the ground.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreAnchorsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreAssembliesShown": { "documentation": "When set to true, each physics assembly is assigned a unique color and the Part associated with the assembly are outlined with the color. Parts that are attached together by JointInstance will share the same color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreAssembliesShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreAssemblyCentersOfMassShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreAssemblyCentersOfMassShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreAwakePartsHighlighted": { "documentation": "When set to true, parts that are actively being physically simulated will have a red outline.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreAwakePartsHighlighted", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreBodyTypesShown": { "documentation": "When set to true, Part will be outlined with a specific color, depending on the state of its root simulation body.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreBodyTypesShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreCollisionCostsShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreCollisionCostsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreConstraintForcesShownForSelectedOrHoveredInstances": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreConstraintForcesShownForSelectedOrHoveredInstances", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreConstraintTorquesShownForSelectedOrHoveredInstances": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreConstraintTorquesShownForSelectedOrHoveredInstances", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreContactForcesShownForSelectedOrHoveredAssemblies": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreContactForcesShownForSelectedOrHoveredAssemblies", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreContactIslandsShown": { "documentation": "When set to true, each contact island will render SelectionBox adorns on the parts in contact islands, where each contact island is assigned a random color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreContactIslandsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreContactPointsShown": { "documentation": "When set to true, sphere adorns will be drawn at the contact points of each part where physics interactions are occurring.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreContactPointsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreGravityForcesShownForSelectedOrHoveredAssemblies": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreGravityForcesShownForSelectedOrHoveredAssemblies", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreJointCoordinatesShown": { "documentation": "When set to true, XYZ axes are rendered at the BasePart.CFrame of every part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreJointCoordinatesShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreMagnitudesShownForDrawnForcesAndTorques": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreMagnitudesShownForDrawnForcesAndTorques", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreMechanismsShown": { "documentation": "When set to true, every individual mechanism of parts is given a unique color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreMechanismsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreModelCoordsShown": { "documentation": "An ancient property that hasn't work correctly since late 2007. It's supposed to render an XYZ axis on the root part of a Model, but the axis rendering component doesn't work correctly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreModelCoordsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreNonAnchorsShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreNonAnchorsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreOwnersShown": { "documentation": "When set to true, each player's character is outlined with a unique color, and each part that the player has network ownership over is outlined with the same color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreOwnersShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ArePartCoordsShown": { "documentation": "An ancient property that hasn't worked correctly since late 2007. It's supposed to render a large XYZ axis in the center of each BasePart, but the axis rendering component doesn't work correctly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ArePartCoordsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreRegionsShown": { "documentation": "When set to true, a cylinder is drawn around each player's character, representing their Player.SimulationRadius.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreRegionsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreSolverIslandsShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreSolverIslandsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreTerrainReplicationRegionsShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreTerrainReplicationRegionsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreTimestepsShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreTimestepsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreUnalignedPartsShown": { "documentation": "When set to true, parts that aren't aligned on the 1x1x1 grid will be outlined yellow.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreUnalignedPartsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.AreWorldCoordsShown": { "documentation": "An ancient property that hasn't worked correctly since late 2007. It's supposed to render a large XYZ axis in the center of the world, but the axis rendering component doesn't work correctly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#AreWorldCoordsShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.DisableCSGv2": { "documentation": "When set to true, Roblox will fall back to using its legacy CSG solver when performing solid model operations.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#DisableCSGv2", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.DisableCSGv3ForPlugins": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#DisableCSGv3ForPlugins", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.DrawConstraintsNetForce": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#DrawConstraintsNetForce", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.DrawContactsNetForce": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#DrawContactsNetForce", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.DrawTotalNetForce": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#DrawTotalNetForce", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.EnableForceVisualizationSmoothing": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#EnableForceVisualizationSmoothing", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.FluidForceDrawScale": { "documentation": "Sets the scale of arrows drawn for aerodynamic force visualization.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#FluidForceDrawScale", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ForceCSGv2": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ForceCSGv2", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ForceDrawScale": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ForceDrawScale", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ForceVisualizationSmoothingSteps": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ForceVisualizationSmoothingSteps", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.IsInterpolationThrottleShown": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#IsInterpolationThrottleShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.IsReceiveAgeShown": { "documentation": "This property is supposed to show the BasePart.ReceiveAge of a part, but it does not work correctly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#IsReceiveAgeShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.IsTreeShown": { "documentation": "When set to true, the joint connections of each part, and the states of their underlying primitive components are visualized as a spanning tree.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#IsTreeShown", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.PhysicsEnvironmentalThrottle": { "documentation": "Controls the throttle rate of Roblox's physics engine.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#PhysicsEnvironmentalThrottle", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ShowDecompositionGeometry": { "documentation": "When set to true, the underlying collision geometry for PartOperation and MeshPart is rendered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ShowDecompositionGeometry", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ShowFluidForcesForSelectedOrHoveredMechanisms": { "documentation": "When set to true, enables aerodynamic visualization for selected or hovered mechanisms in Studio's play and run modes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ShowFluidForcesForSelectedOrHoveredMechanisms", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ShowInstanceNamesForDrawnForcesAndTorques": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ShowInstanceNamesForDrawnForcesAndTorques", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.SolverConvergenceMetricType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#SolverConvergenceMetricType", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.SolverConvergenceVisualizationMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#SolverConvergenceVisualizationMode", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.ThrottleAdjustTime": { "documentation": "If the PhysicsSettings.PhysicsEnvironmentalThrottle is set to DefaultAuto, this specifies the maximum time that the physics environmental throttle has to wait before it is allowed to automatically change.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#ThrottleAdjustTime", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.TorqueDrawScale": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#TorqueDrawScale", "code_sample": "" }, "@roblox/globaltype/PhysicsSettings.UseCSGv2": { "documentation": "If set to true, version 2 of Roblox's CSG solver will be used instead of version 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsSettings#UseCSGv2", "code_sample": "" }, "@roblox/globaltype/EqualizerSoundEffect": { "documentation": "Controls the volume of incoming audio across three frequency ranges.", "keys": { "HighGain": "@roblox/globaltype/EqualizerSoundEffect.HighGain", "LowGain": "@roblox/globaltype/EqualizerSoundEffect.LowGain", "MidGain": "@roblox/globaltype/EqualizerSoundEffect.MidGain" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EqualizerSoundEffect", "code_sample": "" }, "@roblox/globaltype/EqualizerSoundEffect.HighGain": { "documentation": "The output volume of frequencies greater than 4000 Hz.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EqualizerSoundEffect#HighGain", "code_sample": "" }, "@roblox/globaltype/EqualizerSoundEffect.LowGain": { "documentation": "The output volume of frequencies lower than 400 Hz.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EqualizerSoundEffect#LowGain", "code_sample": "" }, "@roblox/globaltype/EqualizerSoundEffect.MidGain": { "documentation": "The output volume of frequencies between 400 and 4000 Hz.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EqualizerSoundEffect#MidGain", "code_sample": "" }, "@roblox/globaltype/DataStoreInfo": { "documentation": "Object describing data store information.", "keys": { "CreatedTime": "@roblox/globaltype/DataStoreInfo.CreatedTime", "DataStoreName": "@roblox/globaltype/DataStoreInfo.DataStoreName", "UpdatedTime": "@roblox/globaltype/DataStoreInfo.UpdatedTime" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreInfo", "code_sample": "" }, "@roblox/globaltype/DataStoreInfo.CreatedTime": { "documentation": "Indicates when the data store was created in milliseconds since epoch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreInfo#CreatedTime", "code_sample": "" }, "@roblox/globaltype/DataStoreInfo.DataStoreName": { "documentation": "The name of the data store.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreInfo#DataStoreName", "code_sample": "" }, "@roblox/globaltype/DataStoreInfo.UpdatedTime": { "documentation": "Indicates the last time the data store was updated in milliseconds since epoch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreInfo#UpdatedTime", "code_sample": "" }, "@roblox/globaltype/PlayerGui": { "documentation": "A container for a player's currently rendered ScreenGuis.", "keys": { "CurrentScreenOrientation": "@roblox/globaltype/PlayerGui.CurrentScreenOrientation", "ScreenOrientation": "@roblox/globaltype/PlayerGui.ScreenOrientation", "SelectionImageObject": "@roblox/globaltype/PlayerGui.SelectionImageObject", "GetTopbarTransparency": "@roblox/globaltype/PlayerGui.GetTopbarTransparency", "SetTopbarTransparency": "@roblox/globaltype/PlayerGui.SetTopbarTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui", "code_sample": "" }, "@roblox/globaltype/PlayerGui.CurrentScreenOrientation": { "documentation": "Describes the player's current screen orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui#CurrentScreenOrientation", "code_sample": "" }, "@roblox/globaltype/PlayerGui.ScreenOrientation": { "documentation": "Sets the preferred screen orientation mode for this player, if on a mobile device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui#ScreenOrientation", "code_sample": "" }, "@roblox/globaltype/PlayerGui.SelectionImageObject": { "documentation": "Overrides the default selection adornment used for gamepads.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui#SelectionImageObject", "code_sample": "" }, "@roblox/globaltype/PlayerGui.GetTopbarTransparency/param/0": { "documentation": "A container for a player's currently rendered ScreenGuis." }, "@roblox/globaltype/PlayerGui.GetTopbarTransparency/return/0": { "documentation": "" }, "@roblox/globaltype/PlayerGui.GetTopbarTransparency": { "documentation": "Deprecated:
Returns the transparency of the Topbar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerGui.GetTopbarTransparency/param/0" } ], "returns": [ "@roblox/globaltype/PlayerGui.GetTopbarTransparency/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui#GetTopbarTransparency", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal playerGui = player:WaitForChild(\"PlayerGui\")\n\nprint(playerGui:GetTopbarTransparency())" }, "@roblox/globaltype/PlayerGui.SetTopbarTransparency/param/0": { "documentation": "A container for a player's currently rendered ScreenGuis." }, "@roblox/globaltype/PlayerGui.SetTopbarTransparency/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerGui.SetTopbarTransparency": { "documentation": "Deprecated:
Sets the transparency of the top bar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerGui.SetTopbarTransparency/param/0" }, { "name": "transparency", "documentation": "@roblox/globaltype/PlayerGui.SetTopbarTransparency/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui#SetTopbarTransparency", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal playerGui = player:WaitForChild(\"PlayerGui\")\n\nplayerGui:WaitForChild(\"PlayerGui\"):SetTopbarTransparency(0)" }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal": { "documentation": "Deprecated:
Fires when the transparency of the Topbar CoreGui changes.", "keys": { "Connect": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Connect", "ConnectParallel": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.ConnectParallel", "Once": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Once", "Wait": "@roblox/globaltype/PlayerGui.TopbarTransparencyChangedSignal.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerGui#TopbarTransparencyChangedSignal", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal playerGui = player:WaitForChild(\"PlayerGui\")\n\nlocal function onTransparencyChanged(topbarTransparency)\n\tprint(\"The topbar transparency is now:\", topbarTransparency)\nend\n\nplayerGui.TopbarTransparencyChangedSignal:Connect(onTransparencyChanged)" }, "@roblox/globaltype/CustomEventReceiver": { "documentation": "Deprecated: CustomEvents have been superseded by BindableEvents and should not be used in new work.", "keys": { "Source": "@roblox/globaltype/CustomEventReceiver.Source", "GetCurrentValue": "@roblox/globaltype/CustomEventReceiver.GetCurrentValue" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver", "code_sample": "" }, "@roblox/globaltype/CustomEventReceiver.Source": { "documentation": "Attaches the CustomEventReceiver object to a CustomEvent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver#Source", "code_sample": "" }, "@roblox/globaltype/CustomEventReceiver.GetCurrentValue/param/0": { "documentation": "Deprecated: CustomEvents have been superseded by BindableEvents and should not be used in new work." }, "@roblox/globaltype/CustomEventReceiver.GetCurrentValue/return/0": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.GetCurrentValue": { "documentation": "Returns the current value of the receiver's CustomEventReceiver.Source property.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.GetCurrentValue/param/0" } ], "returns": [ "@roblox/globaltype/CustomEventReceiver.GetCurrentValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver#GetCurrentValue", "code_sample": "" }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventConnected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventConnected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.EventConnected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventConnected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventConnected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventConnected": { "documentation": "Fires when the receiver is attached to a different CustomEvent, when the CustomEventReceiver.Source property is changed.", "keys": { "Connect": "@roblox/globaltype/CustomEventReceiver.EventConnected.Connect", "ConnectParallel": "@roblox/globaltype/CustomEventReceiver.EventConnected.ConnectParallel", "Once": "@roblox/globaltype/CustomEventReceiver.EventConnected.Once", "Wait": "@roblox/globaltype/CustomEventReceiver.EventConnected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver#EventConnected", "code_sample": "" }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.EventDisconnected": { "documentation": "Fires when the receiver is attached to a different CustomEvent instance when the CustomEventReceiver.Source property is changed.", "keys": { "Connect": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Connect", "ConnectParallel": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.ConnectParallel", "Once": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Once", "Wait": "@roblox/globaltype/CustomEventReceiver.EventDisconnected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver#EventDisconnected", "code_sample": "" }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CustomEventReceiver.SourceValueChanged": { "documentation": "Fires when the value of the CustomEvent's source is changed, passing the CustomEvent's new value.", "keys": { "Connect": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Connect", "ConnectParallel": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.ConnectParallel", "Once": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Once", "Wait": "@roblox/globaltype/CustomEventReceiver.SourceValueChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver#SourceValueChanged", "code_sample": "" }, "@roblox/globaltype/Annotation": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Annotation", "code_sample": "" }, "@roblox/globaltype/Path": { "documentation": "Stores the result of paths created by PathfindingService:CreatePath().", "keys": { "Status": "@roblox/globaltype/Path.Status", "CheckOcclusionAsync": "@roblox/globaltype/Path.CheckOcclusionAsync", "ComputeAsync": "@roblox/globaltype/Path.ComputeAsync", "GetPointCoordinates": "@roblox/globaltype/Path.GetPointCoordinates", "GetWaypoints": "@roblox/globaltype/Path.GetWaypoints" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path", "code_sample": "" }, "@roblox/globaltype/Path.Status": { "documentation": "The success of the generated Path.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#Status", "code_sample": "" }, "@roblox/globaltype/Path.CheckOcclusionAsync/param/0": { "documentation": "Stores the result of paths created by PathfindingService:CreatePath()." }, "@roblox/globaltype/Path.CheckOcclusionAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Path.CheckOcclusionAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Path.CheckOcclusionAsync": { "documentation": "Checks if a path is blocked starting at a specific waypoint.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.CheckOcclusionAsync/param/0" }, { "name": "start", "documentation": "@roblox/globaltype/Path.CheckOcclusionAsync/param/1" } ], "returns": [ "@roblox/globaltype/Path.CheckOcclusionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#CheckOcclusionAsync", "code_sample": "" }, "@roblox/globaltype/Path.ComputeAsync/param/0": { "documentation": "Stores the result of paths created by PathfindingService:CreatePath()." }, "@roblox/globaltype/Path.ComputeAsync/param/1": { "documentation": "The world position where the computed path begins." }, "@roblox/globaltype/Path.ComputeAsync/param/2": { "documentation": "The world position where the computed path finishes." }, "@roblox/globaltype/Path.ComputeAsync": { "documentation": "Computes a Path from a start position to an end position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.ComputeAsync/param/0" }, { "name": "start", "documentation": "@roblox/globaltype/Path.ComputeAsync/param/1" }, { "name": "finish", "documentation": "@roblox/globaltype/Path.ComputeAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#ComputeAsync", "code_sample": "" }, "@roblox/globaltype/Path.GetPointCoordinates/param/0": { "documentation": "Stores the result of paths created by PathfindingService:CreatePath()." }, "@roblox/globaltype/Path.GetPointCoordinates/return/0": { "documentation": "" }, "@roblox/globaltype/Path.GetPointCoordinates": { "documentation": "Deprecated: This item has been superseded by Path:GetWaypoints() which should be used in all new work instead.
Returns a table of Path instances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.GetPointCoordinates/param/0" } ], "returns": [ "@roblox/globaltype/Path.GetPointCoordinates/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#GetPointCoordinates", "code_sample": "" }, "@roblox/globaltype/Path.GetWaypoints/param/0": { "documentation": "Stores the result of paths created by PathfindingService:CreatePath()." }, "@roblox/globaltype/Path.GetWaypoints/return/0": { "documentation": "An array of PathWaypoints ordered from path start to path end." }, "@roblox/globaltype/Path.GetWaypoints": { "documentation": "Returns an array of points in the path.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.GetWaypoints/param/0" } ], "returns": [ "@roblox/globaltype/Path.GetWaypoints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#GetWaypoints", "code_sample": "local PathfindingService = game:GetService(\"PathfindingService\")\n\nlocal path = PathfindingService:CreatePath()\n\nlocal PATH_START = Vector3.new(0, 1, 0)\nlocal PATH_END = Vector3.new(100, 1, 25)\n\npath:ComputeAsync(PATH_START, PATH_END)\n\nif path.Status == Enum.PathStatus.Success then\n\tlocal waypoints = path:GetWaypoints()\n\tfor _, waypoint in pairs(waypoints) do\n\t\tprint(waypoint.Position)\n\tend\nend" }, "@roblox/globaltype/Path.Blocked.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Blocked.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Path.Blocked.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Blocked.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path.Blocked.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Path.Blocked.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Blocked.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Path.Blocked.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Blocked.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path.Blocked.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Path.Blocked.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Blocked.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Path.Blocked.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Blocked.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path.Blocked.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Path.Blocked.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Blocked.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Blocked.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Path.Blocked": { "documentation": "Fires when the computed path becomes blocked.", "keys": { "Connect": "@roblox/globaltype/Path.Blocked.Connect", "ConnectParallel": "@roblox/globaltype/Path.Blocked.ConnectParallel", "Once": "@roblox/globaltype/Path.Blocked.Once", "Wait": "@roblox/globaltype/Path.Blocked.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#Blocked", "code_sample": "" }, "@roblox/globaltype/Path.Unblocked.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Unblocked.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Path.Unblocked.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Unblocked.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path.Unblocked.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Path.Unblocked.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Unblocked.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Path.Unblocked.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Unblocked.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path.Unblocked.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Path.Unblocked.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Unblocked.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Path.Unblocked.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Unblocked.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path.Unblocked.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Path.Unblocked.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path.Unblocked.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path.Unblocked.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Path.Unblocked": { "documentation": "Fires when a computed path that was blocked becomes unblocked.", "keys": { "Connect": "@roblox/globaltype/Path.Unblocked.Connect", "ConnectParallel": "@roblox/globaltype/Path.Unblocked.ConnectParallel", "Once": "@roblox/globaltype/Path.Unblocked.Once", "Wait": "@roblox/globaltype/Path.Unblocked.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path#Unblocked", "code_sample": "" }, "@roblox/globaltype/RotateV": { "documentation": "Deprecated: This class works alongside the deprecated SurfaceType and should not be used for future work; use HingeConstraint instead.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotateV", "code_sample": "" }, "@roblox/globaltype/PluginGuiService": { "documentation": "A service that stores PluginGui objects to be displayed in Roblox Studio.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginGuiService", "code_sample": "" }, "@roblox/globaltype/DebugSettings": { "documentation": "Collection of various developer-facing diagnostics information.", "keys": { "DataModel": "@roblox/globaltype/DebugSettings.DataModel", "InstanceCount": "@roblox/globaltype/DebugSettings.InstanceCount", "IsScriptStackTracingEnabled": "@roblox/globaltype/DebugSettings.IsScriptStackTracingEnabled", "JobCount": "@roblox/globaltype/DebugSettings.JobCount", "PlayerCount": "@roblox/globaltype/DebugSettings.PlayerCount", "ReportSoundWarnings": "@roblox/globaltype/DebugSettings.ReportSoundWarnings", "RobloxVersion": "@roblox/globaltype/DebugSettings.RobloxVersion", "TickCountPreciseOverride": "@roblox/globaltype/DebugSettings.TickCountPreciseOverride" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings", "code_sample": "" }, "@roblox/globaltype/DebugSettings.DataModel": { "documentation": "Describes whether a DataModel is actively in memory, as an integer (where 1 = true, and 0 = false).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#DataModel", "code_sample": "" }, "@roblox/globaltype/DebugSettings.InstanceCount": { "documentation": "The number of instances active in the simulation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#InstanceCount", "code_sample": "" }, "@roblox/globaltype/DebugSettings.IsScriptStackTracingEnabled": { "documentation": "Whether or not a stacktrace is displayed in the output for an error.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#IsScriptStackTracingEnabled", "code_sample": "" }, "@roblox/globaltype/DebugSettings.JobCount": { "documentation": "Returns the number of internal DataModel jobs actively being processed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#JobCount", "code_sample": "" }, "@roblox/globaltype/DebugSettings.PlayerCount": { "documentation": "The number of players currently in the active game-instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#PlayerCount", "code_sample": "" }, "@roblox/globaltype/DebugSettings.ReportSoundWarnings": { "documentation": "Whether or not sound warnings should be reported.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#ReportSoundWarnings", "code_sample": "" }, "@roblox/globaltype/DebugSettings.RobloxVersion": { "documentation": "The current client version of Roblox. Can also be retrieved by using the version() function.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#RobloxVersion", "code_sample": "" }, "@roblox/globaltype/DebugSettings.TickCountPreciseOverride": { "documentation": "Sets the internal sampling method used to measure elapsed time with consistency across platforms.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DebugSettings#TickCountPreciseOverride", "code_sample": "" }, "@roblox/globaltype/BaseWrap": { "documentation": "", "keys": { "CageMeshContent": "@roblox/globaltype/BaseWrap.CageMeshContent", "CageMeshId": "@roblox/globaltype/BaseWrap.CageMeshId", "CageOrigin": "@roblox/globaltype/BaseWrap.CageOrigin", "CageOriginWorld": "@roblox/globaltype/BaseWrap.CageOriginWorld", "HSRAssetId": "@roblox/globaltype/BaseWrap.HSRAssetId", "ImportOrigin": "@roblox/globaltype/BaseWrap.ImportOrigin", "ImportOriginWorld": "@roblox/globaltype/BaseWrap.ImportOriginWorld" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap", "code_sample": "" }, "@roblox/globaltype/BaseWrap.CageMeshContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshContent", "code_sample": "" }, "@roblox/globaltype/BaseWrap.CageMeshId": { "documentation": "Asset ID for cage mesh.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageMeshId", "code_sample": "" }, "@roblox/globaltype/BaseWrap.CageOrigin": { "documentation": "Cage mesh offset relative to parent MeshPart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageOrigin", "code_sample": "" }, "@roblox/globaltype/BaseWrap.CageOriginWorld": { "documentation": "Cage mesh offset in world space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#CageOriginWorld", "code_sample": "" }, "@roblox/globaltype/BaseWrap.HSRAssetId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#HSRAssetId", "code_sample": "" }, "@roblox/globaltype/BaseWrap.ImportOrigin": { "documentation": "Describes where a global zero was while authoring the cage mesh in an asset creation tool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#ImportOrigin", "code_sample": "" }, "@roblox/globaltype/BaseWrap.ImportOriginWorld": { "documentation": "Describes where the origin (in world space) was while authoring the cage mesh in an asset creation tool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseWrap#ImportOriginWorld", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder": { "documentation": "", "keys": { "AddPathsToBundle": "@roblox/globaltype/IncrementalPatchBuilder.AddPathsToBundle", "BuildDebouncePeriod": "@roblox/globaltype/IncrementalPatchBuilder.BuildDebouncePeriod", "HighCompression": "@roblox/globaltype/IncrementalPatchBuilder.HighCompression", "SerializePatch": "@roblox/globaltype/IncrementalPatchBuilder.SerializePatch", "UseFileLevelCompressionInsteadOfChunk": "@roblox/globaltype/IncrementalPatchBuilder.UseFileLevelCompressionInsteadOfChunk", "ZstdCompression": "@roblox/globaltype/IncrementalPatchBuilder.ZstdCompression" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder.AddPathsToBundle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#AddPathsToBundle", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder.BuildDebouncePeriod": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#BuildDebouncePeriod", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder.HighCompression": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#HighCompression", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder.SerializePatch": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#SerializePatch", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder.UseFileLevelCompressionInsteadOfChunk": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#UseFileLevelCompressionInsteadOfChunk", "code_sample": "" }, "@roblox/globaltype/IncrementalPatchBuilder.ZstdCompression": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IncrementalPatchBuilder#ZstdCompression", "code_sample": "" }, "@roblox/globaltype/ClimbController": { "documentation": "", "keys": { "AccelerationTime": "@roblox/globaltype/ClimbController.AccelerationTime", "BalanceMaxTorque": "@roblox/globaltype/ClimbController.BalanceMaxTorque", "BalanceSpeed": "@roblox/globaltype/ClimbController.BalanceSpeed", "MoveMaxForce": "@roblox/globaltype/ClimbController.MoveMaxForce" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClimbController", "code_sample": "" }, "@roblox/globaltype/ClimbController.AccelerationTime": { "documentation": "The amount of time taken to reach the desired climb velocity from 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClimbController#AccelerationTime", "code_sample": "" }, "@roblox/globaltype/ClimbController.BalanceMaxTorque": { "documentation": "The maximum torque used to keep the ControllerManager.RootPart aligned upright and aligned to the climbed surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClimbController#BalanceMaxTorque", "code_sample": "" }, "@roblox/globaltype/ClimbController.BalanceSpeed": { "documentation": "The maximum angular speed used to align the ControllerManager.RootPart upright and with the climbed surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClimbController#BalanceSpeed", "code_sample": "" }, "@roblox/globaltype/ClimbController.MoveMaxForce": { "documentation": "The maximum force used by the climbing \"motor\" to move the ControllerManager.RootPart or keep it stationary.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClimbController#MoveMaxForce", "code_sample": "" }, "@roblox/globaltype/BodyMover": { "documentation": "Deprecated: This class has been deprecated. See the mover constraints article for an overview of BodyMover replacements, as well as the legacy conversion notes.
Base class for objects that continually exert forces to assemblies.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyMover", "code_sample": "" }, "@roblox/globaltype/PluginMenu": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus.", "keys": { "Icon": "@roblox/globaltype/PluginMenu.Icon", "Title": "@roblox/globaltype/PluginMenu.Title", "AddAction": "@roblox/globaltype/PluginMenu.AddAction", "AddMenu": "@roblox/globaltype/PluginMenu.AddMenu", "AddNewAction": "@roblox/globaltype/PluginMenu.AddNewAction", "AddSeparator": "@roblox/globaltype/PluginMenu.AddSeparator", "Clear": "@roblox/globaltype/PluginMenu.Clear", "ShowAsync": "@roblox/globaltype/PluginMenu.ShowAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu", "code_sample": "" }, "@roblox/globaltype/PluginMenu.Icon": { "documentation": "The icon to be displayed when used as a submenu.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#Icon", "code_sample": "" }, "@roblox/globaltype/PluginMenu.Title": { "documentation": "The text to be displayed when used as a submenu.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#Title", "code_sample": "" }, "@roblox/globaltype/PluginMenu.AddAction/param/0": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus." }, "@roblox/globaltype/PluginMenu.AddAction/param/1": { "documentation": "The action to add." }, "@roblox/globaltype/PluginMenu.AddAction": { "documentation": "Adds the given action to the menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMenu.AddAction/param/0" }, { "name": "action", "documentation": "@roblox/globaltype/PluginMenu.AddAction/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddAction", "code_sample": "" }, "@roblox/globaltype/PluginMenu.AddMenu/param/0": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus." }, "@roblox/globaltype/PluginMenu.AddMenu/param/1": { "documentation": "The menu to add as a submenu. Uses its Title and Icon to display." }, "@roblox/globaltype/PluginMenu.AddMenu": { "documentation": "Adds the given menu as a separator.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMenu.AddMenu/param/0" }, { "name": "menu", "documentation": "@roblox/globaltype/PluginMenu.AddMenu/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddMenu", "code_sample": "" }, "@roblox/globaltype/PluginMenu.AddNewAction/param/0": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus." }, "@roblox/globaltype/PluginMenu.AddNewAction/param/1": { "documentation": "Must be a unique string that identifies this PluginAction from others." }, "@roblox/globaltype/PluginMenu.AddNewAction/param/2": { "documentation": "The text to be displayed." }, "@roblox/globaltype/PluginMenu.AddNewAction/param/3": { "documentation": "The icon to be displayed." }, "@roblox/globaltype/PluginMenu.AddNewAction/return/0": { "documentation": "The created PluginAction." }, "@roblox/globaltype/PluginMenu.AddNewAction": { "documentation": "Creates a temporary action that is hidden from Studio's customize shortcuts window.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMenu.AddNewAction/param/0" }, { "name": "actionId", "documentation": "@roblox/globaltype/PluginMenu.AddNewAction/param/1" }, { "name": "text", "documentation": "@roblox/globaltype/PluginMenu.AddNewAction/param/2" }, { "name": "icon", "documentation": "@roblox/globaltype/PluginMenu.AddNewAction/param/3" } ], "returns": [ "@roblox/globaltype/PluginMenu.AddNewAction/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddNewAction", "code_sample": "" }, "@roblox/globaltype/PluginMenu.AddSeparator/param/0": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus." }, "@roblox/globaltype/PluginMenu.AddSeparator": { "documentation": "Adds a separator between items in the menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMenu.AddSeparator/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#AddSeparator", "code_sample": "" }, "@roblox/globaltype/PluginMenu.Clear/param/0": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus." }, "@roblox/globaltype/PluginMenu.Clear": { "documentation": "Clears the menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMenu.Clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#Clear", "code_sample": "" }, "@roblox/globaltype/PluginMenu.ShowAsync/param/0": { "documentation": "A context menu that can be shown in Studio. Displays a list of PluginActions and supports submenus." }, "@roblox/globaltype/PluginMenu.ShowAsync/return/0": { "documentation": "The PluginAction item that was selected or nil." }, "@roblox/globaltype/PluginMenu.ShowAsync": { "documentation": "Shows the menu at the mouse cursor. Yields until either an item is selected or the menu is closed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMenu.ShowAsync/param/0" } ], "returns": [ "@roblox/globaltype/PluginMenu.ShowAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMenu#ShowAsync", "code_sample": "" }, "@roblox/globaltype/PartAdornment": { "documentation": "An abstract class for GUI elements that are adorned to (displayed as attached to) objects deriving from BasePart.", "keys": { "Adornee": "@roblox/globaltype/PartAdornment.Adornee" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartAdornment", "code_sample": "" }, "@roblox/globaltype/PartAdornment.Adornee": { "documentation": "Sets the object to adorn to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartAdornment#Adornee", "code_sample": "" }, "@roblox/globaltype/LuaWebService": { "documentation": "An internal service, which is responsible for retrieving HTTP data from websites. Used by a range of services, including MarketplaceService, InsertService and HttpService. Its functions cannot be accessed by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LuaWebService", "code_sample": "" }, "@roblox/globaltype/SelectionBox": { "documentation": "Renders a 3D box around its Adornee.", "keys": { "LineThickness": "@roblox/globaltype/SelectionBox.LineThickness", "SurfaceColor": "@roblox/globaltype/SelectionBox.SurfaceColor", "SurfaceColor3": "@roblox/globaltype/SelectionBox.SurfaceColor3", "SurfaceTransparency": "@roblox/globaltype/SelectionBox.SurfaceTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionBox", "code_sample": "" }, "@roblox/globaltype/SelectionBox.LineThickness": { "documentation": "Determines the thickness of the boxes outlines, in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionBox#LineThickness", "code_sample": "" }, "@roblox/globaltype/SelectionBox.SurfaceColor": { "documentation": "Deprecated: This property is deprecated in favor of SurfaceColor3 which uses the more precise Color3 data type instead of a BrickColor used by this property.
A BrickColor version of SurfaceColor3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceColor", "code_sample": "" }, "@roblox/globaltype/SelectionBox.SurfaceColor3": { "documentation": "Determines the color of the box's surfaces.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceColor3", "code_sample": "" }, "@roblox/globaltype/SelectionBox.SurfaceTransparency": { "documentation": "Determines the transparency of the box's surfaces.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionBox#SurfaceTransparency", "code_sample": "" }, "@roblox/globaltype/CommerceService": { "documentation": "Supports real-world purchases that you can bundle with digital benefits.", "keys": { "GetCommerceProductInfoAsync": "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync", "PromptCommerceProductPurchase": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase", "PromptRealWorldCommerceBrowser": "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser", "UserEligibleForRealWorldCommerceAsync": "@roblox/globaltype/CommerceService.UserEligibleForRealWorldCommerceAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CommerceService", "code_sample": "" }, "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync/param/0": { "documentation": "Supports real-world purchases that you can bundle with digital benefits." }, "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync/param/1": { "documentation": "" }, "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync/return/0": { "documentation": "" }, "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync": { "documentation": "Retrieves information about the commerce products you are selling in experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync/param/0" }, { "name": "commerceProductId", "documentation": "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync/param/1" } ], "returns": [ "@roblox/globaltype/CommerceService.GetCommerceProductInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CommerceService#GetCommerceProductInfoAsync", "code_sample": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase/param/0": { "documentation": "Supports real-world purchases that you can bundle with digital benefits." }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase/param/1": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase/param/2": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase": { "documentation": "Prompts a user to purchase a commerce product using the provided commerceProductId. Opens a webview that guides the user through the purchasing flow.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase/param/1" }, { "name": "commerceProductId", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchase/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptCommerceProductPurchase", "code_sample": "" }, "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser/param/0": { "documentation": "Supports real-world purchases that you can bundle with digital benefits." }, "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser/param/1": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser/param/2": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser/param/1" }, { "name": "url", "documentation": "@roblox/globaltype/CommerceService.PromptRealWorldCommerceBrowser/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptRealWorldCommerceBrowser", "code_sample": "" }, "@roblox/globaltype/CommerceService.UserEligibleForRealWorldCommerceAsync/param/0": { "documentation": "Supports real-world purchases that you can bundle with digital benefits." }, "@roblox/globaltype/CommerceService.UserEligibleForRealWorldCommerceAsync/return/0": { "documentation": "" }, "@roblox/globaltype/CommerceService.UserEligibleForRealWorldCommerceAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.UserEligibleForRealWorldCommerceAsync/param/0" } ], "returns": [ "@roblox/globaltype/CommerceService.UserEligibleForRealWorldCommerceAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CommerceService#UserEligibleForRealWorldCommerceAsync", "code_sample": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished": { "documentation": "Fires when commerce purchase webview has closed - not an indicator that a purchase was successful.", "keys": { "Connect": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Once", "Wait": "@roblox/globaltype/CommerceService.PromptCommerceProductPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CommerceService#PromptCommerceProductPurchaseFinished", "code_sample": "" }, "@roblox/globaltype/TextChatCommand": { "documentation": "Represents a text chat command.", "keys": { "AutocompleteVisible": "@roblox/globaltype/TextChatCommand.AutocompleteVisible", "Enabled": "@roblox/globaltype/TextChatCommand.Enabled", "PrimaryAlias": "@roblox/globaltype/TextChatCommand.PrimaryAlias", "SecondaryAlias": "@roblox/globaltype/TextChatCommand.SecondaryAlias" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatCommand", "code_sample": "" }, "@roblox/globaltype/TextChatCommand.AutocompleteVisible": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatCommand#AutocompleteVisible", "code_sample": "" }, "@roblox/globaltype/TextChatCommand.Enabled": { "documentation": "Determines whether the TextChatCommand is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatCommand#Enabled", "code_sample": "" }, "@roblox/globaltype/TextChatCommand.PrimaryAlias": { "documentation": "A primary alias used to trigger the TextChatCommand.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatCommand#PrimaryAlias", "code_sample": "" }, "@roblox/globaltype/TextChatCommand.SecondaryAlias": { "documentation": "A secondary alias used to trigger the TextChatCommand.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatCommand#SecondaryAlias", "code_sample": "" }, "@roblox/globaltype/TextChatCommand.Triggered.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatCommand.Triggered.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatCommand.Triggered.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatCommand.Triggered.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatCommand.Triggered.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatCommand.Triggered.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatCommand.Triggered.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatCommand.Triggered.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatCommand.Triggered.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatCommand.Triggered.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatCommand.Triggered.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatCommand.Triggered.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextChatCommand.Triggered": { "documentation": "An event that developers can bind to execute commands.", "keys": { "Connect": "@roblox/globaltype/TextChatCommand.Triggered.Connect", "ConnectParallel": "@roblox/globaltype/TextChatCommand.Triggered.ConnectParallel", "Once": "@roblox/globaltype/TextChatCommand.Triggered.Once", "Wait": "@roblox/globaltype/TextChatCommand.Triggered.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatCommand#Triggered", "code_sample": "" }, "@roblox/globaltype/Dragger": { "documentation": "A helper object used to create tools that can drag parts.", "keys": { "AxisRotate": "@roblox/globaltype/Dragger.AxisRotate", "MouseDown": "@roblox/globaltype/Dragger.MouseDown", "MouseMove": "@roblox/globaltype/Dragger.MouseMove", "MouseUp": "@roblox/globaltype/Dragger.MouseUp" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dragger", "code_sample": "" }, "@roblox/globaltype/Dragger.AxisRotate/param/0": { "documentation": "A helper object used to create tools that can drag parts." }, "@roblox/globaltype/Dragger.AxisRotate/param/1": { "documentation": "" }, "@roblox/globaltype/Dragger.AxisRotate": { "documentation": "Rotates the currently dragged part(s) by 90 degrees on the given axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dragger.AxisRotate/param/0" }, { "name": "axis", "documentation": "@roblox/globaltype/Dragger.AxisRotate/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dragger#AxisRotate", "code_sample": "" }, "@roblox/globaltype/Dragger.MouseDown/param/0": { "documentation": "A helper object used to create tools that can drag parts." }, "@roblox/globaltype/Dragger.MouseDown/param/1": { "documentation": "" }, "@roblox/globaltype/Dragger.MouseDown/param/2": { "documentation": "" }, "@roblox/globaltype/Dragger.MouseDown/param/3": { "documentation": "" }, "@roblox/globaltype/Dragger.MouseDown": { "documentation": "Initializes a dragging action, specifying which parts to use when dragging.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dragger.MouseDown/param/0" }, { "name": "mousePart", "documentation": "@roblox/globaltype/Dragger.MouseDown/param/1" }, { "name": "pointOnMousePart", "documentation": "@roblox/globaltype/Dragger.MouseDown/param/2" }, { "name": "parts", "documentation": "@roblox/globaltype/Dragger.MouseDown/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dragger#MouseDown", "code_sample": "" }, "@roblox/globaltype/Dragger.MouseMove/param/0": { "documentation": "A helper object used to create tools that can drag parts." }, "@roblox/globaltype/Dragger.MouseMove/param/1": { "documentation": "" }, "@roblox/globaltype/Dragger.MouseMove": { "documentation": "Tries to move the currently dragged part to the point where MouseRay hits another part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dragger.MouseMove/param/0" }, { "name": "mouseRay", "documentation": "@roblox/globaltype/Dragger.MouseMove/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dragger#MouseMove", "code_sample": "" }, "@roblox/globaltype/Dragger.MouseUp/param/0": { "documentation": "A helper object used to create tools that can drag parts." }, "@roblox/globaltype/Dragger.MouseUp": { "documentation": "Stops the current dragging action (made by Dragger:MouseDown()).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dragger.MouseUp/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dragger#MouseUp", "code_sample": "" }, "@roblox/globaltype/WrapTextureTransfer": { "documentation": "WrapTextureTransfer allows a parent Decal to be wrapped around its parent MeshPart based on the cage of its WrapTarget.", "keys": { "ReferenceCageMeshContent": "@roblox/globaltype/WrapTextureTransfer.ReferenceCageMeshContent", "UVMaxBound": "@roblox/globaltype/WrapTextureTransfer.UVMaxBound", "UVMinBound": "@roblox/globaltype/WrapTextureTransfer.UVMinBound" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer", "code_sample": "" }, "@roblox/globaltype/WrapTextureTransfer.ReferenceCageMeshContent": { "documentation": "An optional reference mesh used for pruning and validating the target cage.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#ReferenceCageMeshContent", "code_sample": "" }, "@roblox/globaltype/WrapTextureTransfer.UVMaxBound": { "documentation": "Determines the maximum bound of the UV space to include in the transfer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMaxBound", "code_sample": "" }, "@roblox/globaltype/WrapTextureTransfer.UVMinBound": { "documentation": "Determines the minimum bound of the UV space to include in the transfer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTextureTransfer#UVMinBound", "code_sample": "" }, "@roblox/globaltype/ScreenshotCapture": { "documentation": "A child class of Capture for screenshots.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotCapture", "code_sample": "" }, "@roblox/globaltype/WrapLayer": { "documentation": "The WrapLayer object defines a 3D accessory's inner and outer surfaces and other properties related to layering accessories. These surfaces, or the Inner Cage and Outer Cage, are similar to collision boxes, and describe the surfaces of which other 3D accessories can be placed without clipping or breaking.", "keys": { "AutoSkin": "@roblox/globaltype/WrapLayer.AutoSkin", "BindOffset": "@roblox/globaltype/WrapLayer.BindOffset", "Color": "@roblox/globaltype/WrapLayer.Color", "DebugMode": "@roblox/globaltype/WrapLayer.DebugMode", "Enabled": "@roblox/globaltype/WrapLayer.Enabled", "Order": "@roblox/globaltype/WrapLayer.Order", "Puffiness": "@roblox/globaltype/WrapLayer.Puffiness", "ReferenceMeshContent": "@roblox/globaltype/WrapLayer.ReferenceMeshContent", "ReferenceMeshId": "@roblox/globaltype/WrapLayer.ReferenceMeshId", "ReferenceOrigin": "@roblox/globaltype/WrapLayer.ReferenceOrigin", "ReferenceOriginWorld": "@roblox/globaltype/WrapLayer.ReferenceOriginWorld", "ShrinkFactor": "@roblox/globaltype/WrapLayer.ShrinkFactor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer", "code_sample": "" }, "@roblox/globaltype/WrapLayer.AutoSkin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#AutoSkin", "code_sample": "" }, "@roblox/globaltype/WrapLayer.BindOffset": { "documentation": "CFrame is used to adjust a binding point for clothing item mesh. Could be used to move and rotate clothing items. This property is intended for fine-tuning only and it is heavily optional.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#BindOffset", "code_sample": "" }, "@roblox/globaltype/WrapLayer.Color": { "documentation": "Sets color used for the debug rendering. See WrapTarget.DebugMode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#Color", "code_sample": "" }, "@roblox/globaltype/WrapLayer.DebugMode": { "documentation": "Allows switching between different debugging visualization modes for cage meshes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#DebugMode", "code_sample": "" }, "@roblox/globaltype/WrapLayer.Enabled": { "documentation": "Allows for disabling of the WrapLayer object as if it does not exist.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#Enabled", "code_sample": "" }, "@roblox/globaltype/WrapLayer.Order": { "documentation": "Controls the composition order for layered clothing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#Order", "code_sample": "" }, "@roblox/globaltype/WrapLayer.Puffiness": { "documentation": "Controls how much underlying clothing items inflate the current clothing item.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#Puffiness", "code_sample": "" }, "@roblox/globaltype/WrapLayer.ReferenceMeshContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshContent", "code_sample": "" }, "@roblox/globaltype/WrapLayer.ReferenceMeshId": { "documentation": "AssetID for reference mesh used to define Inner Cage of a 3D object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceMeshId", "code_sample": "" }, "@roblox/globaltype/WrapLayer.ReferenceOrigin": { "documentation": "Reference mesh offset relative to parent MeshPart (in the parent MeshPart space) Note: this property is set up automatically by the FBX importer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceOrigin", "code_sample": "" }, "@roblox/globaltype/WrapLayer.ReferenceOriginWorld": { "documentation": "Reference mesh offset relative to parent MeshPart (in the world space) Note: this property is set up automatically by the FBX importer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ReferenceOriginWorld", "code_sample": "" }, "@roblox/globaltype/WrapLayer.ShrinkFactor": { "documentation": "Allows slight shrinking/expanding of the resulting render mesh, without affecting any other layers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapLayer#ShrinkFactor", "code_sample": "" }, "@roblox/globaltype/LoginService": { "documentation": "An internal service whose functionality is not available to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LoginService", "code_sample": "" }, "@roblox/globaltype/WorldModel": { "documentation": "Extends limited physics for its children on to a parent ViewportFrame.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldModel", "code_sample": "" }, "@roblox/globaltype/DynamicRotate": { "documentation": "The base class for classic motor joints.", "keys": { "BaseAngle": "@roblox/globaltype/DynamicRotate.BaseAngle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DynamicRotate", "code_sample": "" }, "@roblox/globaltype/DynamicRotate.BaseAngle": { "documentation": "The base angle of the DynamicRotate object, in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DynamicRotate#BaseAngle", "code_sample": "" }, "@roblox/globaltype/AnimationRigData": { "documentation": "Used to store information regarding the model an animation was authored for.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationRigData", "code_sample": "" }, "@roblox/globaltype/HandlesBase": { "documentation": "An abstract class for Handle objects, such as ArcHandles and Handles.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandlesBase", "code_sample": "" }, "@roblox/globaltype/VideoPlayer": { "documentation": "Used to play video assets.", "keys": { "AutoLoadInStudio": "@roblox/globaltype/VideoPlayer.AutoLoadInStudio", "AutoPlayInStudio": "@roblox/globaltype/VideoPlayer.AutoPlayInStudio", "IsLoaded": "@roblox/globaltype/VideoPlayer.IsLoaded", "IsPlaying": "@roblox/globaltype/VideoPlayer.IsPlaying", "Looping": "@roblox/globaltype/VideoPlayer.Looping", "PlaybackSpeed": "@roblox/globaltype/VideoPlayer.PlaybackSpeed", "Resolution": "@roblox/globaltype/VideoPlayer.Resolution", "TimeLength": "@roblox/globaltype/VideoPlayer.TimeLength", "TimePosition": "@roblox/globaltype/VideoPlayer.TimePosition", "VideoContent": "@roblox/globaltype/VideoPlayer.VideoContent", "Volume": "@roblox/globaltype/VideoPlayer.Volume", "GetConnectedWires": "@roblox/globaltype/VideoPlayer.GetConnectedWires", "GetInputPins": "@roblox/globaltype/VideoPlayer.GetInputPins", "GetOutputPins": "@roblox/globaltype/VideoPlayer.GetOutputPins", "LoadAsync": "@roblox/globaltype/VideoPlayer.LoadAsync", "Pause": "@roblox/globaltype/VideoPlayer.Pause", "Play": "@roblox/globaltype/VideoPlayer.Play", "Unload": "@roblox/globaltype/VideoPlayer.Unload" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.AutoLoadInStudio": { "documentation": "Loads the VideoContent while in Studio Edit mode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#AutoLoadInStudio", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.AutoPlayInStudio": { "documentation": "Plays the VideoContent while in Studio Edit mode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#AutoPlayInStudio", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.IsLoaded": { "documentation": "Indicates when the VideoContent has loaded and is ready to play.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#IsLoaded", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.IsPlaying": { "documentation": "Denotes whether this VideoPlayer is currently playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#IsPlaying", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.Looping": { "documentation": "Controls whether this VideoPlayer loops.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Looping", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.PlaybackSpeed": { "documentation": "Controls the speed at which the video is played.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#PlaybackSpeed", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.Resolution": { "documentation": "Gets the original source resolution of the VideoContent file.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Resolution", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.TimeLength": { "documentation": "Indicates the length of the VideoContent in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#TimeLength", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.TimePosition": { "documentation": "Indicates the progress in seconds of the VideoContent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#TimePosition", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.VideoContent": { "documentation": "The asset to be loaded into the VideoPlayer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#VideoContent", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.Volume": { "documentation": "Controls how loudly the audio track will be played.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Volume", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.GetConnectedWires/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/VideoPlayer.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/VideoPlayer.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.GetInputPins/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/VideoPlayer.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetInputPins", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.GetOutputPins/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/VideoPlayer.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.LoadAsync/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.LoadAsync/return/0": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.LoadAsync": { "documentation": "Loads the VideoContent before it is played.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.LoadAsync/param/0" } ], "returns": [ "@roblox/globaltype/VideoPlayer.LoadAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#LoadAsync", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.Pause/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.Pause": { "documentation": "Pauses the VideoPlayer wherever its TimePosition is.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.Pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Pause", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.Play/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.Play": { "documentation": "Plays the VideoPlayer from wherever its TimePosition is.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Play", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.Unload/param/0": { "documentation": "Used to play video assets." }, "@roblox/globaltype/VideoPlayer.Unload": { "documentation": "Unloads the VideoPlayer.VideoContent to save resources.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.Unload/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#Unload", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.DidEnd.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidEnd.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.DidEnd.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidEnd.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidEnd.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.DidEnd.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidEnd.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidEnd.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.DidEnd.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidEnd.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidEnd.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidEnd.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidEnd": { "documentation": "Fires when the VideoContent has completed playback and stopped.", "keys": { "Connect": "@roblox/globaltype/VideoPlayer.DidEnd.Connect", "ConnectParallel": "@roblox/globaltype/VideoPlayer.DidEnd.ConnectParallel", "Once": "@roblox/globaltype/VideoPlayer.DidEnd.Once", "Wait": "@roblox/globaltype/VideoPlayer.DidEnd.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidEnd", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.DidLoop.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidLoop.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.DidLoop.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidLoop.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidLoop.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.DidLoop.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidLoop.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidLoop.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.DidLoop.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidLoop.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.DidLoop.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.DidLoop.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.DidLoop": { "documentation": "Fires when the VideoContent loops.", "keys": { "Connect": "@roblox/globaltype/VideoPlayer.DidLoop.Connect", "ConnectParallel": "@roblox/globaltype/VideoPlayer.DidLoop.ConnectParallel", "Once": "@roblox/globaltype/VideoPlayer.DidLoop.Once", "Wait": "@roblox/globaltype/VideoPlayer.DidLoop.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#DidLoop", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.PlayFailed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.PlayFailed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.PlayFailed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.PlayFailed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.PlayFailed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.PlayFailed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.PlayFailed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.PlayFailed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.PlayFailed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.PlayFailed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.PlayFailed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.PlayFailed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.PlayFailed": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/VideoPlayer.PlayFailed.Connect", "ConnectParallel": "@roblox/globaltype/VideoPlayer.PlayFailed.ConnectParallel", "Once": "@roblox/globaltype/VideoPlayer.PlayFailed.Once", "Wait": "@roblox/globaltype/VideoPlayer.PlayFailed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#PlayFailed", "code_sample": "" }, "@roblox/globaltype/VideoPlayer.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoPlayer.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoPlayer.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoPlayer.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoPlayer.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the VideoPlayer via a Wire.", "keys": { "Connect": "@roblox/globaltype/VideoPlayer.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/VideoPlayer.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/VideoPlayer.WiringChanged.Once", "Wait": "@roblox/globaltype/VideoPlayer.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#WiringChanged", "code_sample": "" }, "@roblox/globaltype/Chat": { "documentation": "Houses the Luau code responsible for running the legacy chat system.", "keys": { "BubbleChatEnabled": "@roblox/globaltype/Chat.BubbleChatEnabled", "LoadDefaultChat": "@roblox/globaltype/Chat.LoadDefaultChat", "CanUserChatAsync": "@roblox/globaltype/Chat.CanUserChatAsync", "CanUsersChatAsync": "@roblox/globaltype/Chat.CanUsersChatAsync", "Chat": "@roblox/globaltype/Chat.Chat", "FilterStringAsync": "@roblox/globaltype/Chat.FilterStringAsync", "FilterStringForBroadcast": "@roblox/globaltype/Chat.FilterStringForBroadcast", "FilterStringForPlayerAsync": "@roblox/globaltype/Chat.FilterStringForPlayerAsync", "InvokeChatCallback": "@roblox/globaltype/Chat.InvokeChatCallback", "RegisterChatCallback": "@roblox/globaltype/Chat.RegisterChatCallback", "SetBubbleChatSettings": "@roblox/globaltype/Chat.SetBubbleChatSettings" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat", "code_sample": "" }, "@roblox/globaltype/Chat.BubbleChatEnabled": { "documentation": "Determines whether player's chat messages will appear above their in-game avatar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#BubbleChatEnabled", "code_sample": "" }, "@roblox/globaltype/Chat.LoadDefaultChat": { "documentation": "Toggles whether the default chat framework should be automatically loaded when the game runs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#LoadDefaultChat", "code_sample": "" }, "@roblox/globaltype/Chat.CanUserChatAsync/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.CanUserChatAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Chat.CanUserChatAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Chat.CanUserChatAsync": { "documentation": "Will return false if the player with the specified Player.UserId is not allowed to chat because of their account settings.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.CanUserChatAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Chat.CanUserChatAsync/param/1" } ], "returns": [ "@roblox/globaltype/Chat.CanUserChatAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#CanUserChatAsync", "code_sample": "" }, "@roblox/globaltype/Chat.CanUsersChatAsync/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.CanUsersChatAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Chat.CanUsersChatAsync/param/2": { "documentation": "" }, "@roblox/globaltype/Chat.CanUsersChatAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Chat.CanUsersChatAsync": { "documentation": "Will return false if the two users cannot communicate because their account settings do not allow it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.CanUsersChatAsync/param/0" }, { "name": "userIdFrom", "documentation": "@roblox/globaltype/Chat.CanUsersChatAsync/param/1" }, { "name": "userIdTo", "documentation": "@roblox/globaltype/Chat.CanUsersChatAsync/param/2" } ], "returns": [ "@roblox/globaltype/Chat.CanUsersChatAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#CanUsersChatAsync", "code_sample": "" }, "@roblox/globaltype/Chat.Chat/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.Chat/param/1": { "documentation": "An instance that is the part or character which the BubbleChat dialog should appear above." }, "@roblox/globaltype/Chat.Chat/param/2": { "documentation": "The message string being chatted." }, "@roblox/globaltype/Chat.Chat/param/3": { "documentation": "An ChatColor specifying the color of the chatted message." }, "@roblox/globaltype/Chat.Chat": { "documentation": "Fires the Chat.Chatted event with the parameters specified in this method.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.Chat/param/0" }, { "name": "partOrCharacter", "documentation": "@roblox/globaltype/Chat.Chat/param/1" }, { "name": "message", "documentation": "@roblox/globaltype/Chat.Chat/param/2" }, { "name": "color", "documentation": "@roblox/globaltype/Chat.Chat/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#Chat", "code_sample": "local ChatService = game:GetService(\"Chat\")\n\nlocal part = Instance.new(\"Part\")\npart.Anchored = true\npart.Parent = workspace\n\nChatService:Chat(part, \"Blame John!\", \"Red\")" }, "@roblox/globaltype/Chat.FilterStringAsync/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.FilterStringAsync/param/1": { "documentation": "The raw string to be filtered, exactly as entered by the player." }, "@roblox/globaltype/Chat.FilterStringAsync/param/2": { "documentation": "The author of the text." }, "@roblox/globaltype/Chat.FilterStringAsync/param/3": { "documentation": "The intended recipient of the provided text; use the author if the text is persistent (see description)." }, "@roblox/globaltype/Chat.FilterStringAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Chat.FilterStringAsync": { "documentation": "Filters a string sent from a player to another player using filtering that is appropriate to the players' account settings.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.FilterStringAsync/param/0" }, { "name": "stringToFilter", "documentation": "@roblox/globaltype/Chat.FilterStringAsync/param/1" }, { "name": "playerFrom", "documentation": "@roblox/globaltype/Chat.FilterStringAsync/param/2" }, { "name": "playerTo", "documentation": "@roblox/globaltype/Chat.FilterStringAsync/param/3" } ], "returns": [ "@roblox/globaltype/Chat.FilterStringAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringAsync", "code_sample": "" }, "@roblox/globaltype/Chat.FilterStringForBroadcast/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.FilterStringForBroadcast/param/1": { "documentation": "Message string being filtered." }, "@roblox/globaltype/Chat.FilterStringForBroadcast/param/2": { "documentation": "Instance of the player sending the message." }, "@roblox/globaltype/Chat.FilterStringForBroadcast/return/0": { "documentation": "Filtered message string." }, "@roblox/globaltype/Chat.FilterStringForBroadcast": { "documentation": "Filters a string sent from a player meant for broadcast to no particular target. More restrictive than Chat:FilterStringAsync().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.FilterStringForBroadcast/param/0" }, { "name": "stringToFilter", "documentation": "@roblox/globaltype/Chat.FilterStringForBroadcast/param/1" }, { "name": "playerFrom", "documentation": "@roblox/globaltype/Chat.FilterStringForBroadcast/param/2" } ], "returns": [ "@roblox/globaltype/Chat.FilterStringForBroadcast/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringForBroadcast", "code_sample": "local Players = game:GetService(\"Players\")\nlocal Chat = game:GetService(\"Chat\")\n\nlocal playerFrom = Players.LocalPlayer\nlocal message = \"Hello world!\"\n\n-- Filter the string and store the result in the 'FilteredString' variable\nlocal filteredString = Chat:FilterStringForBroadcast(message, playerFrom)\n\nprint(filteredString)" }, "@roblox/globaltype/Chat.FilterStringForPlayerAsync/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.FilterStringForPlayerAsync/param/1": { "documentation": "String being filtered." }, "@roblox/globaltype/Chat.FilterStringForPlayerAsync/param/2": { "documentation": "Player that the string is being filtered for." }, "@roblox/globaltype/Chat.FilterStringForPlayerAsync/return/0": { "documentation": "Filtered string result." }, "@roblox/globaltype/Chat.FilterStringForPlayerAsync": { "documentation": "Deprecated: This item has been superseded by Chat:FilterStringAsync() and Chat:FilterStringForBroadcast() which should be used in all new work
Filters a string appropriate to the given player's age settings, so they see what is appropriate to them.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.FilterStringForPlayerAsync/param/0" }, { "name": "stringToFilter", "documentation": "@roblox/globaltype/Chat.FilterStringForPlayerAsync/param/1" }, { "name": "playerToFilterFor", "documentation": "@roblox/globaltype/Chat.FilterStringForPlayerAsync/param/2" } ], "returns": [ "@roblox/globaltype/Chat.FilterStringForPlayerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#FilterStringForPlayerAsync", "code_sample": "" }, "@roblox/globaltype/Chat.InvokeChatCallback/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.InvokeChatCallback/param/1": { "documentation": "The type of callback to invoke." }, "@roblox/globaltype/Chat.InvokeChatCallback/param/2": { "documentation": "The arguments that will be sent to the registered callback function." }, "@roblox/globaltype/Chat.InvokeChatCallback/return/0": { "documentation": "The values returned by the function registered to the given ChatCallbackType." }, "@roblox/globaltype/Chat.InvokeChatCallback": { "documentation": "Invoke a chat callback function registered by RegisterChatCallback. Used by the Luau Chat System.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.InvokeChatCallback/param/0" }, { "name": "callbackType", "documentation": "@roblox/globaltype/Chat.InvokeChatCallback/param/1" }, { "name": "callbackArguments", "documentation": "@roblox/globaltype/Chat.InvokeChatCallback/param/2" } ], "returns": [ "@roblox/globaltype/Chat.InvokeChatCallback/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#InvokeChatCallback", "code_sample": "" }, "@roblox/globaltype/Chat.RegisterChatCallback/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.RegisterChatCallback/param/1": { "documentation": "The callback to which the function shall be registered (this determines in what way the function is called)." }, "@roblox/globaltype/Chat.RegisterChatCallback/param/2": { "documentation": "The function to call when the callback is invoked using Chat:InvokeChatCallback." }, "@roblox/globaltype/Chat.RegisterChatCallback": { "documentation": "Register a function to be called upon the invocation of some chat system event (InvokeChatCallback).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.RegisterChatCallback/param/0" }, { "name": "callbackType", "documentation": "@roblox/globaltype/Chat.RegisterChatCallback/param/1" }, { "name": "callbackFunction", "documentation": "@roblox/globaltype/Chat.RegisterChatCallback/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#RegisterChatCallback", "code_sample": "" }, "@roblox/globaltype/Chat.SetBubbleChatSettings/param/0": { "documentation": "Houses the Luau code responsible for running the legacy chat system." }, "@roblox/globaltype/Chat.SetBubbleChatSettings/param/1": { "documentation": "A settings table." }, "@roblox/globaltype/Chat.SetBubbleChatSettings": { "documentation": "Customizes various settings of the in-game bubble chat.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.SetBubbleChatSettings/param/0" }, { "name": "settings", "documentation": "@roblox/globaltype/Chat.SetBubbleChatSettings/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#SetBubbleChatSettings", "code_sample": "local ChatService = game:GetService(\"Chat\")\n\nChatService:SetBubbleChatSettings({\n\tBackgroundColor3 = Color3.fromRGB(180, 210, 228),\n\tTextSize = 20,\n\tFont = Enum.Font.Cartoon,\n})" }, "@roblox/globaltype/Chat.Chatted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Chat.Chatted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Chat.Chatted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.Chatted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Chat.Chatted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Chat.Chatted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Chat.Chatted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Chat.Chatted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.Chatted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Chat.Chatted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Chat.Chatted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Chat.Chatted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Chat.Chatted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.Chatted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Chat.Chatted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Chat.Chatted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Chat.Chatted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Chat.Chatted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Chat.Chatted": { "documentation": "Fires when Chat:Chat() is called.", "keys": { "Connect": "@roblox/globaltype/Chat.Chatted.Connect", "ConnectParallel": "@roblox/globaltype/Chat.Chatted.ConnectParallel", "Once": "@roblox/globaltype/Chat.Chatted.Once", "Wait": "@roblox/globaltype/Chat.Chatted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Chat#Chatted", "code_sample": "" }, "@roblox/globaltype/RopeConstraint": { "documentation": "Simulates rope dynamics, preventing two attachments from separating further than a defined length.", "keys": { "CurrentDistance": "@roblox/globaltype/RopeConstraint.CurrentDistance", "Length": "@roblox/globaltype/RopeConstraint.Length", "Restitution": "@roblox/globaltype/RopeConstraint.Restitution", "Thickness": "@roblox/globaltype/RopeConstraint.Thickness", "WinchEnabled": "@roblox/globaltype/RopeConstraint.WinchEnabled", "WinchForce": "@roblox/globaltype/RopeConstraint.WinchForce", "WinchResponsiveness": "@roblox/globaltype/RopeConstraint.WinchResponsiveness", "WinchSpeed": "@roblox/globaltype/RopeConstraint.WinchSpeed", "WinchTarget": "@roblox/globaltype/RopeConstraint.WinchTarget" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.CurrentDistance": { "documentation": "The current distance between the constraint's Attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#CurrentDistance", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.Length": { "documentation": "The maximum distance apart the two Attachments can be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#Length", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.Restitution": { "documentation": "Elasticity of the Attachments connected by the constraint when reaching the maximum defined Length. Constrained between 0 and 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#Restitution", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.Thickness": { "documentation": "The visualized thickness of the RopeConstraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#Thickness", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.WinchEnabled": { "documentation": "Enables the winch motor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#WinchEnabled", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.WinchForce": { "documentation": "The maximum force that the winch motor can apply.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#WinchForce", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.WinchResponsiveness": { "documentation": "The sharpness of the winch motor in reaching the WinchTarget.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#WinchResponsiveness", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.WinchSpeed": { "documentation": "A positive desired velocity at which the winch motor changes the rope length.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#WinchSpeed", "code_sample": "" }, "@roblox/globaltype/RopeConstraint.WinchTarget": { "documentation": "The target length for the winch motor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RopeConstraint#WinchTarget", "code_sample": "" }, "@roblox/globaltype/DataModel": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game.", "keys": { "CreatorId": "@roblox/globaltype/DataModel.CreatorId", "CreatorType": "@roblox/globaltype/DataModel.CreatorType", "Environment": "@roblox/globaltype/DataModel.Environment", "GameId": "@roblox/globaltype/DataModel.GameId", "GearGenreSetting": "@roblox/globaltype/DataModel.GearGenreSetting", "Genre": "@roblox/globaltype/DataModel.Genre", "JobId": "@roblox/globaltype/DataModel.JobId", "lighting": "@roblox/globaltype/DataModel.lighting", "MatchmakingType": "@roblox/globaltype/DataModel.MatchmakingType", "PlaceId": "@roblox/globaltype/DataModel.PlaceId", "PlaceVersion": "@roblox/globaltype/DataModel.PlaceVersion", "PrivateServerId": "@roblox/globaltype/DataModel.PrivateServerId", "PrivateServerOwnerId": "@roblox/globaltype/DataModel.PrivateServerOwnerId", "VIPServerId": "@roblox/globaltype/DataModel.VIPServerId", "VIPServerOwnerId": "@roblox/globaltype/DataModel.VIPServerOwnerId", "Workspace": "@roblox/globaltype/DataModel.Workspace", "workspace": "@roblox/globaltype/DataModel.workspace", "BindToClose": "@roblox/globaltype/DataModel.BindToClose", "GetJobsInfo": "@roblox/globaltype/DataModel.GetJobsInfo", "GetMessage": "@roblox/globaltype/DataModel.GetMessage", "GetObjects": "@roblox/globaltype/DataModel.GetObjects", "GetRemoteBuildMode": "@roblox/globaltype/DataModel.GetRemoteBuildMode", "IsGearTypeAllowed": "@roblox/globaltype/DataModel.IsGearTypeAllowed", "IsLoaded": "@roblox/globaltype/DataModel.IsLoaded", "SavePlace": "@roblox/globaltype/DataModel.SavePlace", "SetPlaceId": "@roblox/globaltype/DataModel.SetPlaceId", "SetUniverseId": "@roblox/globaltype/DataModel.SetUniverseId", "OnClose": "@roblox/globaltype/DataModel.OnClose" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel", "code_sample": "local Workspace = game:GetService(\"Workspace\")\nlocal Lighting = game:GetService(\"Lighting\")\n\n-- Examples of modifying properties of these services\nWorkspace.Gravity = 20\nLighting.ClockTime = 4" }, "@roblox/globaltype/DataModel.CreatorId": { "documentation": "Describes the ID of the user or group that owns the place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#CreatorId", "code_sample": "local Players = game:GetService(\"Players\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\tif game.CreatorType == Enum.CreatorType.User then\n\t\tif player.UserId == game.CreatorId then\n\t\t\tprint(\"The place owner has joined the game!\")\n\t\tend\n\telseif game.CreatorType == Enum.CreatorType.Group then\n\t\tif player:IsInGroupAsync(game.CreatorId) then\n\t\t\tprint(\"A member of the group that owns the place has joined the game!\")\n\t\tend\n\tend\nend)" }, "@roblox/globaltype/DataModel.CreatorType": { "documentation": "Describes the CreatorType of the place, whether the place is owned by a user or a group.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#CreatorType", "code_sample": "local Players = game:GetService(\"Players\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\tif game.CreatorType == Enum.CreatorType.User then\n\t\tif player.UserId == game.CreatorId then\n\t\t\tprint(\"The place owner has joined the game!\")\n\t\tend\n\telseif game.CreatorType == Enum.CreatorType.Group then\n\t\tif player:IsInGroupAsync(game.CreatorId) then\n\t\t\tprint(\"A member of the group that owns the place has joined the game!\")\n\t\tend\n\tend\nend)" }, "@roblox/globaltype/DataModel.Environment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#Environment", "code_sample": "" }, "@roblox/globaltype/DataModel.GameId": { "documentation": "Describes the ID of the experience that the place running on the server belongs to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GameId", "code_sample": "" }, "@roblox/globaltype/DataModel.GearGenreSetting": { "documentation": "Deprecated: This property is deprecated and is no longer functional. It should not be used.
Not functional. Historically described the gear permissions of the place as set on the Roblox website.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GearGenreSetting", "code_sample": "" }, "@roblox/globaltype/DataModel.Genre": { "documentation": "Not functional. Historically described the Genre of the place as set on the Roblox website.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#Genre", "code_sample": "" }, "@roblox/globaltype/DataModel.JobId": { "documentation": "A unique identifier for the running game server instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#JobId", "code_sample": "" }, "@roblox/globaltype/DataModel.lighting": { "documentation": "Deprecated: This item has been superseded by game:GetService(\"Lighting\"), which should be used instead.
Refers to the game's Lighting service.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#lighting", "code_sample": "" }, "@roblox/globaltype/DataModel.MatchmakingType": { "documentation": "Represents how players in the server are handled by matchmaking.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#MatchmakingType", "code_sample": "" }, "@roblox/globaltype/DataModel.PlaceId": { "documentation": "Describes the ID of the place running on the server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#PlaceId", "code_sample": "" }, "@roblox/globaltype/DataModel.PlaceVersion": { "documentation": "Describes the version of the place the server is running on.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#PlaceVersion", "code_sample": "local StarterGui = game:GetService(\"StarterGui\")\n\nlocal versionGui = Instance.new(\"ScreenGui\")\n\nlocal textLabel = Instance.new(\"TextLabel\")\ntextLabel.Position = UDim2.new(1, -10, 1, 0)\ntextLabel.AnchorPoint = Vector2.new(1, 1)\ntextLabel.Size = UDim2.new(0, 150, 0, 40)\n\ntextLabel.BackgroundTransparency = 1\ntextLabel.TextColor3 = Color3.new(1, 1, 1)\ntextLabel.TextStrokeTransparency = 0\ntextLabel.TextXAlignment = Enum.TextXAlignment.Right\ntextLabel.TextScaled = true\n\nlocal placeVersion = game.PlaceVersion\ntextLabel.Text = string.format(\"Server version: %s\", placeVersion)\n\ntextLabel.Parent = versionGui\nversionGui.Parent = StarterGui" }, "@roblox/globaltype/DataModel.PrivateServerId": { "documentation": "Describes the private server ID of the server, if the server is a private server or a reserved server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerId", "code_sample": "local function getServerType()\n\tif game.PrivateServerId ~= \"\" then\n\t\tif game.PrivateServerOwnerId ~= 0 then\n\t\t\treturn \"VIPServer\"\n\t\telse\n\t\t\treturn \"ReservedServer\"\n\t\tend\n\telse\n\t\treturn \"StandardServer\"\n\tend\nend\n\nprint(getServerType())" }, "@roblox/globaltype/DataModel.PrivateServerOwnerId": { "documentation": "Describes the UserId of the Player that owns the private server if the server is private.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerOwnerId", "code_sample": "local function getServerType()\n\tif game.PrivateServerId ~= \"\" then\n\t\tif game.PrivateServerOwnerId ~= 0 then\n\t\t\treturn \"VIPServer\"\n\t\telse\n\t\t\treturn \"ReservedServer\"\n\t\tend\n\telse\n\t\treturn \"StandardServer\"\n\tend\nend\n\nprint(getServerType())" }, "@roblox/globaltype/DataModel.VIPServerId": { "documentation": "Deprecated: This property has been deprecated. Use DataModel.PrivateServerId instead.
A string that could identify the current server as a private server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerId", "code_sample": "" }, "@roblox/globaltype/DataModel.VIPServerOwnerId": { "documentation": "Deprecated: This property has been deprecated. Use DataModel.PrivateServerOwnerId instead.
The UserId of the account who owns the private server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#VIPServerOwnerId", "code_sample": "" }, "@roblox/globaltype/DataModel.Workspace": { "documentation": "A reference to the Workspace service.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#Workspace", "code_sample": "" }, "@roblox/globaltype/DataModel.workspace": { "documentation": "Deprecated: This deprecated property is a variant of DataModel.Workspace which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#workspace", "code_sample": "" }, "@roblox/globaltype/DataModel.BindToClose/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.BindToClose/param/1": { "documentation": "A function called before the experience server shuts down. If the bound function accepts a parameter, it passes CloseReason specifying the reason for the server shutdown." }, "@roblox/globaltype/DataModel.BindToClose": { "documentation": "Binds a function to be called before the server shuts down.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.BindToClose/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/DataModel.BindToClose/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#BindToClose", "code_sample": "" }, "@roblox/globaltype/DataModel.GetJobsInfo/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.GetJobsInfo/return/0": { "documentation": "A table containing information about the jobs performed by the task scheduler, see above for the format." }, "@roblox/globaltype/DataModel.GetJobsInfo": { "documentation": "Returns a table containing basic information about the jobs performed by the task scheduler.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GetJobsInfo/param/0" } ], "returns": [ "@roblox/globaltype/DataModel.GetJobsInfo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GetJobsInfo", "code_sample": "local jobInfo = game:GetJobsInfo()\nlocal jobTitles = jobInfo[1]\n\ntable.remove(jobInfo, 1)\n\nlocal divider = string.rep(\"-\", 120)\nprint(divider)\nwarn(\"JOB INFO:\")\nprint(divider)\n\nfor _, job in pairs(jobInfo) do\n\tfor jobIndex, jobValue in pairs(job) do\n\t\tlocal jobTitle = jobTitles[jobIndex]\n\t\twarn(jobTitle, \"=\", jobValue)\n\tend\n\tprint(divider)\nend" }, "@roblox/globaltype/DataModel.GetMessage/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.GetMessage/return/0": { "documentation": "" }, "@roblox/globaltype/DataModel.GetMessage": { "documentation": "Deprecated: This item is deprecated since the system was phased out a very long time ago, and recently the APIs for setting this message were removed.
[OBSOLETE]: This function will always return a blank string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GetMessage/param/0" } ], "returns": [ "@roblox/globaltype/DataModel.GetMessage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GetMessage", "code_sample": "" }, "@roblox/globaltype/DataModel.GetObjects/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.GetObjects/param/1": { "documentation": "The given content URL." }, "@roblox/globaltype/DataModel.GetObjects/return/0": { "documentation": "An array of Instances associated with the content URL." }, "@roblox/globaltype/DataModel.GetObjects": { "documentation": "Returns an array of Instances associated with the given content URL.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GetObjects/param/0" }, { "name": "url", "documentation": "@roblox/globaltype/DataModel.GetObjects/param/1" } ], "returns": [ "@roblox/globaltype/DataModel.GetObjects/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GetObjects", "code_sample": "local Selection = game:GetService(\"Selection\")\n\nlocal WEB_URL = \"plugin URL here\"\n\nlocal function downloadPlugin(webURL)\n\t-- get the content URL\n\tlocal contentID = string.match(webURL, \"%d+\")\n\tlocal contentURL = \"rbxassetid://\" .. contentID\n\n\t-- download the objects\n\tlocal objects = game:GetObjects(contentURL)\n\n\t-- decide where to parent them\n\tlocal selection = Selection:Get()\n\tlocal parent = #selection == 1 and selection[1] or workspace\n\n\t-- parent the objects\n\tfor _, object in pairs(objects) do\n\t\tobject.Parent = parent\n\tend\nend\n\ndownloadPlugin(WEB_URL)" }, "@roblox/globaltype/DataModel.GetRemoteBuildMode/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.GetRemoteBuildMode/return/0": { "documentation": "" }, "@roblox/globaltype/DataModel.GetRemoteBuildMode": { "documentation": "Deprecated: This item is deprecated. Use RunService:IsServer() to see if your code is running on the server.
This method is no longer useful and will always return false.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GetRemoteBuildMode/param/0" } ], "returns": [ "@roblox/globaltype/DataModel.GetRemoteBuildMode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GetRemoteBuildMode", "code_sample": "" }, "@roblox/globaltype/DataModel.IsGearTypeAllowed/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.IsGearTypeAllowed/param/1": { "documentation": "The given GearType." }, "@roblox/globaltype/DataModel.IsGearTypeAllowed/return/0": { "documentation": "Whether gear of the given GearType is permitted in the game." }, "@roblox/globaltype/DataModel.IsGearTypeAllowed": { "documentation": "Deprecated: This property is deprecated and is no longer functional. It should not be used.
Returns whether gear of the given GearType is permitted to be added to Players' StarterGears.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.IsGearTypeAllowed/param/0" }, { "name": "gearType", "documentation": "@roblox/globaltype/DataModel.IsGearTypeAllowed/param/1" } ], "returns": [ "@roblox/globaltype/DataModel.IsGearTypeAllowed/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#IsGearTypeAllowed", "code_sample": "" }, "@roblox/globaltype/DataModel.IsLoaded/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.IsLoaded/return/0": { "documentation": "Whether the client has finished loading the game for the first time." }, "@roblox/globaltype/DataModel.IsLoaded": { "documentation": "Returns true if the client has finished loading the game for the first time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.IsLoaded/param/0" } ], "returns": [ "@roblox/globaltype/DataModel.IsLoaded/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#IsLoaded", "code_sample": "" }, "@roblox/globaltype/DataModel.SavePlace/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.SavePlace/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.SavePlace/return/0": { "documentation": "" }, "@roblox/globaltype/DataModel.SavePlace": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.
Saves the current place.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.SavePlace/param/0" }, { "name": "saveFilter", "documentation": "@roblox/globaltype/DataModel.SavePlace/param/1" } ], "returns": [ "@roblox/globaltype/DataModel.SavePlace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#SavePlace", "code_sample": "" }, "@roblox/globaltype/DataModel.SetPlaceId/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.SetPlaceId/param/1": { "documentation": "The ID to set the DataModel.PlaceId to." }, "@roblox/globaltype/DataModel.SetPlaceId": { "documentation": "Sets the DataModel.PlaceId of the current game instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.SetPlaceId/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/DataModel.SetPlaceId/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#SetPlaceId", "code_sample": "" }, "@roblox/globaltype/DataModel.SetUniverseId/param/0": { "documentation": "The root of Roblox's parent-child hierarchy. Its direct children are services, such as Workspace and Lighting, that act as the fundamental components of a Roblox game." }, "@roblox/globaltype/DataModel.SetUniverseId/param/1": { "documentation": "The ID to set the DataModel.GameId to." }, "@roblox/globaltype/DataModel.SetUniverseId": { "documentation": "Sets the DataModel.GameId of the current game instance to the given universeId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.SetUniverseId/param/0" }, { "name": "universeId", "documentation": "@roblox/globaltype/DataModel.SetUniverseId/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#SetUniverseId", "code_sample": "" }, "@roblox/globaltype/DataModel.OnClose/return/0": { "documentation": "" }, "@roblox/globaltype/DataModel.OnClose": { "documentation": "Deprecated: This function is deprecated. It is recommended to use DataModel:BindToClose() instead.
Invoked before the game is shut down. When this callback returns, or the timeout period is hit, the game finishes shutting down.", "params": [], "returns": [ "@roblox/globaltype/DataModel.OnClose/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#OnClose", "code_sample": "game.OnClose = function()\n\tprint(\"Closing, waiting\")\n\ttask.wait(3)\n\tprint(\"Done\")\nend" }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DataModel.AllowedGearTypeChanged": { "documentation": "Deprecated: This item is deprecated . Do not use it for new work.
Fires when SetGearSettings is called with a different value for allowedGenres.", "keys": { "Connect": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Connect", "ConnectParallel": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.ConnectParallel", "Once": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Once", "Wait": "@roblox/globaltype/DataModel.AllowedGearTypeChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#AllowedGearTypeChanged", "code_sample": "" }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest": { "documentation": "Fires when the user prompts and increase or decrease in graphics quality using the hotkeys.", "keys": { "Connect": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Connect", "ConnectParallel": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.ConnectParallel", "Once": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Once", "Wait": "@roblox/globaltype/DataModel.GraphicsQualityChangeRequest.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#GraphicsQualityChangeRequest", "code_sample": "game.GraphicsQualityChangeRequest:Connect(function(betterQuality)\n\tif betterQuality then\n\t\tprint(\"The user has requested an increase in graphics quality!\")\n\telse\n\t\tprint(\"The user has requested a decrease in graphics quality!\")\n\tend\nend)" }, "@roblox/globaltype/DataModel.ItemChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.ItemChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.ItemChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.ItemChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.ItemChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.ItemChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.ItemChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.ItemChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.ItemChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.ItemChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.ItemChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.ItemChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.ItemChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.ItemChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.ItemChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.ItemChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.ItemChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.ItemChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DataModel.ItemChanged": { "documentation": "Deprecated: This function has been superseded by Object.Changed, which should be used in new work instead.
Fires when a property of any object in the DataModel is changed.", "keys": { "Connect": "@roblox/globaltype/DataModel.ItemChanged.Connect", "ConnectParallel": "@roblox/globaltype/DataModel.ItemChanged.ConnectParallel", "Once": "@roblox/globaltype/DataModel.ItemChanged.Once", "Wait": "@roblox/globaltype/DataModel.ItemChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#ItemChanged", "code_sample": "game.ItemChanged:Connect(function(item, property)\n\tprint(string.format(\"%s.%s has changed\", item.Name, property))\nend)\n\n--> Workspace.DistributedGameTime has changed" }, "@roblox/globaltype/DataModel.Loaded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.Loaded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.Loaded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.Loaded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.Loaded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.Loaded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.Loaded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.Loaded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.Loaded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.Loaded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.Loaded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.Loaded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DataModel.Loaded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.Loaded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DataModel.Loaded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DataModel.Loaded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DataModel.Loaded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataModel.Loaded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DataModel.Loaded": { "documentation": "Fires on the client when the game finishes loading for the first time.", "keys": { "Connect": "@roblox/globaltype/DataModel.Loaded.Connect", "ConnectParallel": "@roblox/globaltype/DataModel.Loaded.ConnectParallel", "Once": "@roblox/globaltype/DataModel.Loaded.Once", "Wait": "@roblox/globaltype/DataModel.Loaded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModel#Loaded", "code_sample": "" }, "@roblox/globaltype/ImageLabel": { "documentation": "A 2D user interface element that displays a single non-interactive image.", "keys": { "Image": "@roblox/globaltype/ImageLabel.Image", "ImageColor3": "@roblox/globaltype/ImageLabel.ImageColor3", "ImageContent": "@roblox/globaltype/ImageLabel.ImageContent", "ImageRectOffset": "@roblox/globaltype/ImageLabel.ImageRectOffset", "ImageRectSize": "@roblox/globaltype/ImageLabel.ImageRectSize", "ImageTransparency": "@roblox/globaltype/ImageLabel.ImageTransparency", "IsLoaded": "@roblox/globaltype/ImageLabel.IsLoaded", "ResampleMode": "@roblox/globaltype/ImageLabel.ResampleMode", "ScaleType": "@roblox/globaltype/ImageLabel.ScaleType", "SliceCenter": "@roblox/globaltype/ImageLabel.SliceCenter", "SliceScale": "@roblox/globaltype/ImageLabel.SliceScale", "TileSize": "@roblox/globaltype/ImageLabel.TileSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel", "code_sample": "" }, "@roblox/globaltype/ImageLabel.Image": { "documentation": "The image content displayed by the UI element. Reads and writes to ImageContent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#Image", "code_sample": "" }, "@roblox/globaltype/ImageLabel.ImageColor3": { "documentation": "Determines how a rendered image will be colorized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageColor3", "code_sample": "" }, "@roblox/globaltype/ImageLabel.ImageContent": { "documentation": "The image content displayed by the UI element. Supports asset URIs and EditableImage objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageContent", "code_sample": "" }, "@roblox/globaltype/ImageLabel.ImageRectOffset": { "documentation": "The offset in pixels of the sub-area of an image to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageRectOffset", "code_sample": "" }, "@roblox/globaltype/ImageLabel.ImageRectSize": { "documentation": "Determines the size in pixels of the sub-area of an image to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageRectSize", "code_sample": "" }, "@roblox/globaltype/ImageLabel.ImageTransparency": { "documentation": "Determines the transparency of the rendered image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ImageTransparency", "code_sample": "" }, "@roblox/globaltype/ImageLabel.IsLoaded": { "documentation": "Indicates whether the image has finished loading from Roblox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#IsLoaded", "code_sample": "local imageLabel = script.Parent\n\nlocal startTime = workspace.DistributedGameTime\n\n-- Wait for the image to load\nwhile not imageLabel.IsLoaded do\n\ttask.wait()\nend\n\n-- Measure and display how long it took to load\nlocal deltaTime = workspace.DistributedGameTime - startTime\nprint((\"Image loaded in %.3f seconds\"):format(deltaTime))" }, "@roblox/globaltype/ImageLabel.ResampleMode": { "documentation": "Selects the image resampling mode for the label.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ResampleMode", "code_sample": "" }, "@roblox/globaltype/ImageLabel.ScaleType": { "documentation": "Determines how an image will scale if displayed in a UI element whose size differs from the source image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#ScaleType", "code_sample": "" }, "@roblox/globaltype/ImageLabel.SliceCenter": { "documentation": "Sets the slice boundaries of a 9-sliced image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#SliceCenter", "code_sample": "" }, "@roblox/globaltype/ImageLabel.SliceScale": { "documentation": "Scales the 9-slice edges by the specified ratio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#SliceScale", "code_sample": "" }, "@roblox/globaltype/ImageLabel.TileSize": { "documentation": "Sets the tiling size of the ImageLabel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageLabel#TileSize", "code_sample": "" }, "@roblox/globaltype/Workspace": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.", "keys": { "AirDensity": "@roblox/globaltype/Workspace.AirDensity", "AirTurbulenceIntensity": "@roblox/globaltype/Workspace.AirTurbulenceIntensity", "AllowThirdPartySales": "@roblox/globaltype/Workspace.AllowThirdPartySales", "AuthorityMode": "@roblox/globaltype/Workspace.AuthorityMode", "AvatarUnificationMode": "@roblox/globaltype/Workspace.AvatarUnificationMode", "ClientAnimatorThrottling": "@roblox/globaltype/Workspace.ClientAnimatorThrottling", "CurrentCamera": "@roblox/globaltype/Workspace.CurrentCamera", "DistributedGameTime": "@roblox/globaltype/Workspace.DistributedGameTime", "FallenPartsDestroyHeight": "@roblox/globaltype/Workspace.FallenPartsDestroyHeight", "FallHeightEnabled": "@roblox/globaltype/Workspace.FallHeightEnabled", "FilteringEnabled": "@roblox/globaltype/Workspace.FilteringEnabled", "FluidForces": "@roblox/globaltype/Workspace.FluidForces", "GlobalWind": "@roblox/globaltype/Workspace.GlobalWind", "Gravity": "@roblox/globaltype/Workspace.Gravity", "IKControlConstraintSupport": "@roblox/globaltype/Workspace.IKControlConstraintSupport", "InsertPoint": "@roblox/globaltype/Workspace.InsertPoint", "InterpolationThrottling": "@roblox/globaltype/Workspace.InterpolationThrottling", "LuauTypeCheckMode": "@roblox/globaltype/Workspace.LuauTypeCheckMode", "MeshPartHeadsAndAccessories": "@roblox/globaltype/Workspace.MeshPartHeadsAndAccessories", "ModelStreamingBehavior": "@roblox/globaltype/Workspace.ModelStreamingBehavior", "MoverConstraintRootBehavior": "@roblox/globaltype/Workspace.MoverConstraintRootBehavior", "NextGenerationReplication": "@roblox/globaltype/Workspace.NextGenerationReplication", "PathfindingUseImprovedSearch": "@roblox/globaltype/Workspace.PathfindingUseImprovedSearch", "PhysicsImprovedSleep": "@roblox/globaltype/Workspace.PhysicsImprovedSleep", "PhysicsSteppingMethod": "@roblox/globaltype/Workspace.PhysicsSteppingMethod", "PlayerCharacterDestroyBehavior": "@roblox/globaltype/Workspace.PlayerCharacterDestroyBehavior", "PlayerScriptsUseInputActionSystem": "@roblox/globaltype/Workspace.PlayerScriptsUseInputActionSystem", "PrimalPhysicsSolver": "@roblox/globaltype/Workspace.PrimalPhysicsSolver", "RejectCharacterDeletions": "@roblox/globaltype/Workspace.RejectCharacterDeletions", "RenderingCacheOptimizations": "@roblox/globaltype/Workspace.RenderingCacheOptimizations", "ReplicateInstanceDestroySetting": "@roblox/globaltype/Workspace.ReplicateInstanceDestroySetting", "Retargeting": "@roblox/globaltype/Workspace.Retargeting", "SandboxedInstanceMode": "@roblox/globaltype/Workspace.SandboxedInstanceMode", "SignalBehavior": "@roblox/globaltype/Workspace.SignalBehavior", "StreamingEnabled": "@roblox/globaltype/Workspace.StreamingEnabled", "StreamingIntegrityMode": "@roblox/globaltype/Workspace.StreamingIntegrityMode", "StreamingMinRadius": "@roblox/globaltype/Workspace.StreamingMinRadius", "StreamingTargetRadius": "@roblox/globaltype/Workspace.StreamingTargetRadius", "StreamOutBehavior": "@roblox/globaltype/Workspace.StreamOutBehavior", "Terrain": "@roblox/globaltype/Workspace.Terrain", "TouchesUseCollisionGroups": "@roblox/globaltype/Workspace.TouchesUseCollisionGroups", "TouchEventsUseCollisionGroups": "@roblox/globaltype/Workspace.TouchEventsUseCollisionGroups", "UseFixedSimulation": "@roblox/globaltype/Workspace.UseFixedSimulation", "UseNewLuauTypeSolver": "@roblox/globaltype/Workspace.UseNewLuauTypeSolver", "BreakJoints": "@roblox/globaltype/Workspace.BreakJoints", "GetNumAwakeParts": "@roblox/globaltype/Workspace.GetNumAwakeParts", "GetPhysicsThrottling": "@roblox/globaltype/Workspace.GetPhysicsThrottling", "GetRealPhysicsFPS": "@roblox/globaltype/Workspace.GetRealPhysicsFPS", "GetServerTimeNow": "@roblox/globaltype/Workspace.GetServerTimeNow", "JoinToOutsiders": "@roblox/globaltype/Workspace.JoinToOutsiders", "MakeJoints": "@roblox/globaltype/Workspace.MakeJoints", "PGSIsEnabled": "@roblox/globaltype/Workspace.PGSIsEnabled", "UnjoinFromOutsiders": "@roblox/globaltype/Workspace.UnjoinFromOutsiders", "ZoomToExtents": "@roblox/globaltype/Workspace.ZoomToExtents" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace", "code_sample": "" }, "@roblox/globaltype/Workspace.AirDensity": { "documentation": "The air density at ground level, used in the aerodynamic force model.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#AirDensity", "code_sample": "" }, "@roblox/globaltype/Workspace.AirTurbulenceIntensity": { "documentation": "Controls the strength of turbulence present in the wind velocity field, affecting the aerodynamic force model.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#AirTurbulenceIntensity", "code_sample": "" }, "@roblox/globaltype/Workspace.AllowThirdPartySales": { "documentation": "Determines whether assets created by other users can be sold in the game.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#AllowThirdPartySales", "code_sample": "" }, "@roblox/globaltype/Workspace.AuthorityMode": { "documentation": "Sets the server authority mode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#AuthorityMode", "code_sample": "" }, "@roblox/globaltype/Workspace.AvatarUnificationMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#AvatarUnificationMode", "code_sample": "" }, "@roblox/globaltype/Workspace.ClientAnimatorThrottling": { "documentation": "Specifies the animation throttling mode for the local client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#ClientAnimatorThrottling", "code_sample": "" }, "@roblox/globaltype/Workspace.CurrentCamera": { "documentation": "The Camera object being used by the local player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#CurrentCamera", "code_sample": "" }, "@roblox/globaltype/Workspace.DistributedGameTime": { "documentation": "The amount of time, in seconds, that the game has been running.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#DistributedGameTime", "code_sample": "" }, "@roblox/globaltype/Workspace.FallenPartsDestroyHeight": { "documentation": "Determines the height at which falling BaseParts and their ancestor Models are removed from Workspace.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#FallenPartsDestroyHeight", "code_sample": "" }, "@roblox/globaltype/Workspace.FallHeightEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#FallHeightEnabled", "code_sample": "" }, "@roblox/globaltype/Workspace.FilteringEnabled": { "documentation": "Deprecated:
Determines whether changes made from the client will replicate to the server or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#FilteringEnabled", "code_sample": "" }, "@roblox/globaltype/Workspace.FluidForces": { "documentation": "Determines whether the physics engine computes aerodynamic forces on BaseParts whose EnableFluidForces property is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#FluidForces", "code_sample": "" }, "@roblox/globaltype/Workspace.GlobalWind": { "documentation": "Specifies the global wind vector for animated terrain grass, dynamic clouds, and particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#GlobalWind", "code_sample": "" }, "@roblox/globaltype/Workspace.Gravity": { "documentation": "Determines the acceleration due to gravity applied to falling BaseParts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#Gravity", "code_sample": "" }, "@roblox/globaltype/Workspace.IKControlConstraintSupport": { "documentation": "Enables support for constraints for IKControls. If disabled, IKControls ignore physics constraints.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#IKControlConstraintSupport", "code_sample": "" }, "@roblox/globaltype/Workspace.InsertPoint": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#InsertPoint", "code_sample": "" }, "@roblox/globaltype/Workspace.InterpolationThrottling": { "documentation": "Deprecated: This property should not be used for new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#InterpolationThrottling", "code_sample": "" }, "@roblox/globaltype/Workspace.LuauTypeCheckMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#LuauTypeCheckMode", "code_sample": "" }, "@roblox/globaltype/Workspace.MeshPartHeadsAndAccessories": { "documentation": "Sets whether character Heads and Accessories should be downloaded as MeshParts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#MeshPartHeadsAndAccessories", "code_sample": "" }, "@roblox/globaltype/Workspace.ModelStreamingBehavior": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#ModelStreamingBehavior", "code_sample": "" }, "@roblox/globaltype/Workspace.MoverConstraintRootBehavior": { "documentation": "Controls the logic used to select the assembly root part when using any of the mover constraints.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#MoverConstraintRootBehavior", "code_sample": "" }, "@roblox/globaltype/Workspace.NextGenerationReplication": { "documentation": "When true, enables an alternate replication system that alters and improves how properties are replicated under the hood.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#NextGenerationReplication", "code_sample": "" }, "@roblox/globaltype/Workspace.PathfindingUseImprovedSearch": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PathfindingUseImprovedSearch", "code_sample": "" }, "@roblox/globaltype/Workspace.PhysicsImprovedSleep": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PhysicsImprovedSleep", "code_sample": "" }, "@roblox/globaltype/Workspace.PhysicsSteppingMethod": { "documentation": "Sets how the solver will advance the physics simulation forward in time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PhysicsSteppingMethod", "code_sample": "" }, "@roblox/globaltype/Workspace.PlayerCharacterDestroyBehavior": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PlayerCharacterDestroyBehavior", "code_sample": "" }, "@roblox/globaltype/Workspace.PlayerScriptsUseInputActionSystem": { "documentation": "Controls internal behavior of the built-in Player scripts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PlayerScriptsUseInputActionSystem", "code_sample": "" }, "@roblox/globaltype/Workspace.PrimalPhysicsSolver": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PrimalPhysicsSolver", "code_sample": "" }, "@roblox/globaltype/Workspace.RejectCharacterDeletions": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#RejectCharacterDeletions", "code_sample": "" }, "@roblox/globaltype/Workspace.RenderingCacheOptimizations": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#RenderingCacheOptimizations", "code_sample": "" }, "@roblox/globaltype/Workspace.ReplicateInstanceDestroySetting": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#ReplicateInstanceDestroySetting", "code_sample": "" }, "@roblox/globaltype/Workspace.Retargeting": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#Retargeting", "code_sample": "" }, "@roblox/globaltype/Workspace.SandboxedInstanceMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#SandboxedInstanceMode", "code_sample": "" }, "@roblox/globaltype/Workspace.SignalBehavior": { "documentation": "Configures when the engine resumes event handlers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#SignalBehavior", "code_sample": "" }, "@roblox/globaltype/Workspace.StreamingEnabled": { "documentation": "Whether content streaming is enabled for the place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamingEnabled", "code_sample": "" }, "@roblox/globaltype/Workspace.StreamingIntegrityMode": { "documentation": "Determines whether StreamingIntegrityMode is active.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamingIntegrityMode", "code_sample": "" }, "@roblox/globaltype/Workspace.StreamingMinRadius": { "documentation": "Minimum distance that content will be streamed to players with high priority.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamingMinRadius", "code_sample": "" }, "@roblox/globaltype/Workspace.StreamingTargetRadius": { "documentation": "Maximum distance that content will be streamed to players.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamingTargetRadius", "code_sample": "" }, "@roblox/globaltype/Workspace.StreamOutBehavior": { "documentation": "Configures how the engine decides when to Stream content away from players.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamOutBehavior", "code_sample": "" }, "@roblox/globaltype/Workspace.Terrain": { "documentation": "A reference to the Terrain object parented to the Workspace.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#Terrain", "code_sample": "" }, "@roblox/globaltype/Workspace.TouchesUseCollisionGroups": { "documentation": "Determines whether parts in different groups set to not collide will ignore collisions and touch events.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#TouchesUseCollisionGroups", "code_sample": "" }, "@roblox/globaltype/Workspace.TouchEventsUseCollisionGroups": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#TouchEventsUseCollisionGroups", "code_sample": "" }, "@roblox/globaltype/Workspace.UseFixedSimulation": { "documentation": "When true, enables RunService:BindToSimulation() which calls a function at a fixed frequency, updates physics stepping logic, and makes the time() function return the fixed stepped frame time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#UseFixedSimulation", "code_sample": "" }, "@roblox/globaltype/Workspace.UseNewLuauTypeSolver": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#UseNewLuauTypeSolver", "code_sample": "" }, "@roblox/globaltype/Workspace.BreakJoints/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.BreakJoints/param/1": { "documentation": "An array of BaseParts for whom joints are to be broken." }, "@roblox/globaltype/Workspace.BreakJoints": { "documentation": "Deprecated:
Goes through all BaseParts given, breaking any joints connected to these parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.BreakJoints/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Workspace.BreakJoints/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#BreakJoints", "code_sample": "" }, "@roblox/globaltype/Workspace.GetNumAwakeParts/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.GetNumAwakeParts/return/0": { "documentation": "The number of awake parts." }, "@roblox/globaltype/Workspace.GetNumAwakeParts": { "documentation": "Returns the number of BaseParts that are deemed physically active, due to being recently under the influence of physics.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.GetNumAwakeParts/param/0" } ], "returns": [ "@roblox/globaltype/Workspace.GetNumAwakeParts/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#GetNumAwakeParts", "code_sample": "" }, "@roblox/globaltype/Workspace.GetPhysicsThrottling/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.GetPhysicsThrottling/return/0": { "documentation": "The percentage of real time that physics simulation is currently being throttled to." }, "@roblox/globaltype/Workspace.GetPhysicsThrottling": { "documentation": "Returns an integer, between 0 and 100, representing the percentage of real time that physics simulation is currently being throttled to.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.GetPhysicsThrottling/param/0" } ], "returns": [ "@roblox/globaltype/Workspace.GetPhysicsThrottling/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#GetPhysicsThrottling", "code_sample": "" }, "@roblox/globaltype/Workspace.GetRealPhysicsFPS/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.GetRealPhysicsFPS/return/0": { "documentation": "Returns the number of frames per second that physics is currently being simulated at." }, "@roblox/globaltype/Workspace.GetRealPhysicsFPS": { "documentation": "Returns the number of frames per second that physics is currently being simulated at.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.GetRealPhysicsFPS/param/0" } ], "returns": [ "@roblox/globaltype/Workspace.GetRealPhysicsFPS/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#GetRealPhysicsFPS", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nwhile task.wait(1) do\n\tif workspace:GetRealPhysicsFPS() > 65 then\n\t\tplayer:Kick()\n\tend\nend" }, "@roblox/globaltype/Workspace.GetServerTimeNow/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.GetServerTimeNow/return/0": { "documentation": "The estimated Unix timestamp on the server." }, "@roblox/globaltype/Workspace.GetServerTimeNow": { "documentation": "Returns the server's Unix time in seconds.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.GetServerTimeNow/param/0" } ], "returns": [ "@roblox/globaltype/Workspace.GetServerTimeNow/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#GetServerTimeNow", "code_sample": "" }, "@roblox/globaltype/Workspace.JoinToOutsiders/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.JoinToOutsiders/param/1": { "documentation": "An array of BaseParts for whom joints are to be made." }, "@roblox/globaltype/Workspace.JoinToOutsiders/param/2": { "documentation": "The JointCreationMode to be used. Passing in Enum.JointCreationMode.All or Enum.JointCreationMode.Surface has the same behavior which equates to Join Always." }, "@roblox/globaltype/Workspace.JoinToOutsiders": { "documentation": "Creates joints between the specified Parts and any touching parts depending on the parts' surfaces and the specified joint creation mode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.JoinToOutsiders/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Workspace.JoinToOutsiders/param/1" }, { "name": "jointType", "documentation": "@roblox/globaltype/Workspace.JoinToOutsiders/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#JoinToOutsiders", "code_sample": "" }, "@roblox/globaltype/Workspace.MakeJoints/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.MakeJoints/param/1": { "documentation": "An array of parts for whom joints are to be made." }, "@roblox/globaltype/Workspace.MakeJoints": { "documentation": "Deprecated:
Goes through all BaseParts given. If any part's side has a SurfaceType that can make a joint it will create a joint with any adjacent parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.MakeJoints/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Workspace.MakeJoints/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#MakeJoints", "code_sample": "" }, "@roblox/globaltype/Workspace.PGSIsEnabled/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.PGSIsEnabled/return/0": { "documentation": "True if the PGS solver is enabled." }, "@roblox/globaltype/Workspace.PGSIsEnabled": { "documentation": "Returns true if the game has the PGS Physics solver enabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.PGSIsEnabled/param/0" } ], "returns": [ "@roblox/globaltype/Workspace.PGSIsEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PGSIsEnabled", "code_sample": "" }, "@roblox/globaltype/Workspace.UnjoinFromOutsiders/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.UnjoinFromOutsiders/param/1": { "documentation": "An array of BaseParts for whom joints are to be broken." }, "@roblox/globaltype/Workspace.UnjoinFromOutsiders": { "documentation": "Breaks all joints between the specified BaseParts and other BaseParts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.UnjoinFromOutsiders/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Workspace.UnjoinFromOutsiders/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#UnjoinFromOutsiders", "code_sample": "" }, "@roblox/globaltype/Workspace.ZoomToExtents/param/0": { "documentation": "Workspace houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world." }, "@roblox/globaltype/Workspace.ZoomToExtents": { "documentation": "Positions and zooms the Workspace.CurrentCamera to show the extent of BaseParts currently in the Workspace.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.ZoomToExtents/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#ZoomToExtents", "code_sample": "" }, "@roblox/globaltype/Workspace.PersistentLoaded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Workspace.PersistentLoaded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Workspace.PersistentLoaded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Workspace.PersistentLoaded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Workspace.PersistentLoaded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Workspace.PersistentLoaded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Workspace.PersistentLoaded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Workspace.PersistentLoaded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Workspace.PersistentLoaded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Workspace.PersistentLoaded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Workspace.PersistentLoaded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Workspace.PersistentLoaded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Workspace.PersistentLoaded": { "documentation": "Fires when persistent models have been sent to the specified player.", "keys": { "Connect": "@roblox/globaltype/Workspace.PersistentLoaded.Connect", "ConnectParallel": "@roblox/globaltype/Workspace.PersistentLoaded.ConnectParallel", "Once": "@roblox/globaltype/Workspace.PersistentLoaded.Once", "Wait": "@roblox/globaltype/Workspace.PersistentLoaded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Workspace#PersistentLoaded", "code_sample": "" }, "@roblox/globaltype/BrowserService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BrowserService", "code_sample": "" }, "@roblox/globaltype/HapticService": { "documentation": "Provides haptic feedback to controllers and devices.", "keys": { "GetMotor": "@roblox/globaltype/HapticService.GetMotor", "IsMotorSupported": "@roblox/globaltype/HapticService.IsMotorSupported", "IsVibrationSupported": "@roblox/globaltype/HapticService.IsVibrationSupported", "SetMotor": "@roblox/globaltype/HapticService.SetMotor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticService", "code_sample": "" }, "@roblox/globaltype/HapticService.GetMotor/param/0": { "documentation": "Provides haptic feedback to controllers and devices." }, "@roblox/globaltype/HapticService.GetMotor/param/1": { "documentation": "The specified UserInputType." }, "@roblox/globaltype/HapticService.GetMotor/param/2": { "documentation": "The specified VibrationMotor." }, "@roblox/globaltype/HapticService.GetMotor/return/0": { "documentation": "The current vibration value set to the specified UserInputType and VibrationMotor or nil if SetMotor() has not been called prior." }, "@roblox/globaltype/HapticService.GetMotor": { "documentation": "Returns the current vibration value set to the specified UserInputType and VibrationMotor.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticService.GetMotor/param/0" }, { "name": "inputType", "documentation": "@roblox/globaltype/HapticService.GetMotor/param/1" }, { "name": "vibrationMotor", "documentation": "@roblox/globaltype/HapticService.GetMotor/param/2" } ], "returns": [ "@roblox/globaltype/HapticService.GetMotor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticService#GetMotor", "code_sample": "" }, "@roblox/globaltype/HapticService.IsMotorSupported/param/0": { "documentation": "Provides haptic feedback to controllers and devices." }, "@roblox/globaltype/HapticService.IsMotorSupported/param/1": { "documentation": "The specific UserInputType being checked for VibrationMotor support." }, "@roblox/globaltype/HapticService.IsMotorSupported/param/2": { "documentation": "The specified VibrationMotor checked to see if it supports the specified UserInputType." }, "@roblox/globaltype/HapticService.IsMotorSupported/return/0": { "documentation": "Boolean of true if the specified motor is available to be used with the specified UserInputType, false if not." }, "@roblox/globaltype/HapticService.IsMotorSupported": { "documentation": "Returns true if the specified motor is available to be used with the specified UserInputType.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticService.IsMotorSupported/param/0" }, { "name": "inputType", "documentation": "@roblox/globaltype/HapticService.IsMotorSupported/param/1" }, { "name": "vibrationMotor", "documentation": "@roblox/globaltype/HapticService.IsMotorSupported/param/2" } ], "returns": [ "@roblox/globaltype/HapticService.IsMotorSupported/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticService#IsMotorSupported", "code_sample": "" }, "@roblox/globaltype/HapticService.IsVibrationSupported/param/0": { "documentation": "Provides haptic feedback to controllers and devices." }, "@roblox/globaltype/HapticService.IsVibrationSupported/param/1": { "documentation": "The specified UserInputType checked to see if it supports haptic feedback." }, "@roblox/globaltype/HapticService.IsVibrationSupported/return/0": { "documentation": "Boolean of true if the specified UserInputType supports haptic feedback." }, "@roblox/globaltype/HapticService.IsVibrationSupported": { "documentation": "Returns true if the specified UserInputType supports haptic feedback.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticService.IsVibrationSupported/param/0" }, { "name": "inputType", "documentation": "@roblox/globaltype/HapticService.IsVibrationSupported/param/1" } ], "returns": [ "@roblox/globaltype/HapticService.IsVibrationSupported/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticService#IsVibrationSupported", "code_sample": "" }, "@roblox/globaltype/HapticService.SetMotor/param/0": { "documentation": "Provides haptic feedback to controllers and devices." }, "@roblox/globaltype/HapticService.SetMotor/param/1": { "documentation": "The specified UserInputType." }, "@roblox/globaltype/HapticService.SetMotor/param/2": { "documentation": "The specified VibrationMotor." }, "@roblox/globaltype/HapticService.SetMotor/param/3": { "documentation": "How intensely the motor should vibrate. Only uses the first value in the tuple, which should be a number." }, "@roblox/globaltype/HapticService.SetMotor": { "documentation": "Sets the vibration intensity of the specified UserInputType and VibrationMotor.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticService.SetMotor/param/0" }, { "name": "inputType", "documentation": "@roblox/globaltype/HapticService.SetMotor/param/1" }, { "name": "vibrationMotor", "documentation": "@roblox/globaltype/HapticService.SetMotor/param/2" }, { "name": "vibrationValues", "documentation": "@roblox/globaltype/HapticService.SetMotor/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticService#SetMotor", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\nlocal HapticService = game:GetService(\"HapticService\")\n\nlocal cachedInputs = {}\n\nlocal keyToVibration = {\n\t[Enum.KeyCode.ButtonL2] = Enum.VibrationMotor.Small,\n\t[Enum.KeyCode.ButtonR2] = Enum.VibrationMotor.Large,\n}\n\nlocal function onInputChanged(property)\n\tif property == \"Position\" then\n\t\tHapticService:SetMotor(inputType, vibrationMotor, input.Position.Z)\n\tend\nend\n\nlocal function onInputBegan(input)\n\tif not cachedInputs[input] then\n\t\tlocal inputType = input.UserInputType\n\t\tif inputType.Name:find(\"Gamepad\") then\n\t\t\tlocal vibrationMotor = keyToVibration[input.KeyCode]\n\t\t\tif vibrationMotor then\n\t\t\t\t-- Watch this input manually to accurately update the vibration motor\n\t\t\t\tcachedInputs[input] = input.Changed:Connect(onInputChanged)\n\t\t\tend\n\t\tend\n\tend\nend\n\nUserInputService.InputBegan:Connect(onInputBegan)" }, "@roblox/globaltype/InputContext": { "documentation": "Collection of actions which holds related actions and defines how they interact with other contexts/actions.", "keys": { "Enabled": "@roblox/globaltype/InputContext.Enabled", "Priority": "@roblox/globaltype/InputContext.Priority", "Sink": "@roblox/globaltype/InputContext.Sink" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputContext", "code_sample": "" }, "@roblox/globaltype/InputContext.Enabled": { "documentation": "Determines if this InputContext is enabled or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputContext#Enabled", "code_sample": "" }, "@roblox/globaltype/InputContext.Priority": { "documentation": "The priority level at which the context should be run.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputContext#Priority", "code_sample": "" }, "@roblox/globaltype/InputContext.Sink": { "documentation": "Determines whether input bindings of lower priority will be processed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputContext#Sink", "code_sample": "" }, "@roblox/globaltype/AudioDeviceOutput": { "documentation": "Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.", "keys": { "Player": "@roblox/globaltype/AudioDeviceOutput.Player", "GetConnectedWires": "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioDeviceOutput.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioDeviceOutput.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput", "code_sample": "local audioPlayer: AudioPlayer = Instance.new(\"AudioPlayer\")\naudioPlayer.Parent = workspace\naudioPlayer.AssetId = \"rbxassetid://9112854440\"\n\nlocal deviceOutput = Instance.new(\"AudioDeviceOutput\")\ndeviceOutput.Parent = workspace\n\nlocal wire = Instance.new(\"Wire\")\nwire.Parent = workspace\n\nwire.SourceInstance = audioPlayer\nwire.TargetInstance = deviceOutput\n\naudioPlayer:Play()" }, "@roblox/globaltype/AudioDeviceOutput.Player": { "documentation": "A Player who is intended to hear the connected audio streams.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#Player", "code_sample": "" }, "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires/param/0": { "documentation": "Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones." }, "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioDeviceOutput.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioDeviceOutput.GetInputPins/param/0": { "documentation": "Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones." }, "@roblox/globaltype/AudioDeviceOutput.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioDeviceOutput.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioDeviceOutput.GetOutputPins/param/0": { "documentation": "Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones." }, "@roblox/globaltype/AudioDeviceOutput.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioDeviceOutput.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceOutput.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioDeviceOutput via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioDeviceOutput.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#WiringChanged", "code_sample": "" }, "@roblox/globaltype/PathfindingModifier": { "documentation": "Modifiers used to represent space that has a higher or lower cost to be traversed when creating paths using the PathfindingService.", "keys": { "Label": "@roblox/globaltype/PathfindingModifier.Label", "PassThrough": "@roblox/globaltype/PathfindingModifier.PassThrough" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier", "code_sample": "" }, "@roblox/globaltype/PathfindingModifier.Label": { "documentation": "The name of the navigation area inside or on top of the Part volume.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier#Label", "code_sample": "" }, "@roblox/globaltype/PathfindingModifier.PassThrough": { "documentation": "Determines if the parts enclosed by the modifier are traversable, even if they would normally be collided with.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingModifier#PassThrough", "code_sample": "" }, "@roblox/globaltype/NegateOperation": { "documentation": "Result of a part that has been negated for use in solid modeling.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NegateOperation", "code_sample": "" }, "@roblox/globaltype/Plane": { "documentation": "Deprecated:
Constrains Attachment0 and Attachment1 such that both points lie in a plane with origin at Attachment0's position and unit normal vector equal to Attachment0's primary axis.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plane", "code_sample": "" }, "@roblox/globaltype/StarterGui": { "documentation": "A container for LayerCollector objects to be copied into the PlayerGui of Players. Also provides a range of functions for interacting with the CoreGui.", "keys": { "ProcessUserInput": "@roblox/globaltype/StarterGui.ProcessUserInput", "ResetPlayerGuiOnSpawn": "@roblox/globaltype/StarterGui.ResetPlayerGuiOnSpawn", "RtlTextSupport": "@roblox/globaltype/StarterGui.RtlTextSupport", "ScreenOrientation": "@roblox/globaltype/StarterGui.ScreenOrientation", "ShowDevelopmentGui": "@roblox/globaltype/StarterGui.ShowDevelopmentGui", "VirtualCursorMode": "@roblox/globaltype/StarterGui.VirtualCursorMode", "GetCore": "@roblox/globaltype/StarterGui.GetCore", "GetCoreGuiEnabled": "@roblox/globaltype/StarterGui.GetCoreGuiEnabled", "SetCore": "@roblox/globaltype/StarterGui.SetCore", "SetCoreGuiEnabled": "@roblox/globaltype/StarterGui.SetCoreGuiEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui", "code_sample": "" }, "@roblox/globaltype/StarterGui.ProcessUserInput": { "documentation": "Allows this service to process input like PlayerGui and CoreGui do.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#ProcessUserInput", "code_sample": "" }, "@roblox/globaltype/StarterGui.ResetPlayerGuiOnSpawn": { "documentation": "Deprecated: This property is deprecated. Use LayerCollector.ResetOnSpawn to control the resetting behavior for individual LayerCollector objects.
Determines whether each child parented to the StarterGui will be cloned into a player's PlayerGui when that player's character is respawned.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#ResetPlayerGuiOnSpawn", "code_sample": "" }, "@roblox/globaltype/StarterGui.RtlTextSupport": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#RtlTextSupport", "code_sample": "" }, "@roblox/globaltype/StarterGui.ScreenOrientation": { "documentation": "Sets the default screen orientation mode for users with mobile devices.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#ScreenOrientation", "code_sample": "" }, "@roblox/globaltype/StarterGui.ShowDevelopmentGui": { "documentation": "Determines whether the contents of StarterGui is visible in Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#ShowDevelopmentGui", "code_sample": "" }, "@roblox/globaltype/StarterGui.VirtualCursorMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#VirtualCursorMode", "code_sample": "" }, "@roblox/globaltype/StarterGui.GetCore/param/0": { "documentation": "A container for LayerCollector objects to be copied into the PlayerGui of Players. Also provides a range of functions for interacting with the CoreGui." }, "@roblox/globaltype/StarterGui.GetCore/param/1": { "documentation": "" }, "@roblox/globaltype/StarterGui.GetCore/return/0": { "documentation": "" }, "@roblox/globaltype/StarterGui.GetCore": { "documentation": "Returns a variable that has been specified by a Roblox core script.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StarterGui.GetCore/param/0" }, { "name": "parameterName", "documentation": "@roblox/globaltype/StarterGui.GetCore/param/1" } ], "returns": [ "@roblox/globaltype/StarterGui.GetCore/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#GetCore", "code_sample": "" }, "@roblox/globaltype/StarterGui.GetCoreGuiEnabled/param/0": { "documentation": "A container for LayerCollector objects to be copied into the PlayerGui of Players. Also provides a range of functions for interacting with the CoreGui." }, "@roblox/globaltype/StarterGui.GetCoreGuiEnabled/param/1": { "documentation": "The given CoreGuiType." }, "@roblox/globaltype/StarterGui.GetCoreGuiEnabled/return/0": { "documentation": "Whether the given CoreGuiType is enabled." }, "@roblox/globaltype/StarterGui.GetCoreGuiEnabled": { "documentation": "Returns whether the given CoreGuiTypeis enabled, or if it has been disabled using StarterGui:SetCoreGuiEnabled().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StarterGui.GetCoreGuiEnabled/param/0" }, { "name": "coreGuiType", "documentation": "@roblox/globaltype/StarterGui.GetCoreGuiEnabled/param/1" } ], "returns": [ "@roblox/globaltype/StarterGui.GetCoreGuiEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#GetCoreGuiEnabled", "code_sample": "local StarterGui = game:GetService(\"StarterGui\")\n\nprint(StarterGui:GetCoreGuiEnabled(\"PlayerList\"))" }, "@roblox/globaltype/StarterGui.SetCore/param/0": { "documentation": "A container for LayerCollector objects to be copied into the PlayerGui of Players. Also provides a range of functions for interacting with the CoreGui." }, "@roblox/globaltype/StarterGui.SetCore/param/1": { "documentation": "Selects the functionality with which the call will interact." }, "@roblox/globaltype/StarterGui.SetCore/param/2": { "documentation": "A table of BindableEvents and BindableFunctions." }, "@roblox/globaltype/StarterGui.SetCore": { "documentation": "Allows you to perform certain interactions with Roblox's core scripts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StarterGui.SetCore/param/0" }, { "name": "parameterName", "documentation": "@roblox/globaltype/StarterGui.SetCore/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/StarterGui.SetCore/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#SetCore", "code_sample": "local StarterGui = game:GetService(\"StarterGui\")\n\nStarterGui:SetCore(\"AvatarContextMenuTheme\", {\n\tBackgroundImage = \"\",\n\tBackgroundTransparency = 0.5,\n\tBackgroundColor = Color3.fromRGB(111, 145, 242),\n\tNameTagColor = Color3.fromRGB(0, 0, 200),\n\tNameUnderlineColor = Color3.fromRGB(213, 233, 255),\n\tButtonFrameColor = Color3.fromRGB(15, 24, 65),\n\tButtonFrameTransparency = 0.2,\n\tButtonUnderlineColor = Color3.fromRGB(213, 233, 255),\n\tFont = Enum.Font.SciFi,\n})" }, "@roblox/globaltype/StarterGui.SetCoreGuiEnabled/param/0": { "documentation": "A container for LayerCollector objects to be copied into the PlayerGui of Players. Also provides a range of functions for interacting with the CoreGui." }, "@roblox/globaltype/StarterGui.SetCoreGuiEnabled/param/1": { "documentation": "The given CoreGuiType." }, "@roblox/globaltype/StarterGui.SetCoreGuiEnabled/param/2": { "documentation": "Whether to enable or disable the given CoreGuiType." }, "@roblox/globaltype/StarterGui.SetCoreGuiEnabled": { "documentation": "Sets whether the CoreGui element associated with the given CoreGuiType is enabled or disabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StarterGui.SetCoreGuiEnabled/param/0" }, { "name": "coreGuiType", "documentation": "@roblox/globaltype/StarterGui.SetCoreGuiEnabled/param/1" }, { "name": "enabled", "documentation": "@roblox/globaltype/StarterGui.SetCoreGuiEnabled/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGui#SetCoreGuiEnabled", "code_sample": "" }, "@roblox/globaltype/WrapDeformer": { "documentation": "Allows for the real-time deformation of a MeshPart.", "keys": { "CreateEditableMeshAsync": "@roblox/globaltype/WrapDeformer.CreateEditableMeshAsync", "GetDeformedCFrameAsync": "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync", "SetCageMeshContent": "@roblox/globaltype/WrapDeformer.SetCageMeshContent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapDeformer", "code_sample": "" }, "@roblox/globaltype/WrapDeformer.CreateEditableMeshAsync/param/0": { "documentation": "Allows for the real-time deformation of a MeshPart." }, "@roblox/globaltype/WrapDeformer.CreateEditableMeshAsync/return/0": { "documentation": "" }, "@roblox/globaltype/WrapDeformer.CreateEditableMeshAsync": { "documentation": "Returns an EditableMesh (currently unskinned) equivalent to the deformed parent mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WrapDeformer.CreateEditableMeshAsync/param/0" } ], "returns": [ "@roblox/globaltype/WrapDeformer.CreateEditableMeshAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapDeformer#CreateEditableMeshAsync", "code_sample": "" }, "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync/param/0": { "documentation": "Allows for the real-time deformation of a MeshPart." }, "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync/param/1": { "documentation": "" }, "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync/return/0": { "documentation": "" }, "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync": { "documentation": "Returns a CFrame deformed comparably to the MeshPart.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync/param/0" }, { "name": "originalCFrame", "documentation": "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync/param/1" } ], "returns": [ "@roblox/globaltype/WrapDeformer.GetDeformedCFrameAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapDeformer#GetDeformedCFrameAsync", "code_sample": "" }, "@roblox/globaltype/WrapDeformer.SetCageMeshContent/param/0": { "documentation": "Allows for the real-time deformation of a MeshPart." }, "@roblox/globaltype/WrapDeformer.SetCageMeshContent/param/1": { "documentation": "" }, "@roblox/globaltype/WrapDeformer.SetCageMeshContent/param/2": { "documentation": "" }, "@roblox/globaltype/WrapDeformer.SetCageMeshContent": { "documentation": "Sets the cage mesh used to deform against a sibling WrapTarget cage mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WrapDeformer.SetCageMeshContent/param/0" }, { "name": "content", "documentation": "@roblox/globaltype/WrapDeformer.SetCageMeshContent/param/1" }, { "name": "cageOrigin", "documentation": "@roblox/globaltype/WrapDeformer.SetCageMeshContent/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapDeformer#SetCageMeshContent", "code_sample": "" }, "@roblox/globaltype/SurfaceSelection": { "documentation": "Highlights a face of a surface in a configurable color.", "keys": { "TargetSurface": "@roblox/globaltype/SurfaceSelection.TargetSurface" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceSelection", "code_sample": "" }, "@roblox/globaltype/SurfaceSelection.TargetSurface": { "documentation": "Sets which side the SurfaceSelection will appear on, on the adorned BasePart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceSelection#TargetSurface", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataCallbacks": { "documentation": "Acts as a Folder containing information about callbacks for a ReflectionMetadataClass, and should be parented to it. ReflectionMetadataMembers that are parented to this object will be perceived as callbacks under the class this is parented to.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataCallbacks", "code_sample": "" }, "@roblox/globaltype/RemoteFunction": { "documentation": "An object which facilitates synchronous, two-way communication across the client-server boundary. Scripts invoking a RemoteFunction yield until they receive a response from the recipient.", "keys": { "InvokeClient": "@roblox/globaltype/RemoteFunction.InvokeClient", "InvokeServer": "@roblox/globaltype/RemoteFunction.InvokeServer", "OnClientInvoke": "@roblox/globaltype/RemoteFunction.OnClientInvoke", "OnServerInvoke": "@roblox/globaltype/RemoteFunction.OnServerInvoke" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteFunction", "code_sample": "" }, "@roblox/globaltype/RemoteFunction.InvokeClient/param/0": { "documentation": "An object which facilitates synchronous, two-way communication across the client-server boundary. Scripts invoking a RemoteFunction yield until they receive a response from the recipient." }, "@roblox/globaltype/RemoteFunction.InvokeClient/param/1": { "documentation": "The Player associated with the client to invoke." }, "@roblox/globaltype/RemoteFunction.InvokeClient/param/2": { "documentation": "Values to pass to the OnClientInvoke callback." }, "@roblox/globaltype/RemoteFunction.InvokeClient/return/0": { "documentation": "Values returned from the OnClientInvoke callback." }, "@roblox/globaltype/RemoteFunction.InvokeClient": { "documentation": "Invokes the RemoteFunction which in turn calls the OnClientInvoke callback.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteFunction.InvokeClient/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/RemoteFunction.InvokeClient/param/1" }, { "name": "arguments", "documentation": "@roblox/globaltype/RemoteFunction.InvokeClient/param/2" } ], "returns": [ "@roblox/globaltype/RemoteFunction.InvokeClient/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#InvokeClient", "code_sample": "" }, "@roblox/globaltype/RemoteFunction.InvokeServer/param/0": { "documentation": "An object which facilitates synchronous, two-way communication across the client-server boundary. Scripts invoking a RemoteFunction yield until they receive a response from the recipient." }, "@roblox/globaltype/RemoteFunction.InvokeServer/param/1": { "documentation": "Values to pass to the OnServerInvoke callback." }, "@roblox/globaltype/RemoteFunction.InvokeServer/return/0": { "documentation": "Values returned from the OnServerInvoke callback." }, "@roblox/globaltype/RemoteFunction.InvokeServer": { "documentation": "Invokes the RemoteFunction which in turn calls the OnServerInvoke callback.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteFunction.InvokeServer/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/RemoteFunction.InvokeServer/param/1" } ], "returns": [ "@roblox/globaltype/RemoteFunction.InvokeServer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#InvokeServer", "code_sample": "" }, "@roblox/globaltype/RemoteFunction.OnClientInvoke/param/0": { "documentation": "The parameters sent through InvokeClient()." }, "@roblox/globaltype/RemoteFunction.OnClientInvoke/return/0": { "documentation": "Values returned by the callback function." }, "@roblox/globaltype/RemoteFunction.OnClientInvoke": { "documentation": "Callback for when the RemoteFunction is invoked with InvokeClient().", "params": [ { "name": "arguments", "documentation": "@roblox/globaltype/RemoteFunction.OnClientInvoke/param/0" } ], "returns": [ "@roblox/globaltype/RemoteFunction.OnClientInvoke/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#OnClientInvoke", "code_sample": "" }, "@roblox/globaltype/RemoteFunction.OnServerInvoke/param/0": { "documentation": "The Player associated with the client that the InvokeServer() call originates from." }, "@roblox/globaltype/RemoteFunction.OnServerInvoke/param/1": { "documentation": "The parameters sent through InvokeServer()." }, "@roblox/globaltype/RemoteFunction.OnServerInvoke/return/0": { "documentation": "Values returned by the callback function." }, "@roblox/globaltype/RemoteFunction.OnServerInvoke": { "documentation": "Callback for when the RemoteFunction is invoked with InvokeServer().", "params": [ { "name": "player", "documentation": "@roblox/globaltype/RemoteFunction.OnServerInvoke/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/RemoteFunction.OnServerInvoke/param/1" } ], "returns": [ "@roblox/globaltype/RemoteFunction.OnServerInvoke/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#OnServerInvoke", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataMember": { "documentation": "An internal object which cannot be used by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataMember", "code_sample": "" }, "@roblox/globaltype/GamepadService": { "documentation": "The GamepadService is internally responsible for handling inputs from various controllers, such as Xbox One or PlayStation DualShock controllers.", "keys": { "GamepadCursorEnabled": "@roblox/globaltype/GamepadService.GamepadCursorEnabled", "DisableGamepadCursor": "@roblox/globaltype/GamepadService.DisableGamepadCursor", "EnableGamepadCursor": "@roblox/globaltype/GamepadService.EnableGamepadCursor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GamepadService", "code_sample": "" }, "@roblox/globaltype/GamepadService.GamepadCursorEnabled": { "documentation": "The state of the gamepad virtual cursor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GamepadService#GamepadCursorEnabled", "code_sample": "" }, "@roblox/globaltype/GamepadService.DisableGamepadCursor/param/0": { "documentation": "The GamepadService is internally responsible for handling inputs from various controllers, such as Xbox One or PlayStation DualShock controllers." }, "@roblox/globaltype/GamepadService.DisableGamepadCursor": { "documentation": "Disables the gamepad cursor, if currently enabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GamepadService.DisableGamepadCursor/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GamepadService#DisableGamepadCursor", "code_sample": "local gamepadService = game.GamepadService\nlocal userInputService = game.UserInputService\n\nuserInputService.InputBegan:Connect(function(inputObject, gameProcessed)\n\tif inputObject.KeyCode == Enum.KeyCode.ButtonB then\n\t\tgamepadService:DisableGamepadCursor()\n\tend\nend)" }, "@roblox/globaltype/GamepadService.EnableGamepadCursor/param/0": { "documentation": "The GamepadService is internally responsible for handling inputs from various controllers, such as Xbox One or PlayStation DualShock controllers." }, "@roblox/globaltype/GamepadService.EnableGamepadCursor/param/1": { "documentation": "" }, "@roblox/globaltype/GamepadService.EnableGamepadCursor": { "documentation": "Enables the gamepad cursor or updates its position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GamepadService.EnableGamepadCursor/param/0" }, { "name": "guiObject", "documentation": "@roblox/globaltype/GamepadService.EnableGamepadCursor/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GamepadService#EnableGamepadCursor", "code_sample": "local gamepadService = game.GamepadService\nlocal userInputService = game.UserInputService\nlocal startObject = script.Parent\n\nuserInputService.InputBegan:Connect(function(inputObject, gameProcessed)\n\tif inputObject.KeyCode == Enum.KeyCode.ButtonA then\n\t\tgamepadService:EnableGamepadCursor(startObject)\n\tend\nend)" }, "@roblox/globaltype/Vector3Value": { "documentation": "A container object for a single Vector3 value.", "keys": { "Value": "@roblox/globaltype/Vector3Value.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Value", "code_sample": "-- Paste me in a Script inside a Part\nlocal part = script.Parent\n\nlocal teleportPosition = part.TeleportPosition\n\nlocal function onTouch(otherPart)\n\t-- First, find the HumanoidRootPart. If we can't find it, exit.\n\tlocal hrp = otherPart.Parent:FindFirstChild(\"HumanoidRootPart\")\n\tif not hrp then\n\t\treturn\n\tend\n\n\t-- Now teleport by setting the CFrame to one created from\n\t-- the stored TeleportPosition\n\thrp.CFrame = CFrame.new(teleportPosition.Value)\nend\n\npart.Touched:Connect(onTouch)" }, "@roblox/globaltype/Vector3Value.Value": { "documentation": "The stored Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Value#Value", "code_sample": "" }, "@roblox/globaltype/Vector3Value.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3Value.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Vector3Value.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3Value.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Vector3Value.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3Value.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Vector3Value.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.Changed": { "documentation": "Fired whenever Vector3Value.Value is changed.", "keys": { "Connect": "@roblox/globaltype/Vector3Value.Changed.Connect", "ConnectParallel": "@roblox/globaltype/Vector3Value.Changed.ConnectParallel", "Once": "@roblox/globaltype/Vector3Value.Changed.Once", "Wait": "@roblox/globaltype/Vector3Value.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Value#Changed", "code_sample": "local value = Instance.new(\"Vector3Value\")\nvalue.Parent = workspace\n\nvalue.Changed:Connect(function(NewValue)\n\tprint(NewValue)\nend)\n\nvalue.Value = Vector3.new(10, 10, 10)" }, "@roblox/globaltype/Vector3Value.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3Value.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Vector3Value.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3Value.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Vector3Value.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Vector3Value.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Vector3Value.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Vector3Value.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Value.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Vector3Value.changed": { "documentation": "Deprecated: This deprecated event is a variant of Vector3Value.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/Vector3Value.changed.Connect", "ConnectParallel": "@roblox/globaltype/Vector3Value.changed.ConnectParallel", "Once": "@roblox/globaltype/Vector3Value.changed.Once", "Wait": "@roblox/globaltype/Vector3Value.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Value#changed", "code_sample": "" }, "@roblox/globaltype/Accessory": { "documentation": "An item that a Character can wear.", "keys": { "AccessoryType": "@roblox/globaltype/Accessory.AccessoryType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accessory", "code_sample": "" }, "@roblox/globaltype/Accessory.AccessoryType": { "documentation": "Specifies the AccessoryType of the Accessory (eg. Hat, Tshirt, Waist).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accessory#AccessoryType", "code_sample": "" }, "@roblox/globaltype/BanHistoryPages": { "documentation": "Returned by Players:GetBanHistoryAsync to view the entire ban and unban history of any UserId.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BanHistoryPages", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes.", "keys": { "AccessoryBlob": "@roblox/globaltype/HumanoidDescription.AccessoryBlob", "BackAccessory": "@roblox/globaltype/HumanoidDescription.BackAccessory", "BodyTypeScale": "@roblox/globaltype/HumanoidDescription.BodyTypeScale", "ClimbAnimation": "@roblox/globaltype/HumanoidDescription.ClimbAnimation", "DepthScale": "@roblox/globaltype/HumanoidDescription.DepthScale", "Face": "@roblox/globaltype/HumanoidDescription.Face", "FaceAccessory": "@roblox/globaltype/HumanoidDescription.FaceAccessory", "FallAnimation": "@roblox/globaltype/HumanoidDescription.FallAnimation", "FrontAccessory": "@roblox/globaltype/HumanoidDescription.FrontAccessory", "GraphicTShirt": "@roblox/globaltype/HumanoidDescription.GraphicTShirt", "HairAccessory": "@roblox/globaltype/HumanoidDescription.HairAccessory", "HatAccessory": "@roblox/globaltype/HumanoidDescription.HatAccessory", "Head": "@roblox/globaltype/HumanoidDescription.Head", "HeadColor": "@roblox/globaltype/HumanoidDescription.HeadColor", "HeadScale": "@roblox/globaltype/HumanoidDescription.HeadScale", "HeightScale": "@roblox/globaltype/HumanoidDescription.HeightScale", "IdleAnimation": "@roblox/globaltype/HumanoidDescription.IdleAnimation", "JumpAnimation": "@roblox/globaltype/HumanoidDescription.JumpAnimation", "LeftArm": "@roblox/globaltype/HumanoidDescription.LeftArm", "LeftArmColor": "@roblox/globaltype/HumanoidDescription.LeftArmColor", "LeftLeg": "@roblox/globaltype/HumanoidDescription.LeftLeg", "LeftLegColor": "@roblox/globaltype/HumanoidDescription.LeftLegColor", "MoodAnimation": "@roblox/globaltype/HumanoidDescription.MoodAnimation", "NeckAccessory": "@roblox/globaltype/HumanoidDescription.NeckAccessory", "Pants": "@roblox/globaltype/HumanoidDescription.Pants", "ProportionScale": "@roblox/globaltype/HumanoidDescription.ProportionScale", "RightArm": "@roblox/globaltype/HumanoidDescription.RightArm", "RightArmColor": "@roblox/globaltype/HumanoidDescription.RightArmColor", "RightLeg": "@roblox/globaltype/HumanoidDescription.RightLeg", "RightLegColor": "@roblox/globaltype/HumanoidDescription.RightLegColor", "RunAnimation": "@roblox/globaltype/HumanoidDescription.RunAnimation", "Shirt": "@roblox/globaltype/HumanoidDescription.Shirt", "ShouldersAccessory": "@roblox/globaltype/HumanoidDescription.ShouldersAccessory", "SwimAnimation": "@roblox/globaltype/HumanoidDescription.SwimAnimation", "Torso": "@roblox/globaltype/HumanoidDescription.Torso", "TorsoColor": "@roblox/globaltype/HumanoidDescription.TorsoColor", "WaistAccessory": "@roblox/globaltype/HumanoidDescription.WaistAccessory", "WalkAnimation": "@roblox/globaltype/HumanoidDescription.WalkAnimation", "WidthScale": "@roblox/globaltype/HumanoidDescription.WidthScale", "AddEmote": "@roblox/globaltype/HumanoidDescription.AddEmote", "GetAccessories": "@roblox/globaltype/HumanoidDescription.GetAccessories", "GetEmotes": "@roblox/globaltype/HumanoidDescription.GetEmotes", "GetEquippedEmotes": "@roblox/globaltype/HumanoidDescription.GetEquippedEmotes", "RemoveEmote": "@roblox/globaltype/HumanoidDescription.RemoveEmote", "SetAccessories": "@roblox/globaltype/HumanoidDescription.SetAccessories", "SetEmotes": "@roblox/globaltype/HumanoidDescription.SetEmotes", "SetEquippedEmotes": "@roblox/globaltype/HumanoidDescription.SetEquippedEmotes" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.AccessoryBlob": { "documentation": "A JSON formatted array of Layered clothing where each table in the entry in the array describes an accessory's AssetId, AccessoryType, Order, and (optionally) Puffiness as key-value pairs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#AccessoryBlob", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.BackAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its back (such as capes).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#BackAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.BodyTypeScale": { "documentation": "Determines the factor by which the shape of a Humanoid is interpolated from the standard R15 body shape (0) to a taller and more slender body type (1).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#BodyTypeScale", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.ClimbAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Climbing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#ClimbAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.DepthScale": { "documentation": "Determines by what factor the depth (back-to-front distance) of a Humanoid is scaled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#DepthScale", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.Face": { "documentation": "Determines the asset ID of the Face to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#Face", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.FaceAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to the front of its face (such as glasses).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#FaceAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.FallAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Freefall.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#FallAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.FrontAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to front of its torso (such as medals or ties).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#FrontAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.GraphicTShirt": { "documentation": "Determines the Graphic used by a ShirtGraphic.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#GraphicTShirt", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.HairAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its head resembling hair.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#HairAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.HatAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its head.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#HatAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.Head": { "documentation": "Determines the asset ID of the Head to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#Head", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.HeadColor": { "documentation": "Determines the BodyColors.HeadColor3 and BodyColors.HeadColor of a Humanoid when applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#HeadColor", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.HeadScale": { "documentation": "Determines by what factor the Head object of a Humanoid is scaled, as well as any accessories attached to it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#HeadScale", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.HeightScale": { "documentation": "Determines by what factor the height (top-to-bottom distance) of a Humanoid is scaled, as well as all accessories not attached to its head.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#HeightScale", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.IdleAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Running at a speed near zero.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#IdleAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.JumpAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Jumping.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#JumpAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.LeftArm": { "documentation": "Determines the asset ID of the LeftArm to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#LeftArm", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.LeftArmColor": { "documentation": "Determines the BodyColors.LeftArmColor3 and BodyColors.LeftArmColor of a Humanoid when applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#LeftArmColor", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.LeftLeg": { "documentation": "Determines the asset ID of the LeftLeg to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#LeftLeg", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.LeftLegColor": { "documentation": "Determines the BodyColors.LeftLegColor3 and BodyColors.LeftLegColor of a Humanoid when applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#LeftLegColor", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.MoodAnimation": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#MoodAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.NeckAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its neck (such as scarves or necklaces).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#NeckAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.Pants": { "documentation": "Determines the PantsTemplate used by a Pants instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#Pants", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.ProportionScale": { "documentation": "Determines how wide (0) or narrow (1) a Humanoid rig is.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#ProportionScale", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.RightArm": { "documentation": "Determines the asset ID of the RightArm to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#RightArm", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.RightArmColor": { "documentation": "Determines the BodyColors.RightArmColor3 and BodyColors.RightArmColor of a Humanoid when applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#RightArmColor", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.RightLeg": { "documentation": "Determines the asset ID of the RightLeg to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#RightLeg", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.RightLegColor": { "documentation": "Determines the BodyColors.RightLegColor3 and BodyColors.RightLegColor of a Humanoid when applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#RightLegColor", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.RunAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Running at a moderate speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#RunAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.Shirt": { "documentation": "Determines the ShirtTemplate used by a Shirt instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#Shirt", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.ShouldersAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its shoulders (such as shoulder-mounted critters).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#ShouldersAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.SwimAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Swimming.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#SwimAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.Torso": { "documentation": "Determines the asset ID of the Torso to be applied to the Humanoid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#Torso", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.TorsoColor": { "documentation": "Determines the BodyColors.TorsoColor3 and BodyColors.TorsoColor of a Humanoid when applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#TorsoColor", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.WaistAccessory": { "documentation": "A comma-separated list of asset IDs that will be added as Accessories to a Humanoid rig when applied, usually those attached to its waist (such as belts).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#WaistAccessory", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.WalkAnimation": { "documentation": "When this description is applied to a Humanoid, this determines the Animation.AnimationId to play when its state is Running at a low speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#WalkAnimation", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.WidthScale": { "documentation": "Determines by what factor the width (left-to-right distance) of a Humanoid is scaled, as well as all accessories not attached to its head.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#WidthScale", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.AddEmote/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.AddEmote/param/1": { "documentation": "A string that identifies what emote is being added. Example: \"Salute\"." }, "@roblox/globaltype/HumanoidDescription.AddEmote/param/2": { "documentation": "An emote asset ID." }, "@roblox/globaltype/HumanoidDescription.AddEmote": { "documentation": "Adds the emote to the description given a name and its asset ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.AddEmote/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/HumanoidDescription.AddEmote/param/1" }, { "name": "assetId", "documentation": "@roblox/globaltype/HumanoidDescription.AddEmote/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#AddEmote", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.GetAccessories/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.GetAccessories/param/1": { "documentation": "Set to true if rigid accessories from the rigid accessory properties should also be included in the return array. False means only include layered clothing accessories from the AccessoryBlob." }, "@roblox/globaltype/HumanoidDescription.GetAccessories/return/0": { "documentation": "Returns an array where each entry specifies for an individual accessory the AccessoryType, AssetId, IsLayered, Order and Puffiness." }, "@roblox/globaltype/HumanoidDescription.GetAccessories": { "documentation": "Returns a table of an avatar's current accessories.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.GetAccessories/param/0" }, { "name": "includeRigidAccessories", "documentation": "@roblox/globaltype/HumanoidDescription.GetAccessories/param/1" } ], "returns": [ "@roblox/globaltype/HumanoidDescription.GetAccessories/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#GetAccessories", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.GetEmotes/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.GetEmotes/return/0": { "documentation": "A dictionary of emotes where the key is the emote name and the value is an array of emote asset IDs. Example: 
{     Salute = {3360689775},     Agree = {4849487550},     Disagree = {4849495710} }
." }, "@roblox/globaltype/HumanoidDescription.GetEmotes": { "documentation": "Returns a dictionary of emotes that have been added or set to this description.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.GetEmotes/param/0" } ], "returns": [ "@roblox/globaltype/HumanoidDescription.GetEmotes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#GetEmotes", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.GetEquippedEmotes/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.GetEquippedEmotes/return/0": { "documentation": "An array of tables describing the name and slot which each emote is equipped. Example: 
{     {Slot = 3, Name = "Salute"},     {Slot = 2, Name = "Agree"},     {Slot = 1, Name = "Disagree"}, }
." }, "@roblox/globaltype/HumanoidDescription.GetEquippedEmotes": { "documentation": "Returns an array of tables describing the equipped emotes that have been set.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.GetEquippedEmotes/param/0" } ], "returns": [ "@roblox/globaltype/HumanoidDescription.GetEquippedEmotes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#GetEquippedEmotes", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.RemoveEmote/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.RemoveEmote/param/1": { "documentation": "The name of the emote as it was set or added." }, "@roblox/globaltype/HumanoidDescription.RemoveEmote": { "documentation": "Removes any emotes that have been added under the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.RemoveEmote/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/HumanoidDescription.RemoveEmote/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#RemoveEmote", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.SetAccessories/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.SetAccessories/param/1": { "documentation": "Each entry specifies for an individual accessory the AccessoryType, AssetId, IsLayered, Order and Puffiness." }, "@roblox/globaltype/HumanoidDescription.SetAccessories/param/2": { "documentation": "Set to true if rigid accessories are also included in the passed in array (they would have to not specify Order)." }, "@roblox/globaltype/HumanoidDescription.SetAccessories": { "documentation": "Accepts a table that sets the accessories and related properties for an avatar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.SetAccessories/param/0" }, { "name": "accessories", "documentation": "@roblox/globaltype/HumanoidDescription.SetAccessories/param/1" }, { "name": "includeRigidAccessories", "documentation": "@roblox/globaltype/HumanoidDescription.SetAccessories/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#SetAccessories", "code_sample": "local humanoidDescription = Instance.new(\"HumanoidDescription\")\nlocal originalSpecifications = {\n\t{\n\t\tOrder = 1,\n\t\tAssetId = 123456789,\n\t\tPuffiness = 0.5,\n\t\tAccessoryType = Enum.AccessoryType.Sweater,\n\t},\n}\nhumanoidDescription:SetAccessories(originalSpecifications)\n\nlocal updatedSpecifications = humanoidDescription:GetAccessories(false)\nlocal newIndividualSpecification = {\n\tOrder = 2,\n\tAssetId = 987654321,\n\tPuffiness = 0.7,\n\tAccessoryType = Enum.AccessoryType.Jacket,\n\tIsLayered = true,\n}\nupdatedSpecifications[#updatedSpecifications + 1] = newIndividualSpecification\nhumanoidDescription:SetAccessories(updatedSpecifications)" }, "@roblox/globaltype/HumanoidDescription.SetEmotes/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.SetEmotes/param/1": { "documentation": "A dictionary of emotes where the key is the emote name and the value is an array of emote asset IDs. Example: 
{     Salute = {3360689775},     Agree = {4849487550},     Disagree = {4849495710} }
." }, "@roblox/globaltype/HumanoidDescription.SetEmotes": { "documentation": "Sets all of the emotes on this description.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.SetEmotes/param/0" }, { "name": "emotes", "documentation": "@roblox/globaltype/HumanoidDescription.SetEmotes/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#SetEmotes", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.SetEquippedEmotes/param/0": { "documentation": "Describes the appearance of a Humanoid character including body parts, accessories, colors, scales, animations, and emotes." }, "@roblox/globaltype/HumanoidDescription.SetEquippedEmotes/param/1": { "documentation": "An array of emote names. Example: 
{ "Disagree", "Agree", "Salute" }
– OR – An array of tables describing the name and slot which each emote is equipped. Example: 
{     {Slot = 3, Name = "Salute"},     {Slot = 2, Name = "Agree"},     {Slot = 1, Name = "Disagree"}, }
." }, "@roblox/globaltype/HumanoidDescription.SetEquippedEmotes": { "documentation": "Sets the currently equipped emotes given an array of emote names.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.SetEquippedEmotes/param/0" }, { "name": "equippedEmotes", "documentation": "@roblox/globaltype/HumanoidDescription.SetEquippedEmotes/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#SetEquippedEmotes", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EmotesChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EmotesChanged": { "documentation": "Fires when emotes are added, removed or set on this description.", "keys": { "Connect": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Connect", "ConnectParallel": "@roblox/globaltype/HumanoidDescription.EmotesChanged.ConnectParallel", "Once": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Once", "Wait": "@roblox/globaltype/HumanoidDescription.EmotesChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#EmotesChanged", "code_sample": "" }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged": { "documentation": "Fires when the equipped emotes are set on this description.", "keys": { "Connect": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Connect", "ConnectParallel": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.ConnectParallel", "Once": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Once", "Wait": "@roblox/globaltype/HumanoidDescription.EquippedEmotesChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#EquippedEmotesChanged", "code_sample": "" }, "@roblox/globaltype/LocalScript": { "documentation": "An object that contains and runs Luau code on the client (player's device) instead of the server.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalScript", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap": { "documentation": "Provides access to a sorted map within MemoryStoreService.", "keys": { "GetAsync": "@roblox/globaltype/MemoryStoreSortedMap.GetAsync", "GetRangeAsync": "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync", "GetSizeAsync": "@roblox/globaltype/MemoryStoreSortedMap.GetSizeAsync", "RemoveAsync": "@roblox/globaltype/MemoryStoreSortedMap.RemoveAsync", "SetAsync": "@roblox/globaltype/MemoryStoreSortedMap.SetAsync", "UpdateAsync": "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap.GetAsync/param/0": { "documentation": "Provides access to a sorted map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreSortedMap.GetAsync/param/1": { "documentation": "Key whose value and sort key to retrieve." }, "@roblox/globaltype/MemoryStoreSortedMap.GetAsync/return/0": { "documentation": "A tuple of two values: " }, "@roblox/globaltype/MemoryStoreSortedMap.GetAsync": { "documentation": "Retrieves the value and sort key of a key in the sorted map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetAsync/param/1" } ], "returns": [ "@roblox/globaltype/MemoryStoreSortedMap.GetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#GetAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/0": { "documentation": "Provides access to a sorted map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/1": { "documentation": "Sort direction, ascending or descending." }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/2": { "documentation": "The number of items to retrieve; the maximum allowed value for this parameter is 200." }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/3": { "documentation": "(Optional) Lower bound, exclusive, for the returned keys. This is provided as a table where one or both of key and sort key can be specified: { key: string, sortKey: Variant } ." }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/4": { "documentation": "(Optional) Upper bound, exclusive, for the returned keys. This is provided as a table where one or both of key and sort key can be specified: { key: string, sortKey: Variant } ." }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/return/0": { "documentation": "Item keys, values and sort keys in the requested range." }, "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync": { "documentation": "Retrieves items within a sorted range of keys and sort keys.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/0" }, { "name": "direction", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/1" }, { "name": "count", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/2" }, { "name": "exclusiveLowerBound", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/3" }, { "name": "exclusiveUpperBound", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/param/4" } ], "returns": [ "@roblox/globaltype/MemoryStoreSortedMap.GetRangeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#GetRangeAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap.GetSizeAsync/param/0": { "documentation": "Provides access to a sorted map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreSortedMap.GetSizeAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MemoryStoreSortedMap.GetSizeAsync": { "documentation": "Gets the size of the sorted map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.GetSizeAsync/param/0" } ], "returns": [ "@roblox/globaltype/MemoryStoreSortedMap.GetSizeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#GetSizeAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap.RemoveAsync/param/0": { "documentation": "Provides access to a sorted map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreSortedMap.RemoveAsync/param/1": { "documentation": "Key to remove." }, "@roblox/globaltype/MemoryStoreSortedMap.RemoveAsync": { "documentation": "Removes the provided key from the sorted map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.RemoveAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.RemoveAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#RemoveAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/0": { "documentation": "Provides access to a sorted map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/1": { "documentation": "Key whose value to set." }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/2": { "documentation": "Key value to set." }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/3": { "documentation": "Item expiration, in seconds. The item is automatically removed from the sorted map once the expiration duration is reached. The maximum expiration time is 45 days (3,888,000 seconds)." }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/4": { "documentation": "(Optional) Sort key to set for this key. Accepted types are a number (integer or decimal) or a string." }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MemoryStoreSortedMap.SetAsync": { "documentation": "Sets the value of a key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/2" }, { "name": "expiration", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/3" }, { "name": "sortKey", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/param/4" } ], "returns": [ "@roblox/globaltype/MemoryStoreSortedMap.SetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#SetAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/0": { "documentation": "Provides access to a sorted map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/1": { "documentation": "Key whose value to update." }, "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/2": { "documentation": "A function which you need to provide. The function takes the key's old value and old sort key as input and returns the new value and new sort key." }, "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/3": { "documentation": "Item expiration time, in seconds, after which the item will be automatically removed from the sorted map. The maximum expiration time is 45 days (3,888,000 seconds)." }, "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/return/0": { "documentation": "The return value is a tuple of the last value and sort key returned by the transform function." }, "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync": { "documentation": "Retrieves the value and sort key of a key from a sorted map and updates it with a new value and sort key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/1" }, { "name": "transformFunction", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/2" }, { "name": "expiration", "documentation": "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/param/3" } ], "returns": [ "@roblox/globaltype/MemoryStoreSortedMap.UpdateAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreSortedMap#UpdateAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\nlocal map = MemoryStoreService:GetSortedMap(\"Leaderboard\")\nlocal Players = game:GetService(\"Players\")\n\nfunction updateLeaderboard(itemKey, killsToAdd, deathsToAdd)\n\tlocal success, newStats, newScore = pcall(function()\n\t\treturn map:UpdateAsync(itemKey, function(playerStats, playerScore)\n\t\t\tplayerStats = playerStats or { kills = 0, deaths = 0 }\n\t\t\tplayerStats.kills += killsToAdd\n\t\t\tplayerStats.deaths += deathsToAdd\n\t\t\tif playerStats then\n\t\t\t\t-- `playerScore` is the sortKey being used to sort items in the map\n\t\t\t\tplayerScore = playerStats.kills / math.max(playerStats.deaths, 1)\n\t\t\t\treturn playerStats, playerScore\n\t\t\tend\n\t\t\treturn nil\n\t\tend, 30)\n\tend)\nend\n\n-- Add one kill to all players\nfor i, player in pairs(Players:GetPlayers()) do\n\tupdateLeaderboard(player.UserId, 1, 0)\nend\n-- Add 5 kills and 1 death to player with userId 12345\nupdateLeaderboard(12345, 5, 1)" }, "@roblox/globaltype/UIGridLayout": { "documentation": "Positions sibling UI elements by filling rows using the space of the parent UI element.", "keys": { "AbsoluteCellCount": "@roblox/globaltype/UIGridLayout.AbsoluteCellCount", "AbsoluteCellSize": "@roblox/globaltype/UIGridLayout.AbsoluteCellSize", "CellPadding": "@roblox/globaltype/UIGridLayout.CellPadding", "CellSize": "@roblox/globaltype/UIGridLayout.CellSize", "FillDirectionMaxCells": "@roblox/globaltype/UIGridLayout.FillDirectionMaxCells", "StartCorner": "@roblox/globaltype/UIGridLayout.StartCorner" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout", "code_sample": "" }, "@roblox/globaltype/UIGridLayout.AbsoluteCellCount": { "documentation": "The number of elements in the grid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout#AbsoluteCellCount", "code_sample": "" }, "@roblox/globaltype/UIGridLayout.AbsoluteCellSize": { "documentation": "The absolute size of each element in the grid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout#AbsoluteCellSize", "code_sample": "" }, "@roblox/globaltype/UIGridLayout.CellPadding": { "documentation": "Determines how much space there is between elements in the grid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout#CellPadding", "code_sample": "" }, "@roblox/globaltype/UIGridLayout.CellSize": { "documentation": "Determines the size of each element in the grid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout#CellSize", "code_sample": "" }, "@roblox/globaltype/UIGridLayout.FillDirectionMaxCells": { "documentation": "Determines the maximum number of cells that may be used in a row or column before the next one is started.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout#FillDirectionMaxCells", "code_sample": "" }, "@roblox/globaltype/UIGridLayout.StartCorner": { "documentation": "Determines from which corner the grid starts laying out UI elements.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridLayout#StartCorner", "code_sample": "" }, "@roblox/globaltype/VirtualUser": { "documentation": "VirtualUser is a service that allows you to record the inputs of a user, and then play it back to a limited extent.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VirtualUser", "code_sample": "" }, "@roblox/globaltype/EmotesPages": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EmotesPages", "code_sample": "" }, "@roblox/globaltype/Decal": { "documentation": "Applies an image texture to a face of a parent BasePart.", "keys": { "Color3": "@roblox/globaltype/Decal.Color3", "ColorMap": "@roblox/globaltype/Decal.ColorMap", "ColorMapContent": "@roblox/globaltype/Decal.ColorMapContent", "LocalTransparencyModifier": "@roblox/globaltype/Decal.LocalTransparencyModifier", "MetalnessMap": "@roblox/globaltype/Decal.MetalnessMap", "MetalnessMapContent": "@roblox/globaltype/Decal.MetalnessMapContent", "NormalMap": "@roblox/globaltype/Decal.NormalMap", "NormalMapContent": "@roblox/globaltype/Decal.NormalMapContent", "RoughnessMap": "@roblox/globaltype/Decal.RoughnessMap", "RoughnessMapContent": "@roblox/globaltype/Decal.RoughnessMapContent", "Shiny": "@roblox/globaltype/Decal.Shiny", "Specular": "@roblox/globaltype/Decal.Specular", "Texture": "@roblox/globaltype/Decal.Texture", "TextureContent": "@roblox/globaltype/Decal.TextureContent", "TexturePack": "@roblox/globaltype/Decal.TexturePack", "Transparency": "@roblox/globaltype/Decal.Transparency", "UVOffset": "@roblox/globaltype/Decal.UVOffset", "UVScale": "@roblox/globaltype/Decal.UVScale", "ZIndex": "@roblox/globaltype/Decal.ZIndex" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal", "code_sample": "" }, "@roblox/globaltype/Decal.Color3": { "documentation": "The Color3 tint of the Decal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#Color3", "code_sample": "" }, "@roblox/globaltype/Decal.ColorMap": { "documentation": "Content ID that determines the color and opacity of the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMap", "code_sample": "" }, "@roblox/globaltype/Decal.ColorMapContent": { "documentation": "Content object that determines the color and opacity of the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#ColorMapContent", "code_sample": "" }, "@roblox/globaltype/Decal.LocalTransparencyModifier": { "documentation": "Acts as a multiplier for the decal's Transparency property. The effects are only visible to the local player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Decal.MetalnessMap": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#MetalnessMap", "code_sample": "" }, "@roblox/globaltype/Decal.MetalnessMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#MetalnessMapContent", "code_sample": "" }, "@roblox/globaltype/Decal.NormalMap": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#NormalMap", "code_sample": "" }, "@roblox/globaltype/Decal.NormalMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#NormalMapContent", "code_sample": "" }, "@roblox/globaltype/Decal.RoughnessMap": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#RoughnessMap", "code_sample": "" }, "@roblox/globaltype/Decal.RoughnessMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#RoughnessMapContent", "code_sample": "" }, "@roblox/globaltype/Decal.Shiny": { "documentation": "Deprecated: This non-functional property is deprecated and should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#Shiny", "code_sample": "" }, "@roblox/globaltype/Decal.Specular": { "documentation": "Deprecated: This property no longer functions correctly and is deprecated. It should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#Specular", "code_sample": "" }, "@roblox/globaltype/Decal.Texture": { "documentation": "The content ID of the image to be applied by the Decal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#Texture", "code_sample": "" }, "@roblox/globaltype/Decal.TextureContent": { "documentation": "The texture content displayed by the Decal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#TextureContent", "code_sample": "" }, "@roblox/globaltype/Decal.TexturePack": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#TexturePack", "code_sample": "" }, "@roblox/globaltype/Decal.Transparency": { "documentation": "Determines the transparency of the Decal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#Transparency", "code_sample": "" }, "@roblox/globaltype/Decal.UVOffset": { "documentation": "Shifts the UV coordinates by adding an offset before texture mapping.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#UVOffset", "code_sample": "" }, "@roblox/globaltype/Decal.UVScale": { "documentation": "Stretches or compresses the UV coordinates by multiplying a scale factor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#UVScale", "code_sample": "" }, "@roblox/globaltype/Decal.ZIndex": { "documentation": "Determines the rendering order when multiple decals are assigned the same face.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Decal#ZIndex", "code_sample": "" }, "@roblox/globaltype/EncodingService": { "documentation": "Service providing common encoding, hashing, and compression methods.", "keys": { "Base64Decode": "@roblox/globaltype/EncodingService.Base64Decode", "Base64Encode": "@roblox/globaltype/EncodingService.Base64Encode", "CompressBuffer": "@roblox/globaltype/EncodingService.CompressBuffer", "ComputeBufferHash": "@roblox/globaltype/EncodingService.ComputeBufferHash", "ComputeStringHash": "@roblox/globaltype/EncodingService.ComputeStringHash", "DecompressBuffer": "@roblox/globaltype/EncodingService.DecompressBuffer", "GetDecompressedBufferSize": "@roblox/globaltype/EncodingService.GetDecompressedBufferSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService", "code_sample": "" }, "@roblox/globaltype/EncodingService.Base64Decode/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.Base64Decode/param/1": { "documentation": "buffer containing Base64 data to decode" }, "@roblox/globaltype/EncodingService.Base64Decode/return/0": { "documentation": "buffer with the decoded result" }, "@roblox/globaltype/EncodingService.Base64Decode": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.Base64Decode/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.Base64Decode/param/1" } ], "returns": [ "@roblox/globaltype/EncodingService.Base64Decode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#Base64Decode", "code_sample": "" }, "@roblox/globaltype/EncodingService.Base64Encode/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.Base64Encode/param/1": { "documentation": "buffer containing binary data to encode" }, "@roblox/globaltype/EncodingService.Base64Encode/return/0": { "documentation": "buffer with the encoded result" }, "@roblox/globaltype/EncodingService.Base64Encode": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.Base64Encode/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.Base64Encode/param/1" } ], "returns": [ "@roblox/globaltype/EncodingService.Base64Encode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#Base64Encode", "code_sample": "" }, "@roblox/globaltype/EncodingService.CompressBuffer/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.CompressBuffer/param/1": { "documentation": "buffer with binary data to compress" }, "@roblox/globaltype/EncodingService.CompressBuffer/param/2": { "documentation": "CompressionAlgorithm to use for compression" }, "@roblox/globaltype/EncodingService.CompressBuffer/param/3": { "documentation": "optional integer compression level to use" }, "@roblox/globaltype/EncodingService.CompressBuffer/return/0": { "documentation": "buffer with compressed binary data" }, "@roblox/globaltype/EncodingService.CompressBuffer": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.CompressBuffer/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.CompressBuffer/param/1" }, { "name": "algorithm", "documentation": "@roblox/globaltype/EncodingService.CompressBuffer/param/2" }, { "name": "compressionLevel", "documentation": "@roblox/globaltype/EncodingService.CompressBuffer/param/3" } ], "returns": [ "@roblox/globaltype/EncodingService.CompressBuffer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#CompressBuffer", "code_sample": "" }, "@roblox/globaltype/EncodingService.ComputeBufferHash/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.ComputeBufferHash/param/1": { "documentation": "buffer with binary data to compute hash for" }, "@roblox/globaltype/EncodingService.ComputeBufferHash/param/2": { "documentation": "HashAlgorithm cryptographic hash function" }, "@roblox/globaltype/EncodingService.ComputeBufferHash/return/0": { "documentation": "buffer with the binary data of the hash" }, "@roblox/globaltype/EncodingService.ComputeBufferHash": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.ComputeBufferHash/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.ComputeBufferHash/param/1" }, { "name": "algorithm", "documentation": "@roblox/globaltype/EncodingService.ComputeBufferHash/param/2" } ], "returns": [ "@roblox/globaltype/EncodingService.ComputeBufferHash/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#ComputeBufferHash", "code_sample": "" }, "@roblox/globaltype/EncodingService.ComputeStringHash/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.ComputeStringHash/param/1": { "documentation": "string to compute the hash for" }, "@roblox/globaltype/EncodingService.ComputeStringHash/param/2": { "documentation": "HashAlgorithm cryptographic hash function" }, "@roblox/globaltype/EncodingService.ComputeStringHash/return/0": { "documentation": "String with the binary data of the hash" }, "@roblox/globaltype/EncodingService.ComputeStringHash": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.ComputeStringHash/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.ComputeStringHash/param/1" }, { "name": "algorithm", "documentation": "@roblox/globaltype/EncodingService.ComputeStringHash/param/2" } ], "returns": [ "@roblox/globaltype/EncodingService.ComputeStringHash/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#ComputeStringHash", "code_sample": "" }, "@roblox/globaltype/EncodingService.DecompressBuffer/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.DecompressBuffer/param/1": { "documentation": "buffer with compressed binary data" }, "@roblox/globaltype/EncodingService.DecompressBuffer/param/2": { "documentation": "CompressionAlgorithm to use for decompression" }, "@roblox/globaltype/EncodingService.DecompressBuffer/return/0": { "documentation": "buffer with the decompressed binary data" }, "@roblox/globaltype/EncodingService.DecompressBuffer": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.DecompressBuffer/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.DecompressBuffer/param/1" }, { "name": "algorithm", "documentation": "@roblox/globaltype/EncodingService.DecompressBuffer/param/2" } ], "returns": [ "@roblox/globaltype/EncodingService.DecompressBuffer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#DecompressBuffer", "code_sample": "" }, "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/param/0": { "documentation": "Service providing common encoding, hashing, and compression methods." }, "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/param/1": { "documentation": "buffer with compressed binary data" }, "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/param/2": { "documentation": "CompressionAlgorithm used to compress it" }, "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/return/0": { "documentation": "Integer size of the decompressed data or 'nil'" }, "@roblox/globaltype/EncodingService.GetDecompressedBufferSize": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/param/1" }, { "name": "algorithm", "documentation": "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/param/2" } ], "returns": [ "@roblox/globaltype/EncodingService.GetDecompressedBufferSize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EncodingService#GetDecompressedBufferSize", "code_sample": "" }, "@roblox/globaltype/AudioLimiter": { "documentation": "Limits how loud audio streams are allowed to be.", "keys": { "Bypass": "@roblox/globaltype/AudioLimiter.Bypass", "MaxLevel": "@roblox/globaltype/AudioLimiter.MaxLevel", "Release": "@roblox/globaltype/AudioLimiter.Release", "GetConnectedWires": "@roblox/globaltype/AudioLimiter.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioLimiter.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioLimiter.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.MaxLevel": { "documentation": "The maximum volume tolerated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#MaxLevel", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.Release": { "documentation": "The amount of time it takes for previously limited streams to return to their normal volume.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#Release", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.GetConnectedWires/param/0": { "documentation": "Limits how loud audio streams are allowed to be." }, "@roblox/globaltype/AudioLimiter.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioLimiter.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioLimiter.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.GetInputPins/param/0": { "documentation": "Limits how loud audio streams are allowed to be." }, "@roblox/globaltype/AudioLimiter.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioLimiter.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.GetOutputPins/param/0": { "documentation": "Limits how loud audio streams are allowed to be." }, "@roblox/globaltype/AudioLimiter.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioLimiter.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioLimiter.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioLimiter.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioLimiter.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioLimiter.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioLimiter.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioLimiter.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioLimiter.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioLimiter.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioLimiter.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioLimiter.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioLimiter.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioLimiter via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioLimiter.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioLimiter.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioLimiter.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioLimiter.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#WiringChanged", "code_sample": "" }, "@roblox/globaltype/Vector3Curve": { "documentation": "Represents a 3D vector curve, grouping three FloatCurve instances.", "keys": { "GetValueAtTime": "@roblox/globaltype/Vector3Curve.GetValueAtTime", "X": "@roblox/globaltype/Vector3Curve.X", "Y": "@roblox/globaltype/Vector3Curve.Y", "Z": "@roblox/globaltype/Vector3Curve.Z" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Curve", "code_sample": "" }, "@roblox/globaltype/Vector3Curve.GetValueAtTime/param/0": { "documentation": "Represents a 3D vector curve, grouping three FloatCurve instances." }, "@roblox/globaltype/Vector3Curve.GetValueAtTime/param/1": { "documentation": "Time at which to get the value." }, "@roblox/globaltype/Vector3Curve.GetValueAtTime/return/0": { "documentation": "The three FloatCurves (X, Y, Z) at the passed time argument." }, "@roblox/globaltype/Vector3Curve.GetValueAtTime": { "documentation": "Returns the three FloatCurves (X, Y, Z) at the passed time argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Curve.GetValueAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/Vector3Curve.GetValueAtTime/param/1" } ], "returns": [ "@roblox/globaltype/Vector3Curve.GetValueAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#GetValueAtTime", "code_sample": "" }, "@roblox/globaltype/Vector3Curve.X/param/0": { "documentation": "Represents a 3D vector curve, grouping three FloatCurve instances." }, "@roblox/globaltype/Vector3Curve.X/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3Curve.X": { "documentation": "Returns the FloatCurve controlling the X channel (the first child instance of type FloatCurve named X).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Curve.X/param/0" } ], "returns": [ "@roblox/globaltype/Vector3Curve.X/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#X", "code_sample": "" }, "@roblox/globaltype/Vector3Curve.Y/param/0": { "documentation": "Represents a 3D vector curve, grouping three FloatCurve instances." }, "@roblox/globaltype/Vector3Curve.Y/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3Curve.Y": { "documentation": "Returns the FloatCurve controlling the Y channel (the first child instance of type FloatCurve named Y).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Curve.Y/param/0" } ], "returns": [ "@roblox/globaltype/Vector3Curve.Y/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#Y", "code_sample": "" }, "@roblox/globaltype/Vector3Curve.Z/param/0": { "documentation": "Represents a 3D vector curve, grouping three FloatCurve instances." }, "@roblox/globaltype/Vector3Curve.Z/return/0": { "documentation": "" }, "@roblox/globaltype/Vector3Curve.Z": { "documentation": "Returns the FloatCurve controlling the Z channel (the first child instance of type FloatCurve named Z).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Vector3Curve.Z/param/0" } ], "returns": [ "@roblox/globaltype/Vector3Curve.Z/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Vector3Curve#Z", "code_sample": "" }, "@roblox/globaltype/SelectionPointLasso": { "documentation": "Deprecated: The SelectionPointLasso class is deprecated. It should not be used for new work.", "keys": { "Point": "@roblox/globaltype/SelectionPointLasso.Point" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionPointLasso", "code_sample": "" }, "@roblox/globaltype/SelectionPointLasso.Point": { "documentation": "Sets the Vector3 target of the lasso object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionPointLasso#Point", "code_sample": "" }, "@roblox/globaltype/GlobalSettings": { "documentation": "Collection of menu settings for Roblox Studio.", "keys": { "GetFFlag": "@roblox/globaltype/GlobalSettings.GetFFlag", "GetFVariable": "@roblox/globaltype/GlobalSettings.GetFVariable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalSettings", "code_sample": "" }, "@roblox/globaltype/GlobalSettings.GetFFlag/param/0": { "documentation": "Collection of menu settings for Roblox Studio." }, "@roblox/globaltype/GlobalSettings.GetFFlag/param/1": { "documentation": "" }, "@roblox/globaltype/GlobalSettings.GetFFlag/return/0": { "documentation": "" }, "@roblox/globaltype/GlobalSettings.GetFFlag": { "documentation": "Returns the value of an FFlag if it exists.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalSettings.GetFFlag/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/GlobalSettings.GetFFlag/param/1" } ], "returns": [ "@roblox/globaltype/GlobalSettings.GetFFlag/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalSettings#GetFFlag", "code_sample": "" }, "@roblox/globaltype/GlobalSettings.GetFVariable/param/0": { "documentation": "Collection of menu settings for Roblox Studio." }, "@roblox/globaltype/GlobalSettings.GetFVariable/param/1": { "documentation": "" }, "@roblox/globaltype/GlobalSettings.GetFVariable/return/0": { "documentation": "" }, "@roblox/globaltype/GlobalSettings.GetFVariable": { "documentation": "Returns the value of an FVariable, if it exists.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GlobalSettings.GetFVariable/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/GlobalSettings.GetFVariable/param/1" } ], "returns": [ "@roblox/globaltype/GlobalSettings.GetFVariable/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GlobalSettings#GetFVariable", "code_sample": "" }, "@roblox/globaltype/IntValue": { "documentation": "A container object for a single integer.", "keys": { "Value": "@roblox/globaltype/IntValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntValue", "code_sample": "" }, "@roblox/globaltype/IntValue.Value": { "documentation": "Used to hold an integer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntValue#Value", "code_sample": "" }, "@roblox/globaltype/IntValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/IntValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/IntValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/IntValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/IntValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/IntValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/IntValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/IntValue.Changed": { "documentation": "Fires whenever the IntValue.Value is changed.", "keys": { "Connect": "@roblox/globaltype/IntValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/IntValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/IntValue.Changed.Once", "Wait": "@roblox/globaltype/IntValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntValue#Changed", "code_sample": "local value = Instance.new(\"IntValue\")\nvalue.Parent = workspace\n\nlocal function onValueChanged(newValue)\n\tprint(newValue)\nend\n\nvalue.Changed:Connect(onValueChanged)\n\nvalue.Value = 20" }, "@roblox/globaltype/IntValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/IntValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/IntValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/IntValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/IntValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/IntValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/IntValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/IntValue.changed": { "documentation": "Deprecated: This deprecated event is a variant of IntValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/IntValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/IntValue.changed.ConnectParallel", "Once": "@roblox/globaltype/IntValue.changed.Once", "Wait": "@roblox/globaltype/IntValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntValue#changed", "code_sample": "" }, "@roblox/globaltype/HandleAdornment": { "documentation": "An abstract class inherited by 3D handle adornments.", "keys": { "AdornCullingMode": "@roblox/globaltype/HandleAdornment.AdornCullingMode", "AlwaysOnTop": "@roblox/globaltype/HandleAdornment.AlwaysOnTop", "CFrame": "@roblox/globaltype/HandleAdornment.CFrame", "SizeRelativeOffset": "@roblox/globaltype/HandleAdornment.SizeRelativeOffset", "ZIndex": "@roblox/globaltype/HandleAdornment.ZIndex" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.AdornCullingMode": { "documentation": "Determines whether to automatically cull the adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#AdornCullingMode", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.AlwaysOnTop": { "documentation": "Forces this adornment to render on top of all 3D objects in the workspace.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#AlwaysOnTop", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.CFrame": { "documentation": "The position and rotation of the object relative to its PVAdornment.Adornee.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#CFrame", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.SizeRelativeOffset": { "documentation": "The positional offset of the adornment based on the adornee's BasePart.Size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#SizeRelativeOffset", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.ZIndex": { "documentation": "Determines the draw order of this HandleAdornment when AlwaysOnTop is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#ZIndex", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Down": { "documentation": "Fires when a player presses down on their left mouse button while hovering over the adornment.", "keys": { "Connect": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Connect", "ConnectParallel": "@roblox/globaltype/HandleAdornment.MouseButton1Down.ConnectParallel", "Once": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Once", "Wait": "@roblox/globaltype/HandleAdornment.MouseButton1Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#MouseButton1Down", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseButton1Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseButton1Up": { "documentation": "Fires when a player releases their left mouse button while hovering over the adornment.", "keys": { "Connect": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Connect", "ConnectParallel": "@roblox/globaltype/HandleAdornment.MouseButton1Up.ConnectParallel", "Once": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Once", "Wait": "@roblox/globaltype/HandleAdornment.MouseButton1Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#MouseButton1Up", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.MouseEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseEnter": { "documentation": "Fires when a player moves their mouse over the adornment.", "keys": { "Connect": "@roblox/globaltype/HandleAdornment.MouseEnter.Connect", "ConnectParallel": "@roblox/globaltype/HandleAdornment.MouseEnter.ConnectParallel", "Once": "@roblox/globaltype/HandleAdornment.MouseEnter.Once", "Wait": "@roblox/globaltype/HandleAdornment.MouseEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#MouseEnter", "code_sample": "" }, "@roblox/globaltype/HandleAdornment.MouseLeave.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseLeave.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseLeave.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseLeave.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseLeave.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseLeave.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseLeave.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseLeave.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HandleAdornment.MouseLeave.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseLeave.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HandleAdornment.MouseLeave.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandleAdornment.MouseLeave.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HandleAdornment.MouseLeave": { "documentation": "Fires when a player moves their mouse out of the adornment.", "keys": { "Connect": "@roblox/globaltype/HandleAdornment.MouseLeave.Connect", "ConnectParallel": "@roblox/globaltype/HandleAdornment.MouseLeave.ConnectParallel", "Once": "@roblox/globaltype/HandleAdornment.MouseLeave.Once", "Wait": "@roblox/globaltype/HandleAdornment.MouseLeave.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandleAdornment#MouseLeave", "code_sample": "" }, "@roblox/globaltype/FlangeSoundEffect": { "documentation": "Creates a sweeping or swooshing effect on a sound.", "keys": { "Depth": "@roblox/globaltype/FlangeSoundEffect.Depth", "Mix": "@roblox/globaltype/FlangeSoundEffect.Mix", "Rate": "@roblox/globaltype/FlangeSoundEffect.Rate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlangeSoundEffect", "code_sample": "" }, "@roblox/globaltype/FlangeSoundEffect.Depth": { "documentation": "The intensity of the effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlangeSoundEffect#Depth", "code_sample": "" }, "@roblox/globaltype/FlangeSoundEffect.Mix": { "documentation": "Percentage of the original sound that will be applied to the filter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlangeSoundEffect#Mix", "code_sample": "" }, "@roblox/globaltype/FlangeSoundEffect.Rate": { "documentation": "The frequency that the effect oscillates at.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlangeSoundEffect#Rate", "code_sample": "" }, "@roblox/globaltype/UICorner": { "documentation": "UI modifier which applies deformation to corners of its parent GuiObject.", "keys": { "CornerRadius": "@roblox/globaltype/UICorner.CornerRadius" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UICorner", "code_sample": "" }, "@roblox/globaltype/UICorner.CornerRadius": { "documentation": "Determines the radius of the component.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UICorner#CornerRadius", "code_sample": "" }, "@roblox/globaltype/AudioChannelMixer": { "documentation": "Combines multiple audio streams into a single, multichannel audio stream.", "keys": { "Layout": "@roblox/globaltype/AudioChannelMixer.Layout", "GetConnectedWires": "@roblox/globaltype/AudioChannelMixer.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioChannelMixer.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioChannelMixer.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer", "code_sample": "" }, "@roblox/globaltype/AudioChannelMixer.Layout": { "documentation": "Controls the output channel layout to be mixed to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#Layout", "code_sample": "" }, "@roblox/globaltype/AudioChannelMixer.GetConnectedWires/param/0": { "documentation": "Combines multiple audio streams into a single, multichannel audio stream." }, "@roblox/globaltype/AudioChannelMixer.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioChannelMixer.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioChannelMixer.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioChannelMixer.GetInputPins/param/0": { "documentation": "Combines multiple audio streams into a single, multichannel audio stream." }, "@roblox/globaltype/AudioChannelMixer.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.GetInputPins": { "documentation": "Returns the input pins that can be selected by Wire.TargetName.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioChannelMixer.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioChannelMixer.GetOutputPins/param/0": { "documentation": "Combines multiple audio streams into a single, multichannel audio stream." }, "@roblox/globaltype/AudioChannelMixer.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.GetOutputPins": { "documentation": "Returns the output pin available for Wire.SourceName.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioChannelMixer.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelMixer.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioChannelMixer.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioChannelMixer via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioChannelMixer.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioChannelMixer.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#WiringChanged", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService": { "documentation": "", "keys": { "ClientRequestData": "@roblox/globaltype/ScriptProfilerService.ClientRequestData", "ClientStart": "@roblox/globaltype/ScriptProfilerService.ClientStart", "ClientStop": "@roblox/globaltype/ScriptProfilerService.ClientStop", "DeserializeJSON": "@roblox/globaltype/ScriptProfilerService.DeserializeJSON", "ServerRequestData": "@roblox/globaltype/ScriptProfilerService.ServerRequestData", "ServerStart": "@roblox/globaltype/ScriptProfilerService.ServerStart", "ServerStop": "@roblox/globaltype/ScriptProfilerService.ServerStop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.ClientRequestData/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientRequestData/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientRequestData": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientRequestData/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientRequestData/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientRequestData", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStart/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStart/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStart/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStart": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientStart/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientStart/param/1" }, { "name": "frequency", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientStart/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientStart", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStop/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStop/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ClientStop": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientStop/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/ScriptProfilerService.ClientStop/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ClientStop", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.DeserializeJSON/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.DeserializeJSON/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.DeserializeJSON/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.DeserializeJSON": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.DeserializeJSON/param/0" }, { "name": "jsonString", "documentation": "@roblox/globaltype/ScriptProfilerService.DeserializeJSON/param/1" } ], "returns": [ "@roblox/globaltype/ScriptProfilerService.DeserializeJSON/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#DeserializeJSON", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.ServerRequestData/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ServerRequestData": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.ServerRequestData/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerRequestData", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.ServerStart/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ServerStart/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ServerStart": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.ServerStart/param/0" }, { "name": "frequency", "documentation": "@roblox/globaltype/ScriptProfilerService.ServerStart/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerStart", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.ServerStop/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.ServerStop": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.ServerStop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#ServerStop", "code_sample": "" }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptProfilerService.OnNewData.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptProfilerService.OnNewData.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.OnNewData.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptProfilerService.OnNewData.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptProfilerService.OnNewData.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptProfilerService.OnNewData": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/ScriptProfilerService.OnNewData.Connect", "ConnectParallel": "@roblox/globaltype/ScriptProfilerService.OnNewData.ConnectParallel", "Once": "@roblox/globaltype/ScriptProfilerService.OnNewData.Once", "Wait": "@roblox/globaltype/ScriptProfilerService.OnNewData.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptProfilerService#OnNewData", "code_sample": "" }, "@roblox/globaltype/Controller": { "documentation": "The base class for controller objects, such as the HumanoidController object.", "keys": { "BindButton": "@roblox/globaltype/Controller.BindButton", "bindButton": "@roblox/globaltype/Controller.bindButton", "GetButton": "@roblox/globaltype/Controller.GetButton", "getButton": "@roblox/globaltype/Controller.getButton", "UnbindButton": "@roblox/globaltype/Controller.UnbindButton" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller", "code_sample": "" }, "@roblox/globaltype/Controller.BindButton/param/0": { "documentation": "The base class for controller objects, such as the HumanoidController object." }, "@roblox/globaltype/Controller.BindButton/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.BindButton/param/2": { "documentation": "" }, "@roblox/globaltype/Controller.BindButton": { "documentation": "Activates an overriding bind on the specified button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.BindButton/param/0" }, { "name": "button", "documentation": "@roblox/globaltype/Controller.BindButton/param/1" }, { "name": "caption", "documentation": "@roblox/globaltype/Controller.BindButton/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller#BindButton", "code_sample": "" }, "@roblox/globaltype/Controller.bindButton/param/0": { "documentation": "The base class for controller objects, such as the HumanoidController object." }, "@roblox/globaltype/Controller.bindButton/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.bindButton/param/2": { "documentation": "" }, "@roblox/globaltype/Controller.bindButton": { "documentation": "Deprecated: This function is a deprecated variant of Controller:BindButton() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.bindButton/param/0" }, { "name": "button", "documentation": "@roblox/globaltype/Controller.bindButton/param/1" }, { "name": "caption", "documentation": "@roblox/globaltype/Controller.bindButton/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller#bindButton", "code_sample": "" }, "@roblox/globaltype/Controller.GetButton/param/0": { "documentation": "The base class for controller objects, such as the HumanoidController object." }, "@roblox/globaltype/Controller.GetButton/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.GetButton/return/0": { "documentation": "" }, "@roblox/globaltype/Controller.GetButton": { "documentation": "Returns whether or not Button is being pressed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.GetButton/param/0" }, { "name": "button", "documentation": "@roblox/globaltype/Controller.GetButton/param/1" } ], "returns": [ "@roblox/globaltype/Controller.GetButton/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller#GetButton", "code_sample": "" }, "@roblox/globaltype/Controller.getButton/param/0": { "documentation": "The base class for controller objects, such as the HumanoidController object." }, "@roblox/globaltype/Controller.getButton/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.getButton/return/0": { "documentation": "" }, "@roblox/globaltype/Controller.getButton": { "documentation": "Deprecated: This function is a deprecated variant of Controller:GetButton() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.getButton/param/0" }, { "name": "button", "documentation": "@roblox/globaltype/Controller.getButton/param/1" } ], "returns": [ "@roblox/globaltype/Controller.getButton/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller#getButton", "code_sample": "" }, "@roblox/globaltype/Controller.UnbindButton/param/0": { "documentation": "The base class for controller objects, such as the HumanoidController object." }, "@roblox/globaltype/Controller.UnbindButton/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.UnbindButton": { "documentation": "Removes the bind on button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.UnbindButton/param/0" }, { "name": "button", "documentation": "@roblox/globaltype/Controller.UnbindButton/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller#UnbindButton", "code_sample": "" }, "@roblox/globaltype/Controller.ButtonChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Controller.ButtonChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.ButtonChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.ButtonChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Controller.ButtonChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Controller.ButtonChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Controller.ButtonChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.ButtonChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.ButtonChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Controller.ButtonChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Controller.ButtonChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Controller.ButtonChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Controller.ButtonChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.ButtonChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Controller.ButtonChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Controller.ButtonChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Controller.ButtonChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Controller.ButtonChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Controller.ButtonChanged": { "documentation": "Fired when the pressed state of a bound button is changed. This event can be used in conjunction with Controller:GetButton() to see whether a bound button is being pressed down or not.", "keys": { "Connect": "@roblox/globaltype/Controller.ButtonChanged.Connect", "ConnectParallel": "@roblox/globaltype/Controller.ButtonChanged.ConnectParallel", "Once": "@roblox/globaltype/Controller.ButtonChanged.Once", "Wait": "@roblox/globaltype/Controller.ButtonChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Controller#ButtonChanged", "code_sample": "" }, "@roblox/globaltype/VRStatusService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRStatusService", "code_sample": "" }, "@roblox/globaltype/AirController": { "documentation": "", "keys": { "BalanceMaxTorque": "@roblox/globaltype/AirController.BalanceMaxTorque", "BalanceSpeed": "@roblox/globaltype/AirController.BalanceSpeed", "LinearImpulse": "@roblox/globaltype/AirController.LinearImpulse", "MaintainAngularMomentum": "@roblox/globaltype/AirController.MaintainAngularMomentum", "MaintainLinearMomentum": "@roblox/globaltype/AirController.MaintainLinearMomentum", "MoveMaxForce": "@roblox/globaltype/AirController.MoveMaxForce", "TurnMaxTorque": "@roblox/globaltype/AirController.TurnMaxTorque", "TurnSpeedFactor": "@roblox/globaltype/AirController.TurnSpeedFactor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController", "code_sample": "" }, "@roblox/globaltype/AirController.BalanceMaxTorque": { "documentation": "The maximum torque the character can use to remain balanced upright.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#BalanceMaxTorque", "code_sample": "" }, "@roblox/globaltype/AirController.BalanceSpeed": { "documentation": "The maximum angular speed used to align the character upright.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#BalanceSpeed", "code_sample": "" }, "@roblox/globaltype/AirController.LinearImpulse": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#LinearImpulse", "code_sample": "" }, "@roblox/globaltype/AirController.MaintainAngularMomentum": { "documentation": "Determines whether angular momentum is preserved when input has stopped.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#MaintainAngularMomentum", "code_sample": "" }, "@roblox/globaltype/AirController.MaintainLinearMomentum": { "documentation": "Determines whether linear momentum is preserved when input has stopped.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#MaintainLinearMomentum", "code_sample": "" }, "@roblox/globaltype/AirController.MoveMaxForce": { "documentation": "The maximum force that can be applied on the ControllerManager.RootPart for moving in the ControllerManager.MovingDirection.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#MoveMaxForce", "code_sample": "" }, "@roblox/globaltype/AirController.TurnMaxTorque": { "documentation": "The maximum torque that can be applied on the ControllerManager.RootPart for turning towards the ControllerManager.FacingDirection.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#TurnMaxTorque", "code_sample": "" }, "@roblox/globaltype/AirController.TurnSpeedFactor": { "documentation": "The value multiplied by the ControllerManager.BaseTurnSpeed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AirController#TurnSpeedFactor", "code_sample": "" }, "@roblox/globaltype/InsertService": { "documentation": "Used to insert assets from the Roblox website.", "keys": { "AllowClientInsertModels": "@roblox/globaltype/InsertService.AllowClientInsertModels", "AllowInsertFreeModels": "@roblox/globaltype/InsertService.AllowInsertFreeModels", "ApproveAssetId": "@roblox/globaltype/InsertService.ApproveAssetId", "ApproveAssetVersionId": "@roblox/globaltype/InsertService.ApproveAssetVersionId", "CreateMeshPartAsync": "@roblox/globaltype/InsertService.CreateMeshPartAsync", "GetBaseCategories": "@roblox/globaltype/InsertService.GetBaseCategories", "GetBaseSets": "@roblox/globaltype/InsertService.GetBaseSets", "GetCollection": "@roblox/globaltype/InsertService.GetCollection", "GetFreeDecalsAsync": "@roblox/globaltype/InsertService.GetFreeDecalsAsync", "GetFreeDecals": "@roblox/globaltype/InsertService.GetFreeDecals", "GetFreeModelsAsync": "@roblox/globaltype/InsertService.GetFreeModelsAsync", "GetFreeModels": "@roblox/globaltype/InsertService.GetFreeModels", "GetLatestAssetVersionAsync": "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync", "GetUserCategories": "@roblox/globaltype/InsertService.GetUserCategories", "GetUserSets": "@roblox/globaltype/InsertService.GetUserSets", "Insert": "@roblox/globaltype/InsertService.Insert", "LoadAsset": "@roblox/globaltype/InsertService.LoadAsset", "loadAsset": "@roblox/globaltype/InsertService.loadAsset", "LoadAssetVersion": "@roblox/globaltype/InsertService.LoadAssetVersion" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService", "code_sample": "" }, "@roblox/globaltype/InsertService.AllowClientInsertModels": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#AllowClientInsertModels", "code_sample": "" }, "@roblox/globaltype/InsertService.AllowInsertFreeModels": { "documentation": "Deprecated: This item was never released. Do not use it in new work.
Indicates whether ''Free Models'' can be inserted into the game.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#AllowInsertFreeModels", "code_sample": "" }, "@roblox/globaltype/InsertService.ApproveAssetId/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.ApproveAssetId/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.ApproveAssetId": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.ApproveAssetId/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/InsertService.ApproveAssetId/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#ApproveAssetId", "code_sample": "" }, "@roblox/globaltype/InsertService.ApproveAssetVersionId/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.ApproveAssetVersionId/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.ApproveAssetVersionId": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.ApproveAssetVersionId/param/0" }, { "name": "assetVersionId", "documentation": "@roblox/globaltype/InsertService.ApproveAssetVersionId/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#ApproveAssetVersionId", "code_sample": "" }, "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/1": { "documentation": "Mesh asset ID." }, "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/2": { "documentation": "Set MeshPart.CollisionFidelity." }, "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/3": { "documentation": "Set MeshPart.RenderFidelity." }, "@roblox/globaltype/InsertService.CreateMeshPartAsync/return/0": { "documentation": "New MeshPart instance." }, "@roblox/globaltype/InsertService.CreateMeshPartAsync": { "documentation": "Creates a new MeshPart with specified fidelity values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/0" }, { "name": "meshId", "documentation": "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/1" }, { "name": "collisionFidelity", "documentation": "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/2" }, { "name": "renderFidelity", "documentation": "@roblox/globaltype/InsertService.CreateMeshPartAsync/param/3" } ], "returns": [ "@roblox/globaltype/InsertService.CreateMeshPartAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#CreateMeshPartAsync", "code_sample": "" }, "@roblox/globaltype/InsertService.GetBaseCategories/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetBaseCategories/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.GetBaseCategories": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetBaseCategories/param/0" } ], "returns": [ "@roblox/globaltype/InsertService.GetBaseCategories/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseCategories", "code_sample": "" }, "@roblox/globaltype/InsertService.GetBaseSets/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetBaseSets/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.GetBaseSets": { "documentation": "Deprecated: Sets have been removed from Roblox.
Returns an array of dictionaries, containing information about various Roblox approved sets.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetBaseSets/param/0" } ], "returns": [ "@roblox/globaltype/InsertService.GetBaseSets/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetBaseSets", "code_sample": "" }, "@roblox/globaltype/InsertService.GetCollection/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetCollection/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.GetCollection/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.GetCollection": { "documentation": "Deprecated: Sets have been removed from Roblox.
Returns the most recently uploaded models in the specified category.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetCollection/param/0" }, { "name": "categoryId", "documentation": "@roblox/globaltype/InsertService.GetCollection/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.GetCollection/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetCollection", "code_sample": "local InsertService = game:GetService(\"InsertService\")\n\nlocal set = InsertService:GetBaseSets()[1]\nlocal list = InsertService:GetCollection(set[\"CategoryId\"])\n\nprint(list)" }, "@roblox/globaltype/InsertService.GetFreeDecalsAsync/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetFreeDecalsAsync/param/1": { "documentation": "String used to search for free decals in the Catalog." }, "@roblox/globaltype/InsertService.GetFreeDecalsAsync/param/2": { "documentation": "The page number in the Catalog to return." }, "@roblox/globaltype/InsertService.GetFreeDecalsAsync/return/0": { "documentation": "A single table (of returned free decals) wrapped in a table." }, "@roblox/globaltype/InsertService.GetFreeDecalsAsync": { "documentation": "Retrieves a list of free Decals from the Catalog.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetFreeDecalsAsync/param/0" }, { "name": "searchText", "documentation": "@roblox/globaltype/InsertService.GetFreeDecalsAsync/param/1" }, { "name": "pageNum", "documentation": "@roblox/globaltype/InsertService.GetFreeDecalsAsync/param/2" } ], "returns": [ "@roblox/globaltype/InsertService.GetFreeDecalsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeDecalsAsync", "code_sample": "" }, "@roblox/globaltype/InsertService.GetFreeDecals/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetFreeDecals/param/1": { "documentation": "String used to search for free decals in the Catalog." }, "@roblox/globaltype/InsertService.GetFreeDecals/param/2": { "documentation": "The page number in the Catalog to return." }, "@roblox/globaltype/InsertService.GetFreeDecals/return/0": { "documentation": "A single table (of returned free decals) wrapped in a table." }, "@roblox/globaltype/InsertService.GetFreeDecals": { "documentation": "Deprecated:
Retrieves a list of free Decals from the Catalog.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetFreeDecals/param/0" }, { "name": "searchText", "documentation": "@roblox/globaltype/InsertService.GetFreeDecals/param/1" }, { "name": "pageNum", "documentation": "@roblox/globaltype/InsertService.GetFreeDecals/param/2" } ], "returns": [ "@roblox/globaltype/InsertService.GetFreeDecals/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeDecals", "code_sample": "" }, "@roblox/globaltype/InsertService.GetFreeModelsAsync/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetFreeModelsAsync/param/1": { "documentation": "String used to search for free decals in the Catalog." }, "@roblox/globaltype/InsertService.GetFreeModelsAsync/param/2": { "documentation": "The page number in the Catalog to return." }, "@roblox/globaltype/InsertService.GetFreeModelsAsync/return/0": { "documentation": "A single table (of returned free models) wrapped in a table." }, "@roblox/globaltype/InsertService.GetFreeModelsAsync": { "documentation": "Retrieves a list of Free Models from the Catalog.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetFreeModelsAsync/param/0" }, { "name": "searchText", "documentation": "@roblox/globaltype/InsertService.GetFreeModelsAsync/param/1" }, { "name": "pageNum", "documentation": "@roblox/globaltype/InsertService.GetFreeModelsAsync/param/2" } ], "returns": [ "@roblox/globaltype/InsertService.GetFreeModelsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeModelsAsync", "code_sample": "" }, "@roblox/globaltype/InsertService.GetFreeModels/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetFreeModels/param/1": { "documentation": "String used to search for free decals in the Catalog." }, "@roblox/globaltype/InsertService.GetFreeModels/param/2": { "documentation": "The page number in the Catalog to return." }, "@roblox/globaltype/InsertService.GetFreeModels/return/0": { "documentation": "A single table (of returned free models) wrapped in a table." }, "@roblox/globaltype/InsertService.GetFreeModels": { "documentation": "Deprecated:
Retrieves a list of Free Models from the Catalog.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetFreeModels/param/0" }, { "name": "searchText", "documentation": "@roblox/globaltype/InsertService.GetFreeModels/param/1" }, { "name": "pageNum", "documentation": "@roblox/globaltype/InsertService.GetFreeModels/param/2" } ], "returns": [ "@roblox/globaltype/InsertService.GetFreeModels/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeModels", "code_sample": "" }, "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync": { "documentation": "Returns the latest AssetVersionId of an asset for assets created by the place creator. Can be used in combination with InsertService:LoadAssetVersion() to load the latest version of a model, even if it gets updated while the game is running.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.GetLatestAssetVersionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetLatestAssetVersionAsync", "code_sample": "" }, "@roblox/globaltype/InsertService.GetUserCategories/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetUserCategories/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.GetUserCategories/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.GetUserCategories": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetUserCategories/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/InsertService.GetUserCategories/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.GetUserCategories/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetUserCategories", "code_sample": "" }, "@roblox/globaltype/InsertService.GetUserSets/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.GetUserSets/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.GetUserSets/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.GetUserSets": { "documentation": "Deprecated: Sets have been removed from Roblox.
Returns an array of dictionaries, containing information about sets owned by the user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.GetUserSets/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/InsertService.GetUserSets/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.GetUserSets/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#GetUserSets", "code_sample": "" }, "@roblox/globaltype/InsertService.Insert/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.Insert/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.Insert": { "documentation": "Deprecated: This function has been superseded by InsertService:LoadAsset() which should be used in all new work.
Inserts Instance into Workspace.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.Insert/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/InsertService.Insert/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#Insert", "code_sample": "local InsertService = game:GetService(\"InsertService\")\n\nlocal ASSET_ID = 123456789\n\nlocal instance = InsertService:LoadAsset(ASSET_ID)\n\nif instance then\n\tInsertService:Insert(instance)\nend" }, "@roblox/globaltype/InsertService.LoadAsset/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.LoadAsset/param/1": { "documentation": "The asset ID of the asset being loaded." }, "@roblox/globaltype/InsertService.LoadAsset/return/0": { "documentation": "An instance of the loaded asset." }, "@roblox/globaltype/InsertService.LoadAsset": { "documentation": "Returns a Model containing the asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.LoadAsset/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/InsertService.LoadAsset/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.LoadAsset/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#LoadAsset", "code_sample": "local InsertService = game:GetService(\"InsertService\")\n\nlocal ASSET_ID = 82353\n\nlocal asset = InsertService:LoadAsset(ASSET_ID)\n\nasset.Parent = workspace" }, "@roblox/globaltype/InsertService.loadAsset/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.loadAsset/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.loadAsset/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.loadAsset": { "documentation": "Deprecated: This function is a deprecated variant of InsertService:LoadAsset() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.loadAsset/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/InsertService.loadAsset/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.loadAsset/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#loadAsset", "code_sample": "" }, "@roblox/globaltype/InsertService.LoadAssetVersion/param/0": { "documentation": "Used to insert assets from the Roblox website." }, "@roblox/globaltype/InsertService.LoadAssetVersion/param/1": { "documentation": "" }, "@roblox/globaltype/InsertService.LoadAssetVersion/return/0": { "documentation": "" }, "@roblox/globaltype/InsertService.LoadAssetVersion": { "documentation": "Returns a model inserted into InsertService containing the asset with the given assetVersionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InsertService.LoadAssetVersion/param/0" }, { "name": "assetVersionId", "documentation": "@roblox/globaltype/InsertService.LoadAssetVersion/param/1" } ], "returns": [ "@roblox/globaltype/InsertService.LoadAssetVersion/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InsertService#LoadAssetVersion", "code_sample": "local InsertService = game:GetService(\"InsertService\")\n\nlocal ASSET_VERSION_ID = 296050499\n\nlocal asset = InsertService:LoadAssetVersion(ASSET_VERSION_ID)\n\nasset.Parent = game.Workspace" }, "@roblox/globaltype/TextLabel": { "documentation": "A 2D user interface element that displays non-interactive text.", "keys": { "ContentText": "@roblox/globaltype/TextLabel.ContentText", "Font": "@roblox/globaltype/TextLabel.Font", "FontFace": "@roblox/globaltype/TextLabel.FontFace", "FontSize": "@roblox/globaltype/TextLabel.FontSize", "LineHeight": "@roblox/globaltype/TextLabel.LineHeight", "LocalizedText": "@roblox/globaltype/TextLabel.LocalizedText", "MaxVisibleGraphemes": "@roblox/globaltype/TextLabel.MaxVisibleGraphemes", "OpenTypeFeatures": "@roblox/globaltype/TextLabel.OpenTypeFeatures", "OpenTypeFeaturesError": "@roblox/globaltype/TextLabel.OpenTypeFeaturesError", "RichText": "@roblox/globaltype/TextLabel.RichText", "Text": "@roblox/globaltype/TextLabel.Text", "TextBounds": "@roblox/globaltype/TextLabel.TextBounds", "TextColor": "@roblox/globaltype/TextLabel.TextColor", "TextColor3": "@roblox/globaltype/TextLabel.TextColor3", "TextDirection": "@roblox/globaltype/TextLabel.TextDirection", "TextFits": "@roblox/globaltype/TextLabel.TextFits", "TextScaled": "@roblox/globaltype/TextLabel.TextScaled", "TextSize": "@roblox/globaltype/TextLabel.TextSize", "TextStrokeColor3": "@roblox/globaltype/TextLabel.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/TextLabel.TextStrokeTransparency", "TextTransparency": "@roblox/globaltype/TextLabel.TextTransparency", "TextTruncate": "@roblox/globaltype/TextLabel.TextTruncate", "TextWrap": "@roblox/globaltype/TextLabel.TextWrap", "TextWrapped": "@roblox/globaltype/TextLabel.TextWrapped", "TextXAlignment": "@roblox/globaltype/TextLabel.TextXAlignment", "TextYAlignment": "@roblox/globaltype/TextLabel.TextYAlignment" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel", "code_sample": "" }, "@roblox/globaltype/TextLabel.ContentText": { "documentation": "A copy of TextLabel.Text that contains exactly what is being rendered by the TextLabel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#ContentText", "code_sample": "" }, "@roblox/globaltype/TextLabel.Font": { "documentation": "Determines the font used to render text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#Font", "code_sample": "local frame = script.Parent\n\n-- Create a TextLabel displaying each font\nfor _, font in pairs(Enum.Font:GetEnumItems()) do\n\tlocal textLabel = Instance.new(\"TextLabel\")\n\ttextLabel.Name = font.Name\n\t-- Set the text properties\n\ttextLabel.Text = font.Name\n\ttextLabel.Font = font\n\t-- Some rendering properties\n\ttextLabel.TextSize = 24\n\ttextLabel.TextXAlignment = Enum.TextXAlignment.Left\n\t-- Size the frame equal to the height of the text\n\ttextLabel.Size = UDim2.new(1, 0, 0, textLabel.TextSize)\n\t-- Add to the parent frame\n\ttextLabel.Parent = frame\nend\n\n-- Layout the frames in a list (if they aren't already)\nif not frame:FindFirstChildOfClass(\"UIListLayout\") then\n\tlocal uiListLayout = Instance.new(\"UIListLayout\")\n\tuiListLayout.Parent = frame\nend" }, "@roblox/globaltype/TextLabel.FontFace": { "documentation": "Determines the font used to render text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#FontFace", "code_sample": "" }, "@roblox/globaltype/TextLabel.FontSize": { "documentation": "Deprecated: This property is deprecated in favor of TextSize which is an integer and not an enum and thus offers far more options for sizes.
Determines the font size to be used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#FontSize", "code_sample": "" }, "@roblox/globaltype/TextLabel.LineHeight": { "documentation": "Scales the spacing between lines of text in the TextLabel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#LineHeight", "code_sample": "" }, "@roblox/globaltype/TextLabel.LocalizedText": { "documentation": "Sets whether a TextLabel should be GuiBase2d.Localize or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#LocalizedText", "code_sample": "" }, "@roblox/globaltype/TextLabel.MaxVisibleGraphemes": { "documentation": "The maximum number of graphemes the TextLabel can show.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#MaxVisibleGraphemes", "code_sample": "" }, "@roblox/globaltype/TextLabel.OpenTypeFeatures": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#OpenTypeFeatures", "code_sample": "" }, "@roblox/globaltype/TextLabel.OpenTypeFeaturesError": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#OpenTypeFeaturesError", "code_sample": "" }, "@roblox/globaltype/TextLabel.RichText": { "documentation": "Determines whether the TextLabel renders its text using rich text formatting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#RichText", "code_sample": "" }, "@roblox/globaltype/TextLabel.Text": { "documentation": "Determines the string rendered by the TextLabel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#Text", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextBounds": { "documentation": "Read-only property which reflects the absolute size of rendered text in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextBounds", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextColor": { "documentation": "Deprecated: This item has been superseded by TextLabel.TextColor3 which should be used in all new work.
Determines the color of text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextColor", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextColor3": { "documentation": "Determines the color of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextColor3", "code_sample": "-- Place this code in a LocalScript within a TextLabel/TextButton\nlocal textLabel = script.Parent\n\n-- Some colors we'll use with TextColor3\nlocal colorNormal = Color3.new(0, 0, 0) -- black\nlocal colorSoon = Color3.new(1, 0.5, 0.5) -- red\nlocal colorDone = Color3.new(0.5, 1, 0.5) -- green\n\n-- Loop infinitely\nwhile true do\n\t-- Count backwards from 10 to 1\n\tfor i = 10, 1, -1 do\n\t\t-- Set the text\n\t\ttextLabel.Text = \"Time: \" .. i\n\t\t-- Set the color based on how much time is left\n\t\tif i > 3 then\n\t\t\ttextLabel.TextColor3 = colorNormal\n\t\telse\n\t\t\ttextLabel.TextColor3 = colorSoon\n\t\tend\n\t\ttask.wait(1)\n\tend\n\ttextLabel.Text = \"GO!\"\n\ttextLabel.TextColor3 = colorDone\n\ttask.wait(2)\nend" }, "@roblox/globaltype/TextLabel.TextDirection": { "documentation": "Direction in which the text is rendered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextDirection", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextFits": { "documentation": "A boolean representation of whether the label's text fits within the size of it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextFits", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextScaled": { "documentation": "Changes whether text is resized to fit within the TextLabel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextScaled", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextSize": { "documentation": "Determines the line height of text in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextSize", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextStrokeColor3": { "documentation": "Determines the color of the text stroke (outline).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextStrokeTransparency": { "documentation": "Determines the transparency of the text stroke (outline).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextTransparency": { "documentation": "Determines the transparency of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextTransparency", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextTruncate": { "documentation": "Controls the truncation of the text displayed in the TextLabel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextTruncate", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextWrap": { "documentation": "Deprecated: This property is simply an alias for TextWrapped. Use the past-tense version instead.
Determines whether or not text should wrap at the edges of the TextLabel element's space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextWrap", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextWrapped": { "documentation": "Determines if text wraps to multiple lines within the TextLabel element's space, truncating excess text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextWrapped", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextXAlignment": { "documentation": "Determines the horizontal alignment of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextXAlignment", "code_sample": "" }, "@roblox/globaltype/TextLabel.TextYAlignment": { "documentation": "Determines the vertical alignment of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextLabel#TextYAlignment", "code_sample": "" }, "@roblox/globaltype/Platform": { "documentation": "Historically a form of Seat that wouldn't place the player in a sitting pose. This object is no longer create-able and cannot be used by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Platform", "code_sample": "" }, "@roblox/globaltype/NetworkSettings": { "documentation": "Settings related to networked engine behaviors.", "keys": { "EmulatedTotalMemoryInMB": "@roblox/globaltype/NetworkSettings.EmulatedTotalMemoryInMB", "FreeMemoryMBytes": "@roblox/globaltype/NetworkSettings.FreeMemoryMBytes", "HttpProxyEnabled": "@roblox/globaltype/NetworkSettings.HttpProxyEnabled", "HttpProxyURL": "@roblox/globaltype/NetworkSettings.HttpProxyURL", "IncomingReplicationLag": "@roblox/globaltype/NetworkSettings.IncomingReplicationLag", "PrintJoinSizeBreakdown": "@roblox/globaltype/NetworkSettings.PrintJoinSizeBreakdown", "PrintPhysicsErrors": "@roblox/globaltype/NetworkSettings.PrintPhysicsErrors", "PrintStreamInstanceQuota": "@roblox/globaltype/NetworkSettings.PrintStreamInstanceQuota", "RandomizeJoinInstanceOrder": "@roblox/globaltype/NetworkSettings.RandomizeJoinInstanceOrder", "RenderStreamedRegions": "@roblox/globaltype/NetworkSettings.RenderStreamedRegions", "ShowActiveAnimationAsset": "@roblox/globaltype/NetworkSettings.ShowActiveAnimationAsset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.EmulatedTotalMemoryInMB": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#EmulatedTotalMemoryInMB", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.FreeMemoryMBytes": { "documentation": "Describes how much free memory is available, in MiBs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#FreeMemoryMBytes", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.HttpProxyEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#HttpProxyEnabled", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.HttpProxyURL": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#HttpProxyURL", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.IncomingReplicationLag": { "documentation": "Simulates additional network latency in the network receiving path.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#IncomingReplicationLag", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.PrintJoinSizeBreakdown": { "documentation": "Prints diagnostic information about data sent on connect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#PrintJoinSizeBreakdown", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.PrintPhysicsErrors": { "documentation": "Whether debug messages will be printed to the output pertaining to physics replication errors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#PrintPhysicsErrors", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.PrintStreamInstanceQuota": { "documentation": "Whether debug information is printed to the output regarding the replication of instances when Workspace.StreamingEnabled is set to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#PrintStreamInstanceQuota", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.RandomizeJoinInstanceOrder": { "documentation": "Special facility to help catch bugs related to how your experience loads.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#RandomizeJoinInstanceOrder", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.RenderStreamedRegions": { "documentation": "Whether regions of space that are being streamed to the client will be outlined in red.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#RenderStreamedRegions", "code_sample": "" }, "@roblox/globaltype/NetworkSettings.ShowActiveAnimationAsset": { "documentation": "Whether a label will be shown above each player character's head, showing the current animation being played.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkSettings#ShowActiveAnimationAsset", "code_sample": "" }, "@roblox/globaltype/StarterPack": { "documentation": "A service-level container whose contents are copied into each player's Backpack when the player spawns. It is generally used to hold Tools, but is sometimes used to hold LocalScripts to ensure that each player gets a copy.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPack", "code_sample": "local StarterPack = game:GetService(\"StarterPack\")\n\nlocal function emptyStarterPack()\n\tfor _, child in pairs(StarterPack:GetChildren()) do\n\t\tif child:IsA(\"Tool\") then\n\t\t\tchild:Destroy()\n\t\tend\n\tend\nend\n\nemptyStarterPack()" }, "@roblox/globaltype/CoreScriptDebuggingManagerHelper": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CoreScriptDebuggingManagerHelper", "code_sample": "" }, "@roblox/globaltype/ControllerManager": { "documentation": "Manages simulated motion control for its assigned ControllerManager.RootPart .", "keys": { "ActiveController": "@roblox/globaltype/ControllerManager.ActiveController", "BaseMoveSpeed": "@roblox/globaltype/ControllerManager.BaseMoveSpeed", "BaseTurnSpeed": "@roblox/globaltype/ControllerManager.BaseTurnSpeed", "ClimbSensor": "@roblox/globaltype/ControllerManager.ClimbSensor", "FacingDirection": "@roblox/globaltype/ControllerManager.FacingDirection", "GroundSensor": "@roblox/globaltype/ControllerManager.GroundSensor", "MovingDirection": "@roblox/globaltype/ControllerManager.MovingDirection", "RootPart": "@roblox/globaltype/ControllerManager.RootPart", "UpDirection": "@roblox/globaltype/ControllerManager.UpDirection" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager", "code_sample": "" }, "@roblox/globaltype/ControllerManager.ActiveController": { "documentation": "The ControllerBase that is set to be activated on the character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#ActiveController", "code_sample": "" }, "@roblox/globaltype/ControllerManager.BaseMoveSpeed": { "documentation": "The base linear movement speed used by all controllers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#BaseMoveSpeed", "code_sample": "" }, "@roblox/globaltype/ControllerManager.BaseTurnSpeed": { "documentation": "The base angular turning speed used by all controllers.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#BaseTurnSpeed", "code_sample": "" }, "@roblox/globaltype/ControllerManager.ClimbSensor": { "documentation": "A reference to the sensor data used while a ClimbController is active.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#ClimbSensor", "code_sample": "" }, "@roblox/globaltype/ControllerManager.FacingDirection": { "documentation": "The unit vector describing the desired direction to face.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#FacingDirection", "code_sample": "" }, "@roblox/globaltype/ControllerManager.GroundSensor": { "documentation": "A reference to the sensor data used while a GroundController is active.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#GroundSensor", "code_sample": "" }, "@roblox/globaltype/ControllerManager.MovingDirection": { "documentation": "The vector describing the desired direction to move in.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#MovingDirection", "code_sample": "" }, "@roblox/globaltype/ControllerManager.RootPart": { "documentation": "The BasePart where the controller's forces and torques are applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#RootPart", "code_sample": "" }, "@roblox/globaltype/ControllerManager.UpDirection": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerManager#UpDirection", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataYieldFunctions": { "documentation": "Acts as a Folder containing information about yielding functions for a ReflectionMetadataClass, and should be parented to it. ReflectionMetadataMembers that are parented to this object will be perceived as yielding functions under the class this is parented to.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataYieldFunctions", "code_sample": "" }, "@roblox/globaltype/BodyVelocity": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LinearVelocity instead, and see the legacy conversion notes.
Applies a force to maintain a constant velocity.", "keys": { "MaxForce": "@roblox/globaltype/BodyVelocity.MaxForce", "maxForce": "@roblox/globaltype/BodyVelocity.maxForce", "P": "@roblox/globaltype/BodyVelocity.P", "Velocity": "@roblox/globaltype/BodyVelocity.Velocity", "velocity": "@roblox/globaltype/BodyVelocity.velocity", "GetLastForce": "@roblox/globaltype/BodyVelocity.GetLastForce", "lastForce": "@roblox/globaltype/BodyVelocity.lastForce" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.MaxForce": { "documentation": "Determines the limit on how much force that may be applied to each axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#MaxForce", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.maxForce": { "documentation": "Deprecated: This property is a deprecated variant of BodyVelocity.MaxForce which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#maxForce", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.P": { "documentation": "Determines how aggressive of a force is applied in reaching the goal velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#P", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.Velocity": { "documentation": "Determines the goal velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#Velocity", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.velocity": { "documentation": "Deprecated: This property is a deprecated variant of BodyVelocity.Velocity which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#velocity", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.GetLastForce/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LinearVelocity instead, and see the legacy conversion notes.
Applies a force to maintain a constant velocity." }, "@roblox/globaltype/BodyVelocity.GetLastForce/return/0": { "documentation": "" }, "@roblox/globaltype/BodyVelocity.GetLastForce": { "documentation": "Not implemented and will always return the 0 vector.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyVelocity.GetLastForce/param/0" } ], "returns": [ "@roblox/globaltype/BodyVelocity.GetLastForce/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#GetLastForce", "code_sample": "" }, "@roblox/globaltype/BodyVelocity.lastForce/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LinearVelocity instead, and see the legacy conversion notes.
Applies a force to maintain a constant velocity." }, "@roblox/globaltype/BodyVelocity.lastForce/return/0": { "documentation": "" }, "@roblox/globaltype/BodyVelocity.lastForce": { "documentation": "Returns the last force in the object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyVelocity.lastForce/param/0" } ], "returns": [ "@roblox/globaltype/BodyVelocity.lastForce/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyVelocity#lastForce", "code_sample": "" }, "@roblox/globaltype/NotificationService": { "documentation": "An internal service which cannot be used by developers.", "keys": { "IsLuaGameDetailsEnabled": "@roblox/globaltype/NotificationService.IsLuaGameDetailsEnabled", "SelectedTheme": "@roblox/globaltype/NotificationService.SelectedTheme" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NotificationService", "code_sample": "" }, "@roblox/globaltype/NotificationService.IsLuaGameDetailsEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NotificationService#IsLuaGameDetailsEnabled", "code_sample": "" }, "@roblox/globaltype/NotificationService.SelectedTheme": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NotificationService#SelectedTheme", "code_sample": "" }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Connect", "ConnectParallel": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.ConnectParallel", "Once": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Once", "Wait": "@roblox/globaltype/NotificationService.Roblox17sConnectionChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NotificationService#Roblox17sConnectionChanged", "code_sample": "" }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NotificationService.Roblox17sEventReceived": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Connect", "ConnectParallel": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.ConnectParallel", "Once": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Once", "Wait": "@roblox/globaltype/NotificationService.Roblox17sEventReceived.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NotificationService#Roblox17sEventReceived", "code_sample": "" }, "@roblox/globaltype/PatchBundlerFileWatch": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PatchBundlerFileWatch", "code_sample": "" }, "@roblox/globaltype/Pose": { "documentation": "Holds the CFrame applied to the Motor6D connected to its associated BasePart. The part which is controlled depends on the name of the Pose.", "keys": { "CFrame": "@roblox/globaltype/Pose.CFrame", "MaskWeight": "@roblox/globaltype/Pose.MaskWeight", "AddSubPose": "@roblox/globaltype/Pose.AddSubPose", "GetSubPoses": "@roblox/globaltype/Pose.GetSubPoses", "RemoveSubPose": "@roblox/globaltype/Pose.RemoveSubPose" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pose", "code_sample": "" }, "@roblox/globaltype/Pose.CFrame": { "documentation": "This CFrame applies to the Motor6D corresponding with the Pose when the Motor6D.Transform is changed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pose#CFrame", "code_sample": "" }, "@roblox/globaltype/Pose.MaskWeight": { "documentation": "Deprecated: This property is deprecated. Use the AnimationTrack:AdjustWeight() function when blending multiple animations.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pose#MaskWeight", "code_sample": "" }, "@roblox/globaltype/Pose.AddSubPose/param/0": { "documentation": "Holds the CFrame applied to the Motor6D connected to its associated BasePart. The part which is controlled depends on the name of the Pose." }, "@roblox/globaltype/Pose.AddSubPose/param/1": { "documentation": "The Pose to be added." }, "@roblox/globaltype/Pose.AddSubPose": { "documentation": "Adds a sub Pose to the Pose by parenting it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Pose.AddSubPose/param/0" }, { "name": "pose", "documentation": "@roblox/globaltype/Pose.AddSubPose/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pose#AddSubPose", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal pose = Instance.new(\"Pose\")\npose.EasingStyle = Enum.PoseEasingStyle.Cubic\npose.EasingDirection = Enum.PoseEasingDirection.Out\n\nlocal pose2 = Instance.new(\"Pose\")\npose2.EasingStyle = Enum.PoseEasingStyle.Cubic\npose2.EasingDirection = Enum.PoseEasingDirection.Out\n\nkeyframe:AddPose(pose) -- pose.Parent = keyframe\n\ntask.wait(2)\n\nkeyframe:RemovePose(pose) -- pose.Parent = nil\n\ntask.wait(2)\n\nkeyframe:AddPose(pose) -- pose.Parent = keyframe\n\ntask.wait(2)\n\npose:AddSubPose(pose2) -- pose2.Parent = pose\n\ntask.wait(2)\n\npose:RemoveSubPose(pose2) -- pose2.Parent = nil" }, "@roblox/globaltype/Pose.GetSubPoses/param/0": { "documentation": "Holds the CFrame applied to the Motor6D connected to its associated BasePart. The part which is controlled depends on the name of the Pose." }, "@roblox/globaltype/Pose.GetSubPoses/return/0": { "documentation": "An array of sub Poses." }, "@roblox/globaltype/Pose.GetSubPoses": { "documentation": "Returns an array containing all sub Poses that have been added to a Pose.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Pose.GetSubPoses/param/0" } ], "returns": [ "@roblox/globaltype/Pose.GetSubPoses/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pose#GetSubPoses", "code_sample": "" }, "@roblox/globaltype/Pose.RemoveSubPose/param/0": { "documentation": "Holds the CFrame applied to the Motor6D connected to its associated BasePart. The part which is controlled depends on the name of the Pose." }, "@roblox/globaltype/Pose.RemoveSubPose/param/1": { "documentation": "The Pose to be removed." }, "@roblox/globaltype/Pose.RemoveSubPose": { "documentation": "Removes a sub Pose from the Pose by parenting it to nil.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Pose.RemoveSubPose/param/0" }, { "name": "pose", "documentation": "@roblox/globaltype/Pose.RemoveSubPose/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pose#RemoveSubPose", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal pose = Instance.new(\"Pose\")\npose.EasingStyle = Enum.PoseEasingStyle.Cubic\npose.EasingDirection = Enum.PoseEasingDirection.Out\n\nlocal pose2 = Instance.new(\"Pose\")\npose2.EasingStyle = Enum.PoseEasingStyle.Cubic\npose2.EasingDirection = Enum.PoseEasingDirection.Out\n\nkeyframe:AddPose(pose) -- pose.Parent = keyframe\n\ntask.wait(2)\n\nkeyframe:RemovePose(pose) -- pose.Parent = nil\n\ntask.wait(2)\n\nkeyframe:AddPose(pose) -- pose.Parent = keyframe\n\ntask.wait(2)\n\npose:AddSubPose(pose2) -- pose2.Parent = pose\n\ntask.wait(2)\n\npose:RemoveSubPose(pose2) -- pose2.Parent = nil" }, "@roblox/globaltype/AnimationFromVideoCreatorService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationFromVideoCreatorService", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataEvents": { "documentation": "Acts as a Folder containing information about events for a ReflectionMetadataClass, and should be parented to it. ReflectionMetadataMembers that are parented to this object will be perceived as events under the class this is parented to.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataEvents", "code_sample": "" }, "@roblox/globaltype/KeyboardService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyboardService", "code_sample": "" }, "@roblox/globaltype/Teams": { "documentation": "The Teams service holds a game's Team objects. Team objects must be parented to the Teams service.", "keys": { "GetTeams": "@roblox/globaltype/Teams.GetTeams", "RebalanceTeams": "@roblox/globaltype/Teams.RebalanceTeams" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Teams", "code_sample": "" }, "@roblox/globaltype/Teams.GetTeams/param/0": { "documentation": "The Teams service holds a game's Team objects. Team objects must be parented to the Teams service." }, "@roblox/globaltype/Teams.GetTeams/return/0": { "documentation": "An array of Teams in the game." }, "@roblox/globaltype/Teams.GetTeams": { "documentation": "Returns a table containing the game's Team objects. Will only return Team objects that are parented to the Teams service.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Teams.GetTeams/param/0" } ], "returns": [ "@roblox/globaltype/Teams.GetTeams/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Teams#GetTeams", "code_sample": "local Teams = game:GetService(\"Teams\")\n\nlocal teams = Teams:GetTeams()\n\nfor _, team in pairs(teams) do\n\tlocal players = team:GetPlayers()\n\tprint(\"Team\", team.Name, \"has\", #players, \"players\")\nend" }, "@roblox/globaltype/Teams.RebalanceTeams/param/0": { "documentation": "The Teams service holds a game's Team objects. Team objects must be parented to the Teams service." }, "@roblox/globaltype/Teams.RebalanceTeams": { "documentation": "Deprecated: This function has been deprecated and no longer functions correctly. It should not be used. Developers should instead implement their own team sorting systems.
Evens the number of people on each team. This function does not work correctly and should not be used.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Teams.RebalanceTeams/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Teams#RebalanceTeams", "code_sample": "" }, "@roblox/globaltype/AudioCompressor": { "documentation": "Adjusts the dynamic range of input streams.", "keys": { "Attack": "@roblox/globaltype/AudioCompressor.Attack", "Bypass": "@roblox/globaltype/AudioCompressor.Bypass", "MakeupGain": "@roblox/globaltype/AudioCompressor.MakeupGain", "Ratio": "@roblox/globaltype/AudioCompressor.Ratio", "Release": "@roblox/globaltype/AudioCompressor.Release", "Threshold": "@roblox/globaltype/AudioCompressor.Threshold", "GetConnectedWires": "@roblox/globaltype/AudioCompressor.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioCompressor.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioCompressor.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor", "code_sample": "local deviceOutput: AudioDeviceOutput = Instance.new(\"AudioDeviceOutput\")\ndeviceOutput.Parent = workspace\nlocal explosionPlayer: AudioPlayer = Instance.new(\"AudioPlayer\")\nexplosionPlayer.Parent = workspace\nexplosionPlayer.AssetId = \"rbxassetid://1835333184\"\n\nlocal ambiencePlayer = Instance.new(\"AudioPlayer\")\nambiencePlayer.AssetId = \"rbxassetid://9112854440\"\nlocal compressor = Instance.new(\"AudioCompressor\")\nlocal wireToCompressor = Instance.new(\"Wire\")\nlocal wireToSidechain = Instance.new(\"Wire\")\nlocal wireToOutput = Instance.new(\"Wire\")\n\nambiencePlayer.Parent = workspace\ncompressor.Parent = workspace\nwireToCompressor.Parent = workspace\nwireToSidechain.Parent = workspace\nwireToOutput.Parent = workspace\n\nwireToCompressor.SourceInstance = ambiencePlayer\nwireToCompressor.TargetInstance = compressor\n\nwireToSidechain.SourceInstance = explosionPlayer\nwireToSidechain.TargetInstance = compressor\nwireToSidechain.TargetName = \"Sidechain\"\n\nwireToOutput.SourceInstance = compressor\nwireToOutput.TargetInstance = deviceOutput\n\nambiencePlayer:Play()" }, "@roblox/globaltype/AudioCompressor.Attack": { "documentation": "Controls how quickly the compressor will clamp down on volume after it surpasses Threshold.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#Attack", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.MakeupGain": { "documentation": "A gain value to be applied after compression.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#MakeupGain", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.Ratio": { "documentation": "Ratio of input volume to output volume, to be applied when surpassing Threshold.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#Ratio", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.Release": { "documentation": "Controls how quickly the compressor will unclamp after the stream volume dips back below Threshold.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#Release", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.Threshold": { "documentation": "Gain value at which the compressor will start to modify the input stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#Threshold", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.GetConnectedWires/param/0": { "documentation": "Adjusts the dynamic range of input streams." }, "@roblox/globaltype/AudioCompressor.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioCompressor.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioCompressor.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.GetInputPins/param/0": { "documentation": "Adjusts the dynamic range of input streams." }, "@roblox/globaltype/AudioCompressor.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioCompressor.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.GetOutputPins/param/0": { "documentation": "Adjusts the dynamic range of input streams." }, "@roblox/globaltype/AudioCompressor.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioCompressor.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioCompressor.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioCompressor.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioCompressor.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioCompressor.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioCompressor.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioCompressor.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioCompressor.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioCompressor.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioCompressor.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioCompressor.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioCompressor.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioCompressor via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioCompressor.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioCompressor.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioCompressor.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioCompressor.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#WiringChanged", "code_sample": "" }, "@roblox/globaltype/SyncScriptBuilder": { "documentation": "", "keys": { "CompileTarget": "@roblox/globaltype/SyncScriptBuilder.CompileTarget", "CoverageInfo": "@roblox/globaltype/SyncScriptBuilder.CoverageInfo", "DebugInfo": "@roblox/globaltype/SyncScriptBuilder.DebugInfo", "PackAsSource": "@roblox/globaltype/SyncScriptBuilder.PackAsSource", "RawBytecode": "@roblox/globaltype/SyncScriptBuilder.RawBytecode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder", "code_sample": "" }, "@roblox/globaltype/SyncScriptBuilder.CompileTarget": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#CompileTarget", "code_sample": "" }, "@roblox/globaltype/SyncScriptBuilder.CoverageInfo": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#CoverageInfo", "code_sample": "" }, "@roblox/globaltype/SyncScriptBuilder.DebugInfo": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#DebugInfo", "code_sample": "" }, "@roblox/globaltype/SyncScriptBuilder.PackAsSource": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#PackAsSource", "code_sample": "" }, "@roblox/globaltype/SyncScriptBuilder.RawBytecode": { "documentation": "Deprecated: This property should not be used for new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SyncScriptBuilder#RawBytecode", "code_sample": "" }, "@roblox/globaltype/SelectionPartLasso": { "documentation": "Deprecated: SelectionPartLasso has been deprecated. Developers are advised to use the Beam object instead.
An instance used to display a \"lasso\" between a Humanoid Torso and a BasePart.", "keys": { "Part": "@roblox/globaltype/SelectionPartLasso.Part" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionPartLasso", "code_sample": "" }, "@roblox/globaltype/SelectionPartLasso.Part": { "documentation": "Sets the target of the lasso object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionPartLasso#Part", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot": { "documentation": "A snapshot of configuration values at a given version. Can be player-specific.", "keys": { "Error": "@roblox/globaltype/ConfigSnapshot.Error", "Outdated": "@roblox/globaltype/ConfigSnapshot.Outdated", "GetValue": "@roblox/globaltype/ConfigSnapshot.GetValue", "GetValueChangedSignal": "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal", "Refresh": "@roblox/globaltype/ConfigSnapshot.Refresh" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot.Error": { "documentation": "Populated if snapshot was in an error state.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Error", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot.Outdated": { "documentation": "If true, indicates the snapshot is outdated and can be refreshed to newer values.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Outdated", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot.GetValue/param/0": { "documentation": "A snapshot of configuration values at a given version. Can be player-specific." }, "@roblox/globaltype/ConfigSnapshot.GetValue/param/1": { "documentation": "Key of the configuration to get the value for." }, "@roblox/globaltype/ConfigSnapshot.GetValue/return/0": { "documentation": "The value of the configuration for the given key." }, "@roblox/globaltype/ConfigSnapshot.GetValue": { "documentation": "Returns the value for the given key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.GetValue/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/ConfigSnapshot.GetValue/param/1" } ], "returns": [ "@roblox/globaltype/ConfigSnapshot.GetValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal/param/0": { "documentation": "A snapshot of configuration values at a given version. Can be player-specific." }, "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal/param/1": { "documentation": "Key of the configuration to get the change signal for." }, "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal/return/0": { "documentation": "A RBXScriptSignal that fires when the value for the given key changes upon refresh." }, "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal": { "documentation": "Returns a signal that fires when the value for the given key changes due to a refresh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal/param/1" } ], "returns": [ "@roblox/globaltype/ConfigSnapshot.GetValueChangedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot.Refresh/param/0": { "documentation": "A snapshot of configuration values at a given version. Can be player-specific." }, "@roblox/globaltype/ConfigSnapshot.Refresh": { "documentation": "Refreshes the snapshot to the latest configuration values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.Refresh/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh", "code_sample": "" }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ConfigSnapshot.UpdateAvailable": { "documentation": "Fires when a newer version of the configuration is available.", "keys": { "Connect": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Connect", "ConnectParallel": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.ConnectParallel", "Once": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Once", "Wait": "@roblox/globaltype/ConfigSnapshot.UpdateAvailable.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#UpdateAvailable", "code_sample": "" }, "@roblox/globaltype/PlacesService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlacesService", "code_sample": "" }, "@roblox/globaltype/Capture": { "documentation": "A class which defines a piece of content, such as a screenshot or video, taken in-experience.", "keys": { "CaptureTime": "@roblox/globaltype/Capture.CaptureTime", "CaptureType": "@roblox/globaltype/Capture.CaptureType", "FilePathString": "@roblox/globaltype/Capture.FilePathString", "LocalId": "@roblox/globaltype/Capture.LocalId", "SourcePlaceId": "@roblox/globaltype/Capture.SourcePlaceId", "SourceUniverseId": "@roblox/globaltype/Capture.SourceUniverseId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture", "code_sample": "" }, "@roblox/globaltype/Capture.CaptureTime": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture#CaptureTime", "code_sample": "" }, "@roblox/globaltype/Capture.CaptureType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture#CaptureType", "code_sample": "" }, "@roblox/globaltype/Capture.FilePathString": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture#FilePathString", "code_sample": "" }, "@roblox/globaltype/Capture.LocalId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture#LocalId", "code_sample": "" }, "@roblox/globaltype/Capture.SourcePlaceId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture#SourcePlaceId", "code_sample": "" }, "@roblox/globaltype/Capture.SourceUniverseId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Capture#SourceUniverseId", "code_sample": "" }, "@roblox/globaltype/AdvancedDragger": { "documentation": "An unfinished advanced variant of the Dragger class.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdvancedDragger", "code_sample": "" }, "@roblox/globaltype/HopperBin": { "documentation": "Deprecated: This deprecated class has been replaced by Tool. Please use Tool for new work instead.", "keys": { "Active": "@roblox/globaltype/HopperBin.Active", "BinType": "@roblox/globaltype/HopperBin.BinType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HopperBin", "code_sample": "" }, "@roblox/globaltype/HopperBin.Active": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HopperBin#Active", "code_sample": "" }, "@roblox/globaltype/HopperBin.BinType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HopperBin#BinType", "code_sample": "" }, "@roblox/globaltype/HopperBin.Deselected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Deselected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HopperBin.Deselected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Deselected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HopperBin.Deselected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Deselected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Deselected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HopperBin.Deselected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Deselected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HopperBin.Deselected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Deselected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Deselected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HopperBin.Deselected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Deselected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HopperBin.Deselected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Deselected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Deselected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Deselected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Deselected": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/HopperBin.Deselected.Connect", "ConnectParallel": "@roblox/globaltype/HopperBin.Deselected.ConnectParallel", "Once": "@roblox/globaltype/HopperBin.Deselected.Once", "Wait": "@roblox/globaltype/HopperBin.Deselected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HopperBin#Deselected", "code_sample": "" }, "@roblox/globaltype/HopperBin.Selected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Selected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HopperBin.Selected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Selected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HopperBin.Selected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Selected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Selected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HopperBin.Selected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Selected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HopperBin.Selected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Selected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Selected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HopperBin.Selected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Selected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HopperBin.Selected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Selected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HopperBin.Selected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HopperBin.Selected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HopperBin.Selected": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/HopperBin.Selected.Connect", "ConnectParallel": "@roblox/globaltype/HopperBin.Selected.ConnectParallel", "Once": "@roblox/globaltype/HopperBin.Selected.Once", "Wait": "@roblox/globaltype/HopperBin.Selected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HopperBin#Selected", "code_sample": "" }, "@roblox/globaltype/StyleLink": { "documentation": "Links a StyleSheet to the instance tree whose root is the parent of the StyleLink.", "keys": { "StyleSheet": "@roblox/globaltype/StyleLink.StyleSheet" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleLink", "code_sample": "" }, "@roblox/globaltype/StyleLink.StyleSheet": { "documentation": "The StyleSheet to link to the parent such that the parent's descendants are styled accordingly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleLink#StyleSheet", "code_sample": "" }, "@roblox/globaltype/ServiceVisibilityService": { "documentation": "", "keys": { "HiddenServices": "@roblox/globaltype/ServiceVisibilityService.HiddenServices", "VisibleServices": "@roblox/globaltype/ServiceVisibilityService.VisibleServices" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceVisibilityService", "code_sample": "" }, "@roblox/globaltype/ServiceVisibilityService.HiddenServices": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceVisibilityService#HiddenServices", "code_sample": "" }, "@roblox/globaltype/ServiceVisibilityService.VisibleServices": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceVisibilityService#VisibleServices", "code_sample": "" }, "@roblox/globaltype/TextChatMessage": { "documentation": "A data object representing a text chat message.", "keys": { "BubbleChatMessageProperties": "@roblox/globaltype/TextChatMessage.BubbleChatMessageProperties", "ChatWindowMessageProperties": "@roblox/globaltype/TextChatMessage.ChatWindowMessageProperties", "MessageId": "@roblox/globaltype/TextChatMessage.MessageId", "Metadata": "@roblox/globaltype/TextChatMessage.Metadata", "PrefixText": "@roblox/globaltype/TextChatMessage.PrefixText", "Status": "@roblox/globaltype/TextChatMessage.Status", "Text": "@roblox/globaltype/TextChatMessage.Text", "TextChannel": "@roblox/globaltype/TextChatMessage.TextChannel", "TextSource": "@roblox/globaltype/TextChatMessage.TextSource", "Timestamp": "@roblox/globaltype/TextChatMessage.Timestamp", "Translation": "@roblox/globaltype/TextChatMessage.Translation" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.BubbleChatMessageProperties": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#BubbleChatMessageProperties", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.ChatWindowMessageProperties": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#ChatWindowMessageProperties", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.MessageId": { "documentation": "A unique identifier for the TextChatMessage.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#MessageId", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.Metadata": { "documentation": "A general purpose field for storing miscellaneous data about the TextChatMessage.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#Metadata", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.PrefixText": { "documentation": "A prefix to add to a user's message.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#PrefixText", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.Status": { "documentation": "Indicates the status of the TextChatMessage.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#Status", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.Text": { "documentation": "The filtered text message for the user.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#Text", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.TextChannel": { "documentation": "A reference to the origin TextChannel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#TextChannel", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.TextSource": { "documentation": "A reference to the origin TextSource.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#TextSource", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.Timestamp": { "documentation": "A timestamp of when the message was originally sent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#Timestamp", "code_sample": "" }, "@roblox/globaltype/TextChatMessage.Translation": { "documentation": "Translated and filtered text message.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessage#Translation", "code_sample": "" }, "@roblox/globaltype/LayerCollector": { "documentation": "The base class of 2D UI containers which render GuiObjects in layers.", "keys": { "Enabled": "@roblox/globaltype/LayerCollector.Enabled", "ResetOnSpawn": "@roblox/globaltype/LayerCollector.ResetOnSpawn", "ZIndexBehavior": "@roblox/globaltype/LayerCollector.ZIndexBehavior", "GetLayoutNodeTree": "@roblox/globaltype/LayerCollector.GetLayoutNodeTree" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LayerCollector", "code_sample": "" }, "@roblox/globaltype/LayerCollector.Enabled": { "documentation": "Toggles the visibility of this LayerCollector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LayerCollector#Enabled", "code_sample": "" }, "@roblox/globaltype/LayerCollector.ResetOnSpawn": { "documentation": "Determines if the LayerCollector resets (deletes itself and re-clones into the player's PlayerGui) every time the player's character respawns.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LayerCollector#ResetOnSpawn", "code_sample": "" }, "@roblox/globaltype/LayerCollector.ZIndexBehavior": { "documentation": "Controls how GuiObject.ZIndex behaves on all descendants of this LayerCollector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LayerCollector#ZIndexBehavior", "code_sample": "" }, "@roblox/globaltype/LayerCollector.GetLayoutNodeTree/param/0": { "documentation": "The base class of 2D UI containers which render GuiObjects in layers." }, "@roblox/globaltype/LayerCollector.GetLayoutNodeTree/return/0": { "documentation": "" }, "@roblox/globaltype/LayerCollector.GetLayoutNodeTree": { "documentation": "Deprecated: This method should not be used for new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LayerCollector.GetLayoutNodeTree/param/0" } ], "returns": [ "@roblox/globaltype/LayerCollector.GetLayoutNodeTree/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LayerCollector#GetLayoutNodeTree", "code_sample": "" }, "@roblox/globaltype/NumberValue": { "documentation": "A container object for a single double-precision floating point number.", "keys": { "Value": "@roblox/globaltype/NumberValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NumberValue", "code_sample": "-- Demonstrate the Changed event by creating a Part\nlocal part = Instance.new(\"Part\")\npart.Changed:Connect(print)\n-- This fires Changed with \"Transparency\"\npart.Transparency = 0.5\n-- Similarly, this fires Changed with \"Number\"\npart.Name = \"SomePart\"\n-- Since changing BrickColor will also change other\n-- properties at the same time, this line fires Changed\n-- with \"BrickColor\", \"Color3\" and \"Color3uint16\".\npart.BrickColor = BrickColor.Red()\n\n-- A NumberValue holds a double-precision floating-point number\nlocal vNumber = Instance.new(\"NumberValue\")\nvNumber.Changed:Connect(print)\n-- This fires Changed with 123.456 (not \"Value\")\nvNumber.Value = 123.456\n-- This does not fire Changed\nvNumber.Name = \"SomeNumber\"\n\n-- A StringValue stores one string\nlocal vString = Instance.new(\"StringValue\")\nvString.Changed:Connect(print)\n-- This fires Changed with \"Hello\" (not \"Value\")\nvString.Value = \"Hello\"" }, "@roblox/globaltype/NumberValue.Value": { "documentation": "Used to hold a double value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NumberValue#Value", "code_sample": "" }, "@roblox/globaltype/NumberValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NumberValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NumberValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NumberValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NumberValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NumberValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NumberValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NumberValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NumberValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NumberValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NumberValue.Changed": { "documentation": "Fires whenever the NumberValue.Value is changed.", "keys": { "Connect": "@roblox/globaltype/NumberValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/NumberValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/NumberValue.Changed.Once", "Wait": "@roblox/globaltype/NumberValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NumberValue#Changed", "code_sample": "local numberValue = script.Parent.NumberValue\n\nlocal function printValue(value)\n\tprint(value)\nend\n\nnumberValue.Changed:Connect(printValue)\n\nnumberValue.Value = 20" }, "@roblox/globaltype/NumberValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NumberValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NumberValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NumberValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NumberValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NumberValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NumberValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NumberValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NumberValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NumberValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NumberValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NumberValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NumberValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of NumberValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/NumberValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/NumberValue.changed.ConnectParallel", "Once": "@roblox/globaltype/NumberValue.changed.Once", "Wait": "@roblox/globaltype/NumberValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NumberValue#changed", "code_sample": "" }, "@roblox/globaltype/RemoteEvent": { "documentation": "An object which facilitates asynchronous, one-way communication across the client-server boundary. Scripts firing a RemoteEvent do not yield.", "keys": { "FireAllClients": "@roblox/globaltype/RemoteEvent.FireAllClients", "FireClient": "@roblox/globaltype/RemoteEvent.FireClient", "FireServer": "@roblox/globaltype/RemoteEvent.FireServer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteEvent", "code_sample": "" }, "@roblox/globaltype/RemoteEvent.FireAllClients/param/0": { "documentation": "An object which facilitates asynchronous, one-way communication across the client-server boundary. Scripts firing a RemoteEvent do not yield." }, "@roblox/globaltype/RemoteEvent.FireAllClients/param/1": { "documentation": "Values to pass to all OnClientEvent events connected to the same RemoteEvent." }, "@roblox/globaltype/RemoteEvent.FireAllClients": { "documentation": "Fires the OnClientEvent event for each connected client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.FireAllClients/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/RemoteEvent.FireAllClients/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#FireAllClients", "code_sample": "" }, "@roblox/globaltype/RemoteEvent.FireClient/param/0": { "documentation": "An object which facilitates asynchronous, one-way communication across the client-server boundary. Scripts firing a RemoteEvent do not yield." }, "@roblox/globaltype/RemoteEvent.FireClient/param/1": { "documentation": "The client of the Player to fire the event to." }, "@roblox/globaltype/RemoteEvent.FireClient/param/2": { "documentation": "Values to pass to OnClientEvent events connected to the same RemoteEvent." }, "@roblox/globaltype/RemoteEvent.FireClient": { "documentation": "Fires the OnClientEvent event for a specific client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.FireClient/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/RemoteEvent.FireClient/param/1" }, { "name": "arguments", "documentation": "@roblox/globaltype/RemoteEvent.FireClient/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#FireClient", "code_sample": "" }, "@roblox/globaltype/RemoteEvent.FireServer/param/0": { "documentation": "An object which facilitates asynchronous, one-way communication across the client-server boundary. Scripts firing a RemoteEvent do not yield." }, "@roblox/globaltype/RemoteEvent.FireServer/param/1": { "documentation": "Values to pass to OnServerEvent events connected to the same RemoteEvent." }, "@roblox/globaltype/RemoteEvent.FireServer": { "documentation": "Fires the OnServerEvent event on the server from one connected client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.FireServer/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/RemoteEvent.FireServer/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#FireServer", "code_sample": "" }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnClientEvent.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnClientEvent.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RemoteEvent.OnClientEvent.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnClientEvent.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnClientEvent.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnClientEvent": { "documentation": "Fires from a LocalScript when either FireClient() or FireAllClients() is called on the same RemoteEvent instance from a Script.", "keys": { "Connect": "@roblox/globaltype/RemoteEvent.OnClientEvent.Connect", "ConnectParallel": "@roblox/globaltype/RemoteEvent.OnClientEvent.ConnectParallel", "Once": "@roblox/globaltype/RemoteEvent.OnClientEvent.Once", "Wait": "@roblox/globaltype/RemoteEvent.OnClientEvent.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#OnClientEvent", "code_sample": "" }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnServerEvent.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnServerEvent.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RemoteEvent.OnServerEvent.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RemoteEvent.OnServerEvent.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RemoteEvent.OnServerEvent.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RemoteEvent.OnServerEvent": { "documentation": "Fires from a Script when FireServer() is called on the same RemoteEvent instance from a LocalScript.", "keys": { "Connect": "@roblox/globaltype/RemoteEvent.OnServerEvent.Connect", "ConnectParallel": "@roblox/globaltype/RemoteEvent.OnServerEvent.ConnectParallel", "Once": "@roblox/globaltype/RemoteEvent.OnServerEvent.Once", "Wait": "@roblox/globaltype/RemoteEvent.OnServerEvent.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#OnServerEvent", "code_sample": "" }, "@roblox/globaltype/Translator": { "documentation": "The role of a Translator is to manufacture/return strings localized for the viewing player.", "keys": { "LocaleId": "@roblox/globaltype/Translator.LocaleId", "FormatByKey": "@roblox/globaltype/Translator.FormatByKey", "Translate": "@roblox/globaltype/Translator.Translate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Translator", "code_sample": "" }, "@roblox/globaltype/Translator.LocaleId": { "documentation": "The locale of translated strings.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Translator#LocaleId", "code_sample": "" }, "@roblox/globaltype/Translator.FormatByKey/param/0": { "documentation": "The role of a Translator is to manufacture/return strings localized for the viewing player." }, "@roblox/globaltype/Translator.FormatByKey/param/1": { "documentation": "The Key value to look up and translate." }, "@roblox/globaltype/Translator.FormatByKey/param/2": { "documentation": "To be provided if the Source text and translations contain format strings. Will be a Luau table of values or key-value pairs, depending on whether the format strings are numbered or named." }, "@roblox/globaltype/Translator.FormatByKey/return/0": { "documentation": "" }, "@roblox/globaltype/Translator.FormatByKey": { "documentation": "Returns the localized text string in a LocalizationTable based on its Translator locale, by key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Translator.FormatByKey/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Translator.FormatByKey/param/1" }, { "name": "args", "documentation": "@roblox/globaltype/Translator.FormatByKey/param/2" } ], "returns": [ "@roblox/globaltype/Translator.FormatByKey/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Translator#FormatByKey", "code_sample": "" }, "@roblox/globaltype/Translator.Translate/param/0": { "documentation": "The role of a Translator is to manufacture/return strings localized for the viewing player." }, "@roblox/globaltype/Translator.Translate/param/1": { "documentation": "A valid in-game Instance to use for context override as outlined above. Note that this argument can be arbitrary, for example game, if you don't require a context override." }, "@roblox/globaltype/Translator.Translate/param/2": { "documentation": "The Source text to look up and translate." }, "@roblox/globaltype/Translator.Translate/return/0": { "documentation": "The translated text." }, "@roblox/globaltype/Translator.Translate": { "documentation": "Returns the localized text string in a LocalizationTable based on its Translator locale, by source lookup.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Translator.Translate/param/0" }, { "name": "context", "documentation": "@roblox/globaltype/Translator.Translate/param/1" }, { "name": "text", "documentation": "@roblox/globaltype/Translator.Translate/param/2" } ], "returns": [ "@roblox/globaltype/Translator.Translate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Translator#Translate", "code_sample": "" }, "@roblox/globaltype/ValueBase": { "documentation": "Base class of all \"value instance\" objects.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueBase", "code_sample": "" }, "@roblox/globaltype/Tool": { "documentation": "An object, such as a weapon, that can be equipped by a Humanoid.", "keys": { "CanBeDropped": "@roblox/globaltype/Tool.CanBeDropped", "Enabled": "@roblox/globaltype/Tool.Enabled", "Grip": "@roblox/globaltype/Tool.Grip", "GripForward": "@roblox/globaltype/Tool.GripForward", "GripPos": "@roblox/globaltype/Tool.GripPos", "GripRight": "@roblox/globaltype/Tool.GripRight", "GripUp": "@roblox/globaltype/Tool.GripUp", "ManualActivationOnly": "@roblox/globaltype/Tool.ManualActivationOnly", "RequiresHandle": "@roblox/globaltype/Tool.RequiresHandle", "ToolTip": "@roblox/globaltype/Tool.ToolTip", "Activate": "@roblox/globaltype/Tool.Activate", "Deactivate": "@roblox/globaltype/Tool.Deactivate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool", "code_sample": "local tool = script.Parent\n\nlocal function explode(point)\n\tlocal e = Instance.new(\"Explosion\")\n\te.DestroyJointRadiusPercent = 0 -- Make the explosion non-deadly\n\te.Position = point\n\te.Parent = workspace\nend\n\nlocal function onActivated()\n\t-- Get the Humanoid that Activated the tool\n\tlocal human = tool.Parent.Humanoid\n\t-- Call explode with the current point the Humanoid is targetting\n\texplode(human.TargetPoint)\nend\n\ntool.Activated:Connect(onActivated)" }, "@roblox/globaltype/Tool.CanBeDropped": { "documentation": "Controls whether the player can drop the tool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#CanBeDropped", "code_sample": "" }, "@roblox/globaltype/Tool.Enabled": { "documentation": "Relates to whether or not the tool can be used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Enabled", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"SuperJump\"\ntool.RequiresHandle = false\ntool.Parent = player.Backpack\n\nfunction toolActivated()\n\thumanoid.JumpPower = 150\n\ttool.Enabled = false\n\ttask.wait(5)\n\ttool.Enabled = true\n\thumanoid.JumpPower = 50\nend\n\ntool.Activated:Connect(toolActivated)\ntool.Unequipped:Connect(function()\n\thumanoid.JumpPower = 50\nend)" }, "@roblox/globaltype/Tool.Grip": { "documentation": "Stores the tool's \"grip\" properties as one CFrame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Grip", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"Stick\"\ntool.Parent = player.Backpack\n\nlocal handle = Instance.new(\"Part\")\nhandle.Name = \"Handle\"\nhandle.Parent = tool\nhandle.Size = Vector3.new(0.1, 3, 0.1)\nhandle.Color = Color3.fromRGB(108, 88, 75) -- Brown\n\ntool.Activated:Connect(function()\n\tprint(tool.Grip)\n\tprint(tool.GripUp)\n\tprint(tool.GripRight)\n\tprint(tool.GripForward)\n\tprint(tool.GripPos)\nend)" }, "@roblox/globaltype/Tool.GripForward": { "documentation": "Represents the R02, R12, and R22 values of the grip CFrame rotation matrix.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#GripForward", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"Stick\"\ntool.Parent = player.Backpack\n\nlocal handle = Instance.new(\"Part\")\nhandle.Name = \"Handle\"\nhandle.Parent = tool\nhandle.Size = Vector3.new(0.1, 3, 0.1)\nhandle.Color = Color3.fromRGB(108, 88, 75) -- Brown\n\ntool.Activated:Connect(function()\n\tprint(tool.Grip)\n\tprint(tool.GripUp)\n\tprint(tool.GripRight)\n\tprint(tool.GripForward)\n\tprint(tool.GripPos)\nend)" }, "@roblox/globaltype/Tool.GripPos": { "documentation": "The positional offset of the tool's weld matrix.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#GripPos", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"Stick\"\ntool.Parent = player.Backpack\n\nlocal handle = Instance.new(\"Part\")\nhandle.Name = \"Handle\"\nhandle.Parent = tool\nhandle.Size = Vector3.new(0.1, 3, 0.1)\nhandle.Color = Color3.fromRGB(108, 88, 75) -- Brown\n\ntool.Activated:Connect(function()\n\tprint(tool.Grip)\n\tprint(tool.GripUp)\n\tprint(tool.GripRight)\n\tprint(tool.GripForward)\n\tprint(tool.GripPos)\nend)" }, "@roblox/globaltype/Tool.GripRight": { "documentation": "Represents the R00, R10, and R20 values of the grip CFrame rotation matrix.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#GripRight", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"Stick\"\ntool.Parent = player.Backpack\n\nlocal handle = Instance.new(\"Part\")\nhandle.Name = \"Handle\"\nhandle.Parent = tool\nhandle.Size = Vector3.new(0.1, 3, 0.1)\nhandle.Color = Color3.fromRGB(108, 88, 75) -- Brown\n\ntool.Activated:Connect(function()\n\tprint(tool.Grip)\n\tprint(tool.GripUp)\n\tprint(tool.GripRight)\n\tprint(tool.GripForward)\n\tprint(tool.GripPos)\nend)" }, "@roblox/globaltype/Tool.GripUp": { "documentation": "Represents the R01, R11, and R21 values of the grip CFrame rotation matrix.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#GripUp", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"Stick\"\ntool.Parent = player.Backpack\n\nlocal handle = Instance.new(\"Part\")\nhandle.Name = \"Handle\"\nhandle.Parent = tool\nhandle.Size = Vector3.new(0.1, 3, 0.1)\nhandle.Color = Color3.fromRGB(108, 88, 75) -- Brown\n\ntool.Activated:Connect(function()\n\tprint(tool.Grip)\n\tprint(tool.GripUp)\n\tprint(tool.GripRight)\n\tprint(tool.GripForward)\n\tprint(tool.GripPos)\nend)" }, "@roblox/globaltype/Tool.ManualActivationOnly": { "documentation": "Controls whether the Tool can be activated without executing Tool:Activate().", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#ManualActivationOnly", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nlocal tool = Instance.new(\"Tool\")\ntool.Name = \"Sprint\"\ntool.RequiresHandle = false\ntool.Parent = player:WaitForChild(\"Backpack\")\n\nfunction toolActivated()\n\thumanoid.WalkSpeed = 30\n\ttool.ManualActivationOnly = true\n\ttask.wait(5)\n\ttool.ManualActivationOnly = false\n\thumanoid.WalkSpeed = 16\nend\n\ntool.Activated:Connect(toolActivated)\ntool.Unequipped:Connect(function()\n\thumanoid.WalkSpeed = 16\nend)" }, "@roblox/globaltype/Tool.RequiresHandle": { "documentation": "Determines whether a Tool functions without a handle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#RequiresHandle", "code_sample": "" }, "@roblox/globaltype/Tool.ToolTip": { "documentation": "Controls the message displayed when the player's mouse hovers over the tool in their backpack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#ToolTip", "code_sample": "" }, "@roblox/globaltype/Tool.Activate/param/0": { "documentation": "An object, such as a weapon, that can be equipped by a Humanoid." }, "@roblox/globaltype/Tool.Activate": { "documentation": "Simulates activation of the Tool.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Activate/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Activate", "code_sample": "" }, "@roblox/globaltype/Tool.Deactivate/param/0": { "documentation": "An object, such as a weapon, that can be equipped by a Humanoid." }, "@roblox/globaltype/Tool.Deactivate": { "documentation": "Simulates deactivation of the Tool.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Deactivate/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Deactivate", "code_sample": "" }, "@roblox/globaltype/Tool.Activated.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Activated.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Activated.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Activated.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Activated.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Activated.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Activated.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Activated.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Activated.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Activated.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Activated.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Activated.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Activated.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Activated.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Activated.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Activated.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Activated.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Activated.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Tool.Activated": { "documentation": "Fires when the player clicks while the tool is equipped.", "keys": { "Connect": "@roblox/globaltype/Tool.Activated.Connect", "ConnectParallel": "@roblox/globaltype/Tool.Activated.ConnectParallel", "Once": "@roblox/globaltype/Tool.Activated.Once", "Wait": "@roblox/globaltype/Tool.Activated.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Activated", "code_sample": "" }, "@roblox/globaltype/Tool.Deactivated.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Deactivated.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Deactivated.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Deactivated.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Deactivated.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Deactivated.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Deactivated.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Deactivated.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Deactivated.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Deactivated.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Deactivated.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Deactivated.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Deactivated.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Deactivated.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Deactivated.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Deactivated.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Deactivated.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Deactivated.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Tool.Deactivated": { "documentation": "Fires when the player releases their click while the tool is equipped and activated.", "keys": { "Connect": "@roblox/globaltype/Tool.Deactivated.Connect", "ConnectParallel": "@roblox/globaltype/Tool.Deactivated.ConnectParallel", "Once": "@roblox/globaltype/Tool.Deactivated.Once", "Wait": "@roblox/globaltype/Tool.Deactivated.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Deactivated", "code_sample": "" }, "@roblox/globaltype/Tool.Equipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Equipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Equipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Equipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Equipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Equipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Equipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Equipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Equipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Equipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Equipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Equipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Equipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Equipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Equipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Equipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Equipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Equipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Tool.Equipped": { "documentation": "Fires when the tool is equipped.", "keys": { "Connect": "@roblox/globaltype/Tool.Equipped.Connect", "ConnectParallel": "@roblox/globaltype/Tool.Equipped.ConnectParallel", "Once": "@roblox/globaltype/Tool.Equipped.Once", "Wait": "@roblox/globaltype/Tool.Equipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Equipped", "code_sample": "local Tool = script.Parent\n\nlocal function onEquipped(_mouse)\n\tprint(\"The tool was equipped\")\nend\n\nTool.Equipped:Connect(onEquipped)" }, "@roblox/globaltype/Tool.Unequipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Unequipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Unequipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Unequipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Unequipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Unequipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Unequipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Unequipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Unequipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Unequipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Unequipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Unequipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Tool.Unequipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Unequipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Tool.Unequipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Tool.Unequipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Tool.Unequipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Tool.Unequipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Tool.Unequipped": { "documentation": "Fires when the tool is unequipped.", "keys": { "Connect": "@roblox/globaltype/Tool.Unequipped.Connect", "ConnectParallel": "@roblox/globaltype/Tool.Unequipped.ConnectParallel", "Once": "@roblox/globaltype/Tool.Unequipped.Once", "Wait": "@roblox/globaltype/Tool.Unequipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tool#Unequipped", "code_sample": "" }, "@roblox/globaltype/StarterGear": { "documentation": "If the game allows gear, StarterGear contains all of a player's appropriate gear. Whenever the player's character spawns, all of the contents of that player's StarterGear will get copied into the player's Backpack.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterGear", "code_sample": "" }, "@roblox/globaltype/MouseService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MouseService", "code_sample": "" }, "@roblox/globaltype/ColorCorrectionEffect": { "documentation": "Adjusts color-related properties of the rendered world like saturation, tint, brightness, and contrast.", "keys": { "Brightness": "@roblox/globaltype/ColorCorrectionEffect.Brightness", "Contrast": "@roblox/globaltype/ColorCorrectionEffect.Contrast", "Saturation": "@roblox/globaltype/ColorCorrectionEffect.Saturation", "TintColor": "@roblox/globaltype/ColorCorrectionEffect.TintColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorCorrectionEffect", "code_sample": "" }, "@roblox/globaltype/ColorCorrectionEffect.Brightness": { "documentation": "Determines by how much the brightness of pixel colors will be shifted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorCorrectionEffect#Brightness", "code_sample": "" }, "@roblox/globaltype/ColorCorrectionEffect.Contrast": { "documentation": "Determines the change in separation between the dark and light colors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorCorrectionEffect#Contrast", "code_sample": "" }, "@roblox/globaltype/ColorCorrectionEffect.Saturation": { "documentation": "Determines the change in intensity of colors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorCorrectionEffect#Saturation", "code_sample": "" }, "@roblox/globaltype/ColorCorrectionEffect.TintColor": { "documentation": "Determines by how much the RGB channels of pixels are scaled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorCorrectionEffect#TintColor", "code_sample": "" }, "@roblox/globaltype/Seat": { "documentation": "A type of BasePart that characters can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a Weld and the default character scripts will play a sitting animation.", "keys": { "Disabled": "@roblox/globaltype/Seat.Disabled", "Occupant": "@roblox/globaltype/Seat.Occupant", "Sit": "@roblox/globaltype/Seat.Sit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Seat", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal seat = Instance.new(\"Seat\")\nseat.Anchored = true\nseat.Position = Vector3.new(0, 1, 0)\nseat.Parent = workspace\n\nlocal currentPlayer = nil\n\nlocal function onOccupantChanged()\n\tlocal humanoid = seat.Occupant\n\tif humanoid then\n\t\tlocal character = humanoid.Parent\n\t\tlocal player = Players:GetPlayerFromCharacter(character)\n\t\tif player then\n\t\t\tprint(player.Name .. \" has sat down\")\n\t\t\tcurrentPlayer = player\n\t\t\treturn\n\t\tend\n\tend\n\tif currentPlayer then\n\t\tprint(currentPlayer.Name .. \" has got up\")\n\t\tcurrentPlayer = nil\n\tend\nend\n\nseat:GetPropertyChangedSignal(\"Occupant\"):Connect(onOccupantChanged)" }, "@roblox/globaltype/Seat.Disabled": { "documentation": "Whether or not the seat is usable. If set to true, the seat will act as a normal part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Seat#Disabled", "code_sample": "" }, "@roblox/globaltype/Seat.Occupant": { "documentation": "The humanoid that is sitting in the seat.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Seat#Occupant", "code_sample": "" }, "@roblox/globaltype/Seat.Sit/param/0": { "documentation": "A type of BasePart that characters can 'sit' in. When a character touches an enabled Seat object, it will be attached to the part by a Weld and the default character scripts will play a sitting animation." }, "@roblox/globaltype/Seat.Sit/param/1": { "documentation": "" }, "@roblox/globaltype/Seat.Sit": { "documentation": "Forces the character with the specified Humanoid to sit in the Seat.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Seat.Sit/param/0" }, { "name": "humanoid", "documentation": "@roblox/globaltype/Seat.Sit/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Seat#Sit", "code_sample": "" }, "@roblox/globaltype/Trail": { "documentation": "Used to create a trail effect between two attachments.", "keys": { "Attachment0": "@roblox/globaltype/Trail.Attachment0", "Attachment1": "@roblox/globaltype/Trail.Attachment1", "Brightness": "@roblox/globaltype/Trail.Brightness", "Color": "@roblox/globaltype/Trail.Color", "Enabled": "@roblox/globaltype/Trail.Enabled", "FaceCamera": "@roblox/globaltype/Trail.FaceCamera", "Lifetime": "@roblox/globaltype/Trail.Lifetime", "LightEmission": "@roblox/globaltype/Trail.LightEmission", "LightInfluence": "@roblox/globaltype/Trail.LightInfluence", "LocalTransparencyModifier": "@roblox/globaltype/Trail.LocalTransparencyModifier", "MaxLength": "@roblox/globaltype/Trail.MaxLength", "MinLength": "@roblox/globaltype/Trail.MinLength", "Texture": "@roblox/globaltype/Trail.Texture", "TextureLength": "@roblox/globaltype/Trail.TextureLength", "TextureMode": "@roblox/globaltype/Trail.TextureMode", "Transparency": "@roblox/globaltype/Trail.Transparency", "WidthScale": "@roblox/globaltype/Trail.WidthScale", "Clear": "@roblox/globaltype/Trail.Clear" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail", "code_sample": "" }, "@roblox/globaltype/Trail.Attachment0": { "documentation": "Along with Attachment1, determines where the trail will start drawing its segments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Attachment0", "code_sample": "" }, "@roblox/globaltype/Trail.Attachment1": { "documentation": "Along with Attachment0, determines where the trail will start drawing its segments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Attachment1", "code_sample": "" }, "@roblox/globaltype/Trail.Brightness": { "documentation": "Scales the light emitted from the trail when LightInfluence is less than 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Brightness", "code_sample": "" }, "@roblox/globaltype/Trail.Color": { "documentation": "The color of the trail throughout its lifetime.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Color", "code_sample": "" }, "@roblox/globaltype/Trail.Enabled": { "documentation": "Determines whether the trail will be drawn or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Enabled", "code_sample": "" }, "@roblox/globaltype/Trail.FaceCamera": { "documentation": "Determines whether the trail will always face the camera, regardless of its orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#FaceCamera", "code_sample": "" }, "@roblox/globaltype/Trail.Lifetime": { "documentation": "Determines how long each segment in a trail will last, in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Lifetime", "code_sample": "" }, "@roblox/globaltype/Trail.LightEmission": { "documentation": "Determines to what degree the colors of the trail are blended with the colors behind it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#LightEmission", "code_sample": "" }, "@roblox/globaltype/Trail.LightInfluence": { "documentation": "Determines the degree to which the trail is influenced by the environment's lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#LightInfluence", "code_sample": "" }, "@roblox/globaltype/Trail.LocalTransparencyModifier": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Trail.MaxLength": { "documentation": "Sets the maximum length of the trail.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#MaxLength", "code_sample": "" }, "@roblox/globaltype/Trail.MinLength": { "documentation": "Sets the minimum length of the trail.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#MinLength", "code_sample": "" }, "@roblox/globaltype/Trail.Texture": { "documentation": "The content ID of the texture to be displayed on the trail.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Texture", "code_sample": "" }, "@roblox/globaltype/Trail.TextureLength": { "documentation": "Sets the length of the trail's texture, dependent on TextureMode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#TextureLength", "code_sample": "" }, "@roblox/globaltype/Trail.TextureMode": { "documentation": "Determines the manner in which the Texture scales, repeats, and moves along with the trail's attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#TextureMode", "code_sample": "" }, "@roblox/globaltype/Trail.Transparency": { "documentation": "Sets the transparency of the trail's segments over its Lifetime.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Transparency", "code_sample": "" }, "@roblox/globaltype/Trail.WidthScale": { "documentation": "Scales the width of the trail over the course of its lifetime.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#WidthScale", "code_sample": "" }, "@roblox/globaltype/Trail.Clear/param/0": { "documentation": "Used to create a trail effect between two attachments." }, "@roblox/globaltype/Trail.Clear": { "documentation": "Clears the segments of the trail.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Trail.Clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Trail#Clear", "code_sample": "" }, "@roblox/globaltype/SelectionHighlightManager": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionHighlightManager", "code_sample": "" }, "@roblox/globaltype/GuiMain": { "documentation": "Deprecated: This deprecated class is the original name of the ScreenGui. It functions identically to the ScreenGui, and should not be used.
The original name of the ScreenGui.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiMain", "code_sample": "" }, "@roblox/globaltype/Plugin": { "documentation": "", "keys": { "CollisionEnabled": "@roblox/globaltype/Plugin.CollisionEnabled", "DisableUIDragDetectorDrags": "@roblox/globaltype/Plugin.DisableUIDragDetectorDrags", "GridSize": "@roblox/globaltype/Plugin.GridSize", "IsDebuggable": "@roblox/globaltype/Plugin.IsDebuggable", "Activate": "@roblox/globaltype/Plugin.Activate", "CreateDockWidgetPluginGuiAsync": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync", "CreateDockWidgetPluginGui": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui", "CreatePluginAction": "@roblox/globaltype/Plugin.CreatePluginAction", "CreatePluginMenu": "@roblox/globaltype/Plugin.CreatePluginMenu", "CreateToolbar": "@roblox/globaltype/Plugin.CreateToolbar", "Deactivate": "@roblox/globaltype/Plugin.Deactivate", "GetJoinMode": "@roblox/globaltype/Plugin.GetJoinMode", "GetMouse": "@roblox/globaltype/Plugin.GetMouse", "GetSelectedRibbonTool": "@roblox/globaltype/Plugin.GetSelectedRibbonTool", "GetSetting": "@roblox/globaltype/Plugin.GetSetting", "GetStudioUserId": "@roblox/globaltype/Plugin.GetStudioUserId", "ImportFbxAnimationAsync": "@roblox/globaltype/Plugin.ImportFbxAnimationAsync", "ImportFbxAnimation": "@roblox/globaltype/Plugin.ImportFbxAnimation", "ImportFbxRigAsync": "@roblox/globaltype/Plugin.ImportFbxRigAsync", "ImportFbxRig": "@roblox/globaltype/Plugin.ImportFbxRig", "Intersect": "@roblox/globaltype/Plugin.Intersect", "IsActivated": "@roblox/globaltype/Plugin.IsActivated", "IsActivatedWithExclusiveMouse": "@roblox/globaltype/Plugin.IsActivatedWithExclusiveMouse", "Negate": "@roblox/globaltype/Plugin.Negate", "OpenScript": "@roblox/globaltype/Plugin.OpenScript", "OpenWikiPage": "@roblox/globaltype/Plugin.OpenWikiPage", "PromptForExistingAssetIdAsync": "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync", "PromptForExistingAssetId": "@roblox/globaltype/Plugin.PromptForExistingAssetId", "PromptSaveSelectionAsync": "@roblox/globaltype/Plugin.PromptSaveSelectionAsync", "PromptSaveSelection": "@roblox/globaltype/Plugin.PromptSaveSelection", "SaveSelectedToRoblox": "@roblox/globaltype/Plugin.SaveSelectedToRoblox", "SelectRibbonTool": "@roblox/globaltype/Plugin.SelectRibbonTool", "Separate": "@roblox/globaltype/Plugin.Separate", "SetSetting": "@roblox/globaltype/Plugin.SetSetting", "StartDrag": "@roblox/globaltype/Plugin.StartDrag", "Union": "@roblox/globaltype/Plugin.Union" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin", "code_sample": "assert(plugin, \"This script must be run as a plugin!\")\n-- Code beyond this point will execute only if the script is run as a plugin\n\n-- Load the module and pass the plugin reference\nlocal pluginModule = require(script.Parent.PluginModule)\npluginModule:Initialize(plugin)\n\n-- Verify if the plugin reference was initialized\npluginModule:CheckForPluginGlobal()" }, "@roblox/globaltype/Plugin.CollisionEnabled": { "documentation": "Returns whether the user has enabled Collisions in Studio's toolbar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#CollisionEnabled", "code_sample": "" }, "@roblox/globaltype/Plugin.DisableUIDragDetectorDrags": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#DisableUIDragDetectorDrags", "code_sample": "" }, "@roblox/globaltype/Plugin.GridSize": { "documentation": "Returns the grid snapping size the user has set in Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#GridSize", "code_sample": "" }, "@roblox/globaltype/Plugin.IsDebuggable": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#IsDebuggable", "code_sample": "" }, "@roblox/globaltype/Plugin.Activate/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Activate/param/1": { "documentation": "A boolean specifying whether to activate the plugin with exclusive mouse. If true, a PluginMouse can be retrieved via GetMouse()." }, "@roblox/globaltype/Plugin.Activate": { "documentation": "Sets the state of the calling plugin to activated.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Activate/param/0" }, { "name": "exclusiveMouse", "documentation": "@roblox/globaltype/Plugin.Activate/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Activate", "code_sample": "" }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/param/1": { "documentation": "A unique and consistent identifier used to storing the widget's dock state and other internal details." }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/param/2": { "documentation": "Describes the DockWidgetPluginGui to create (initial state, size, etc)." }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync": { "documentation": "Creates a DockWidgetPluginGui given a DockWidgetPluginGuiInfo.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/param/0" }, { "name": "pluginGuiId", "documentation": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/param/1" }, { "name": "dockWidgetPluginGuiInfo", "documentation": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/param/2" } ], "returns": [ "@roblox/globaltype/Plugin.CreateDockWidgetPluginGuiAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGuiAsync", "code_sample": "" }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/param/1": { "documentation": "A unique and consistent identifier used to storing the widget's dock state and other internal details." }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/param/2": { "documentation": "Describes the DockWidgetPluginGui to create (initial state, size, etc)." }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui": { "documentation": "Deprecated: This method has been superseded by CreateDockWidgetPluginGuiAsync().
Creates a DockWidgetPluginGui given a DockWidgetPluginGuiInfo.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/param/0" }, { "name": "pluginGuiId", "documentation": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/param/1" }, { "name": "dockWidgetPluginGuiInfo", "documentation": "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/param/2" } ], "returns": [ "@roblox/globaltype/Plugin.CreateDockWidgetPluginGui/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateDockWidgetPluginGui", "code_sample": "" }, "@roblox/globaltype/Plugin.CreatePluginAction/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreatePluginAction/param/1": { "documentation": "Must be a unique string that identifies this PluginAction from others." }, "@roblox/globaltype/Plugin.CreatePluginAction/param/2": { "documentation": "The displayed name of the action." }, "@roblox/globaltype/Plugin.CreatePluginAction/param/3": { "documentation": "The displayed description of the action." }, "@roblox/globaltype/Plugin.CreatePluginAction/param/4": { "documentation": "The name of the icon used to display the plugin." }, "@roblox/globaltype/Plugin.CreatePluginAction/param/5": { "documentation": "Whether the PluginAction will be hidden from Studio's shortcuts view. Useful for contextual actions. Defaults to true." }, "@roblox/globaltype/Plugin.CreatePluginAction/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreatePluginAction": { "documentation": "Creates a PluginAction which represents a generic performable action in Studio with no directly‑associated PluginToolbarButton.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.CreatePluginAction/param/0" }, { "name": "actionId", "documentation": "@roblox/globaltype/Plugin.CreatePluginAction/param/1" }, { "name": "text", "documentation": "@roblox/globaltype/Plugin.CreatePluginAction/param/2" }, { "name": "statusTip", "documentation": "@roblox/globaltype/Plugin.CreatePluginAction/param/3" }, { "name": "iconName", "documentation": "@roblox/globaltype/Plugin.CreatePluginAction/param/4" }, { "name": "allowBinding", "documentation": "@roblox/globaltype/Plugin.CreatePluginAction/param/5" } ], "returns": [ "@roblox/globaltype/Plugin.CreatePluginAction/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginAction", "code_sample": "local pluginAction = plugin:CreatePluginAction(\n\t\"HelloWorldAction\",\n\t\"Hello World\",\n\t\"Prints a 'Hello world!'\",\n\t\"rbxasset://textures/sparkle.png\",\n\ttrue\n)\npluginAction.Name = \"Test Action\"\n\nlocal function actionTriggered()\n\tprint(\"Hello world!\")\nend\n\npluginAction.Triggered:Connect(actionTriggered)" }, "@roblox/globaltype/Plugin.CreatePluginMenu/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreatePluginMenu/param/1": { "documentation": "Unique ID for the menu." }, "@roblox/globaltype/Plugin.CreatePluginMenu/param/2": { "documentation": "The text to be displayed when used as a submenu." }, "@roblox/globaltype/Plugin.CreatePluginMenu/param/3": { "documentation": "The icon to be displayed when used as a submenu." }, "@roblox/globaltype/Plugin.CreatePluginMenu/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreatePluginMenu": { "documentation": "Creates a new plugin menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.CreatePluginMenu/param/0" }, { "name": "id", "documentation": "@roblox/globaltype/Plugin.CreatePluginMenu/param/1" }, { "name": "title", "documentation": "@roblox/globaltype/Plugin.CreatePluginMenu/param/2" }, { "name": "icon", "documentation": "@roblox/globaltype/Plugin.CreatePluginMenu/param/3" } ], "returns": [ "@roblox/globaltype/Plugin.CreatePluginMenu/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#CreatePluginMenu", "code_sample": "" }, "@roblox/globaltype/Plugin.CreateToolbar/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreateToolbar/param/1": { "documentation": "The visible text on the toolbar, labeling the group of buttons contained within." }, "@roblox/globaltype/Plugin.CreateToolbar/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.CreateToolbar": { "documentation": "Creates a new PluginToolbar with the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.CreateToolbar/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/Plugin.CreateToolbar/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.CreateToolbar/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#CreateToolbar", "code_sample": "plugin:CreateToolbar(\"ExampleToolbar\")" }, "@roblox/globaltype/Plugin.Deactivate/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Deactivate": { "documentation": "Deactivates the plugin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Deactivate/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Deactivate", "code_sample": "" }, "@roblox/globaltype/Plugin.GetJoinMode/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetJoinMode/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetJoinMode": { "documentation": "Returns the JointCreationMode the user has set in Studio's toolbar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.GetJoinMode/param/0" } ], "returns": [ "@roblox/globaltype/Plugin.GetJoinMode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#GetJoinMode", "code_sample": "" }, "@roblox/globaltype/Plugin.GetMouse/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetMouse/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetMouse": { "documentation": "Returns a Mouse that can be used while the plugin is active.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.GetMouse/param/0" } ], "returns": [ "@roblox/globaltype/Plugin.GetMouse/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#GetMouse", "code_sample": "local mouse = plugin:GetMouse()\n\nlocal function button1Down()\n\tprint(\"Button 1 pressed from PluginMouse\")\nend\n\nmouse.Button1Down:Connect(button1Down)" }, "@roblox/globaltype/Plugin.GetSelectedRibbonTool/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetSelectedRibbonTool/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetSelectedRibbonTool": { "documentation": "Returns the currently selected RibbonTool.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.GetSelectedRibbonTool/param/0" } ], "returns": [ "@roblox/globaltype/Plugin.GetSelectedRibbonTool/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#GetSelectedRibbonTool", "code_sample": "plugin:SelectRibbonTool(Enum.RibbonTool.Move, UDim2.new())\ntask.wait() -- wait for next frame\nlocal selectedRibbonTool = plugin:GetSelectedRibbonTool()\nprint(\"The selected RibbonTool is\", selectedRibbonTool)" }, "@roblox/globaltype/Plugin.GetSetting/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetSetting/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.GetSetting/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetSetting": { "documentation": "Retrieves a previously stored value with the given key, or nil if the given key doesn't exist.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.GetSetting/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Plugin.GetSetting/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.GetSetting/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#GetSetting", "code_sample": "local RAN_BEFORE_KEY = \"RanBefore\"\nlocal didRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)\n\nif didRunBefore then\n\tprint(\"Welcome back!\")\nelse\n\tplugin:SetSetting(RAN_BEFORE_KEY, true)\n\tprint(\"Welcome! Thanks for installing this plugin!\")\nend" }, "@roblox/globaltype/Plugin.GetStudioUserId/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetStudioUserId/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.GetStudioUserId": { "documentation": "Deprecated:
Returns the Studio user's userId if they're logged in, otherwise returns 0.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.GetStudioUserId/param/0" } ], "returns": [ "@roblox/globaltype/Plugin.GetStudioUserId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#GetStudioUserId", "code_sample": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/param/2": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimationAsync": { "documentation": "Prompts the user to open a .fbx animation file that can be loaded onto the rigModel, then proceeds to insert the animation as a KeyframeSequence in the Workspace.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/param/0" }, { "name": "rigModel", "documentation": "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/param/1" }, { "name": "isR15", "documentation": "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/param/2" } ], "returns": [ "@roblox/globaltype/Plugin.ImportFbxAnimationAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimationAsync", "code_sample": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimation/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimation/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimation/param/2": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimation/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxAnimation": { "documentation": "Deprecated:
Prompts the user to open a .fbx animation file that can be loaded onto the rigModel, then proceeds to insert the animation as a KeyframeSequence in the Workspace.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.ImportFbxAnimation/param/0" }, { "name": "rigModel", "documentation": "@roblox/globaltype/Plugin.ImportFbxAnimation/param/1" }, { "name": "isR15", "documentation": "@roblox/globaltype/Plugin.ImportFbxAnimation/param/2" } ], "returns": [ "@roblox/globaltype/Plugin.ImportFbxAnimation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxAnimation", "code_sample": "" }, "@roblox/globaltype/Plugin.ImportFbxRigAsync/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxRigAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxRigAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxRigAsync": { "documentation": "Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the Workspace.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.ImportFbxRigAsync/param/0" }, { "name": "isR15", "documentation": "@roblox/globaltype/Plugin.ImportFbxRigAsync/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.ImportFbxRigAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRigAsync", "code_sample": "" }, "@roblox/globaltype/Plugin.ImportFbxRig/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxRig/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxRig/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.ImportFbxRig": { "documentation": "Deprecated: This method has been superseded by ImportFbxRigAsync().
Prompts the user to open a .fbx file, uploads the individual components of the model as meshes, and generates a character rig for use in animation, which is loaded into the Workspace.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.ImportFbxRig/param/0" }, { "name": "isR15", "documentation": "@roblox/globaltype/Plugin.ImportFbxRig/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.ImportFbxRig/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#ImportFbxRig", "code_sample": "" }, "@roblox/globaltype/Plugin.Intersect/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Intersect/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Intersect/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Intersect": { "documentation": "Intersects the given parts and returns the resulting IntersectOperation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Intersect/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Plugin.Intersect/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.Intersect/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Intersect", "code_sample": "" }, "@roblox/globaltype/Plugin.IsActivated/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.IsActivated/return/0": { "documentation": "A boolean indicating whether the plugin is currently active." }, "@roblox/globaltype/Plugin.IsActivated": { "documentation": "Returns true if this plugin is currently active, after having been activated via the Activate() function.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.IsActivated/param/0" } ], "returns": [ "@roblox/globaltype/Plugin.IsActivated/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#IsActivated", "code_sample": "" }, "@roblox/globaltype/Plugin.IsActivatedWithExclusiveMouse/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.IsActivatedWithExclusiveMouse/return/0": { "documentation": "Whether this plugin is currently active with an exclusive mouse." }, "@roblox/globaltype/Plugin.IsActivatedWithExclusiveMouse": { "documentation": "Returns true if this plugin is currently active with an exclusive mouse.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.IsActivatedWithExclusiveMouse/param/0" } ], "returns": [ "@roblox/globaltype/Plugin.IsActivatedWithExclusiveMouse/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#IsActivatedWithExclusiveMouse", "code_sample": "" }, "@roblox/globaltype/Plugin.Negate/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Negate/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Negate/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Negate": { "documentation": "Negates the given parts and returns the resulting NegateOperations.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Negate/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Plugin.Negate/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.Negate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Negate", "code_sample": "" }, "@roblox/globaltype/Plugin.OpenScript/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.OpenScript/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.OpenScript/param/2": { "documentation": "" }, "@roblox/globaltype/Plugin.OpenScript": { "documentation": "Deprecated:
Used to open the given script instance in an editor window, in Roblox studio, at the given line. If no line is given as an argument it will default to 1.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.OpenScript/param/0" }, { "name": "script", "documentation": "@roblox/globaltype/Plugin.OpenScript/param/1" }, { "name": "lineNumber", "documentation": "@roblox/globaltype/Plugin.OpenScript/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenScript", "code_sample": "local newScript = Instance.new(\"Script\")\nnewScript.Parent = workspace\nplugin:OpenScript(newScript)" }, "@roblox/globaltype/Plugin.OpenWikiPage/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.OpenWikiPage/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.OpenWikiPage": { "documentation": "Opens the context help window to the wiki page that url links to.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.OpenWikiPage/param/0" }, { "name": "url", "documentation": "@roblox/globaltype/Plugin.OpenWikiPage/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#OpenWikiPage", "code_sample": "plugin:OpenWikiPage(\"API:Class/BasePart\")" }, "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync": { "documentation": "Opens a window in Roblox Studio which prompts the user to select an asset based on the assetType specified.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync/param/0" }, { "name": "assetType", "documentation": "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.PromptForExistingAssetIdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetIdAsync", "code_sample": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetId/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetId/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetId/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptForExistingAssetId": { "documentation": "Opens a window in Roblox Studio which prompts the user to select an asset based on the assetType specified.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.PromptForExistingAssetId/param/0" }, { "name": "assetType", "documentation": "@roblox/globaltype/Plugin.PromptForExistingAssetId/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.PromptForExistingAssetId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptForExistingAssetId", "code_sample": "" }, "@roblox/globaltype/Plugin.PromptSaveSelectionAsync/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptSaveSelectionAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptSaveSelectionAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptSaveSelectionAsync": { "documentation": "Prompts the user to save their current selection with the specified file name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.PromptSaveSelectionAsync/param/0" }, { "name": "suggestedFileName", "documentation": "@roblox/globaltype/Plugin.PromptSaveSelectionAsync/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.PromptSaveSelectionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelectionAsync", "code_sample": "" }, "@roblox/globaltype/Plugin.PromptSaveSelection/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptSaveSelection/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptSaveSelection/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.PromptSaveSelection": { "documentation": "Deprecated: This method has been superseded by PromptSaveSelectionAsync().
Prompts the user to save their current selection with the specified file name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.PromptSaveSelection/param/0" }, { "name": "suggestedFileName", "documentation": "@roblox/globaltype/Plugin.PromptSaveSelection/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.PromptSaveSelection/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#PromptSaveSelection", "code_sample": "" }, "@roblox/globaltype/Plugin.SaveSelectedToRoblox/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.SaveSelectedToRoblox": { "documentation": "Opens an upload window for the user's current selection.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.SaveSelectedToRoblox/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#SaveSelectedToRoblox", "code_sample": "" }, "@roblox/globaltype/Plugin.SelectRibbonTool/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.SelectRibbonTool/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.SelectRibbonTool/param/2": { "documentation": "" }, "@roblox/globaltype/Plugin.SelectRibbonTool": { "documentation": "Activates the specified Roblox Studio tool.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.SelectRibbonTool/param/0" }, { "name": "tool", "documentation": "@roblox/globaltype/Plugin.SelectRibbonTool/param/1" }, { "name": "position", "documentation": "@roblox/globaltype/Plugin.SelectRibbonTool/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#SelectRibbonTool", "code_sample": "" }, "@roblox/globaltype/Plugin.Separate/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Separate/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Separate/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Separate": { "documentation": "Separates the given UnionOperations and returns the resulting parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Separate/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Plugin.Separate/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.Separate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Separate", "code_sample": "" }, "@roblox/globaltype/Plugin.SetSetting/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.SetSetting/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.SetSetting/param/2": { "documentation": "" }, "@roblox/globaltype/Plugin.SetSetting": { "documentation": "Stores a given value for later use under the given key. The value will persist even after Studio is closed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.SetSetting/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Plugin.SetSetting/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Plugin.SetSetting/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#SetSetting", "code_sample": "local RAN_BEFORE_KEY = \"RunBefore\"\nlocal hasRunBefore = plugin:GetSetting(RAN_BEFORE_KEY)\n\nif hasRunBefore then\n\tprint(\"Welcome back!\")\nelse\n\tprint(\"Thanks for installing this plugin!\")\n\tplugin:SetSetting(RAN_BEFORE_KEY, true)\nend" }, "@roblox/globaltype/Plugin.StartDrag/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.StartDrag/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.StartDrag": { "documentation": "Starts a drag action given a dictionary of parameters.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.StartDrag/param/0" }, { "name": "dragData", "documentation": "@roblox/globaltype/Plugin.StartDrag/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#StartDrag", "code_sample": "" }, "@roblox/globaltype/Plugin.Union/param/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Union/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Union/return/0": { "documentation": "" }, "@roblox/globaltype/Plugin.Union": { "documentation": "Unions the given parts and returns the resulting UnionOperation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Union/param/0" }, { "name": "objects", "documentation": "@roblox/globaltype/Plugin.Union/param/1" } ], "returns": [ "@roblox/globaltype/Plugin.Union/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Union", "code_sample": "" }, "@roblox/globaltype/Plugin.Deactivation.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Deactivation.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Deactivation.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Deactivation.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Plugin.Deactivation.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Plugin.Deactivation.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Deactivation.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Deactivation.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Deactivation.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Plugin.Deactivation.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Plugin.Deactivation.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Deactivation.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Deactivation.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Deactivation.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Plugin.Deactivation.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Plugin.Deactivation.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Deactivation.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Deactivation.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Plugin.Deactivation": { "documentation": "Fired when the plugin is deactivated.", "keys": { "Connect": "@roblox/globaltype/Plugin.Deactivation.Connect", "ConnectParallel": "@roblox/globaltype/Plugin.Deactivation.ConnectParallel", "Once": "@roblox/globaltype/Plugin.Deactivation.Once", "Wait": "@roblox/globaltype/Plugin.Deactivation.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Deactivation", "code_sample": "" }, "@roblox/globaltype/Plugin.Unloading.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Unloading.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Unloading.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Unloading.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Plugin.Unloading.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Plugin.Unloading.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Unloading.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Unloading.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Unloading.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Plugin.Unloading.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Plugin.Unloading.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Unloading.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Plugin.Unloading.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Unloading.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Plugin.Unloading.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Plugin.Unloading.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Plugin.Unloading.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Plugin.Unloading.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Plugin.Unloading": { "documentation": "Fires immediately before the Plugin stops running.", "keys": { "Connect": "@roblox/globaltype/Plugin.Unloading.Connect", "ConnectParallel": "@roblox/globaltype/Plugin.Unloading.ConnectParallel", "Once": "@roblox/globaltype/Plugin.Unloading.Once", "Wait": "@roblox/globaltype/Plugin.Unloading.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Plugin#Unloading", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform": { "documentation": "Deprecated: The SkateboardPlatform object has been deprecated and is no longer supported by Roblox. Developers looking to create skateboards or similar vehicles are advised to program their own systems. Additionally, the VehicleSeat object can be used to quickly create simple vehicles.
A SkateboardPlatform can be used to create a skateboard. When characters get on a skateboard, they are stuck to it until they press the escape key. Until then, the character uses skateboard animations and travels faster than a walking character.", "keys": { "Controller": "@roblox/globaltype/SkateboardPlatform.Controller", "ControllingHumanoid": "@roblox/globaltype/SkateboardPlatform.ControllingHumanoid", "Steer": "@roblox/globaltype/SkateboardPlatform.Steer", "StickyWheels": "@roblox/globaltype/SkateboardPlatform.StickyWheels", "Throttle": "@roblox/globaltype/SkateboardPlatform.Throttle", "ApplySpecificImpulse": "@roblox/globaltype/SkateboardPlatform.ApplySpecificImpulse" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.Controller": { "documentation": "The SkateboardPlatform's active SkateboardController.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#Controller", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.ControllingHumanoid": { "documentation": "The Humanoid that is controlling the SkateboardPlatform.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#ControllingHumanoid", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.Steer": { "documentation": "The direction of movement, tied to the keys A and D. Must be 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#Steer", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.StickyWheels": { "documentation": "If true, wheels won't roll without user input.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#StickyWheels", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.Throttle": { "documentation": "The direction of movement, tied to the keys W and S. Must be an integer 1 (forward), 0 (null), or -1 (reverse). Will refresh back to 0 unless constantly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#Throttle", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.ApplySpecificImpulse/param/0": { "documentation": "Deprecated: The SkateboardPlatform object has been deprecated and is no longer supported by Roblox. Developers looking to create skateboards or similar vehicles are advised to program their own systems. Additionally, the VehicleSeat object can be used to quickly create simple vehicles.
A SkateboardPlatform can be used to create a skateboard. When characters get on a skateboard, they are stuck to it until they press the escape key. Until then, the character uses skateboard animations and travels faster than a walking character." }, "@roblox/globaltype/SkateboardPlatform.ApplySpecificImpulse/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.ApplySpecificImpulse": { "documentation": "Adds ''impulseWorld'' to the SkateboardPlatform's BasePart.Velocity.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.ApplySpecificImpulse/param/0" }, { "name": "impulseWorld", "documentation": "@roblox/globaltype/SkateboardPlatform.ApplySpecificImpulse/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#ApplySpecificImpulse", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.Equipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Equipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.Equipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Equipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Equipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.Equipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Equipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Equipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.Equipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Equipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Equipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Equipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Equipped": { "documentation": "Fired when the skateboard is equipped.", "keys": { "Connect": "@roblox/globaltype/SkateboardPlatform.Equipped.Connect", "ConnectParallel": "@roblox/globaltype/SkateboardPlatform.Equipped.ConnectParallel", "Once": "@roblox/globaltype/SkateboardPlatform.Equipped.Once", "Wait": "@roblox/globaltype/SkateboardPlatform.Equipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#Equipped", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.equipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.equipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.equipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.equipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.equipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.equipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.equipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.equipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.equipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.equipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.equipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.equipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.equipped": { "documentation": "Deprecated: This deprecated event is a variant of SkateboardPlatform.Equipped which has also been deprecated. Neither event should be used in new work.", "keys": { "Connect": "@roblox/globaltype/SkateboardPlatform.equipped.Connect", "ConnectParallel": "@roblox/globaltype/SkateboardPlatform.equipped.ConnectParallel", "Once": "@roblox/globaltype/SkateboardPlatform.equipped.Once", "Wait": "@roblox/globaltype/SkateboardPlatform.equipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#equipped", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.MoveStateChanged": { "documentation": "Fired when the SkateboardPlatform's SkateboardPlatform.ControllingHumanoid changes the force being used on the SkateboardPlatform.", "keys": { "Connect": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Connect", "ConnectParallel": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.ConnectParallel", "Once": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Once", "Wait": "@roblox/globaltype/SkateboardPlatform.MoveStateChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#MoveStateChanged", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Unequipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Unequipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.Unequipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.Unequipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.Unequipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.Unequipped": { "documentation": "Fired whenever the skateboard is unequipped.", "keys": { "Connect": "@roblox/globaltype/SkateboardPlatform.Unequipped.Connect", "ConnectParallel": "@roblox/globaltype/SkateboardPlatform.Unequipped.ConnectParallel", "Once": "@roblox/globaltype/SkateboardPlatform.Unequipped.Once", "Wait": "@roblox/globaltype/SkateboardPlatform.Unequipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#Unequipped", "code_sample": "" }, "@roblox/globaltype/SkateboardPlatform.unequipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.unequipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.unequipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.unequipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.unequipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.unequipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.unequipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.unequipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SkateboardPlatform.unequipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.unequipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SkateboardPlatform.unequipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SkateboardPlatform.unequipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SkateboardPlatform.unequipped": { "documentation": "Deprecated: This deprecated event is a variant of SkateboardPlatform.Unequipped which has also been deprecated. Neither event should be used in new work.", "keys": { "Connect": "@roblox/globaltype/SkateboardPlatform.unequipped.Connect", "ConnectParallel": "@roblox/globaltype/SkateboardPlatform.unequipped.ConnectParallel", "Once": "@roblox/globaltype/SkateboardPlatform.unequipped.Once", "Wait": "@roblox/globaltype/SkateboardPlatform.unequipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SkateboardPlatform#unequipped", "code_sample": "" }, "@roblox/globaltype/TextService": { "documentation": "Service internally responsible for handling the display of text.", "keys": { "FilterAndTranslateStringAsync": "@roblox/globaltype/TextService.FilterAndTranslateStringAsync", "FilterStringAsync": "@roblox/globaltype/TextService.FilterStringAsync", "GetFamilyInfoAsync": "@roblox/globaltype/TextService.GetFamilyInfoAsync", "GetTextBoundsAsync": "@roblox/globaltype/TextService.GetTextBoundsAsync", "GetTextSize": "@roblox/globaltype/TextService.GetTextSize", "GetTextSizeOffsetAsync": "@roblox/globaltype/TextService.GetTextSizeOffsetAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService", "code_sample": "" }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/0": { "documentation": "Service internally responsible for handling the display of text." }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/1": { "documentation": "" }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/2": { "documentation": "" }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/3": { "documentation": "" }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/4": { "documentation": "" }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/return/0": { "documentation": "" }, "@roblox/globaltype/TextService.FilterAndTranslateStringAsync": { "documentation": "Filters and translates a string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/0" }, { "name": "stringToFilter", "documentation": "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/1" }, { "name": "fromUserId", "documentation": "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/2" }, { "name": "targetLocales", "documentation": "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/3" }, { "name": "textContext", "documentation": "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/param/4" } ], "returns": [ "@roblox/globaltype/TextService.FilterAndTranslateStringAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService#FilterAndTranslateStringAsync", "code_sample": "" }, "@roblox/globaltype/TextService.FilterStringAsync/param/0": { "documentation": "Service internally responsible for handling the display of text." }, "@roblox/globaltype/TextService.FilterStringAsync/param/1": { "documentation": "The text to be filtered." }, "@roblox/globaltype/TextService.FilterStringAsync/param/2": { "documentation": "The Player.UserId of the player filtering the text." }, "@roblox/globaltype/TextService.FilterStringAsync/param/3": { "documentation": "The context that the filtered message will be used in. This parameter does not impact the filtered result of the query and is only used to improve Roblox's text filtering." }, "@roblox/globaltype/TextService.FilterStringAsync/return/0": { "documentation": "" }, "@roblox/globaltype/TextService.FilterStringAsync": { "documentation": "Filters a string being received from a user and returns a TextFilterResult which can be used to distribute the correctly filtered text accordingly.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextService.FilterStringAsync/param/0" }, { "name": "stringToFilter", "documentation": "@roblox/globaltype/TextService.FilterStringAsync/param/1" }, { "name": "fromUserId", "documentation": "@roblox/globaltype/TextService.FilterStringAsync/param/2" }, { "name": "textContext", "documentation": "@roblox/globaltype/TextService.FilterStringAsync/param/3" } ], "returns": [ "@roblox/globaltype/TextService.FilterStringAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService#FilterStringAsync", "code_sample": "" }, "@roblox/globaltype/TextService.GetFamilyInfoAsync/param/0": { "documentation": "Service internally responsible for handling the display of text." }, "@roblox/globaltype/TextService.GetFamilyInfoAsync/param/1": { "documentation": "Asset ID of the font family to look up." }, "@roblox/globaltype/TextService.GetFamilyInfoAsync/return/0": { "documentation": "The information about the font family." }, "@roblox/globaltype/TextService.GetFamilyInfoAsync": { "documentation": "Returns a table containing the name and faces of a font family.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextService.GetFamilyInfoAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/TextService.GetFamilyInfoAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextService.GetFamilyInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService#GetFamilyInfoAsync", "code_sample": "local TextService = game:GetService(\"TextService\")\n\nlocal familyToCheck = \"rbxasset://fonts/families/Arimo.json\"\n\nlocal success, info = pcall(function()\n\treturn TextService:GetFamilyInfoAsync(familyToCheck)\nend)\nif success then\n\tprint(\"Name of the font:\", info.Name)\n\tprint(\"Faces:\")\n\tfor _, face in info.Faces do\n\t\tprint(\"--------\")\n\t\tprint(\"Name:\", face.Name)\n\t\tprint(\"Weight:\", face.Weight.Name)\n\t\tprint(\"Style:\", face.Style.Name)\n\tend\nend" }, "@roblox/globaltype/TextService.GetTextBoundsAsync/param/0": { "documentation": "Service internally responsible for handling the display of text." }, "@roblox/globaltype/TextService.GetTextBoundsAsync/param/1": { "documentation": "A reference to a GetTextBoundsParams object." }, "@roblox/globaltype/TextService.GetTextBoundsAsync/return/0": { "documentation": "The size of the text as a Vector2." }, "@roblox/globaltype/TextService.GetTextBoundsAsync": { "documentation": "Computes the Vector2 dimensions (in pixels) that will be taken up with text when using a GetTextBoundsParams object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextService.GetTextBoundsAsync/param/0" }, { "name": "params", "documentation": "@roblox/globaltype/TextService.GetTextBoundsAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextService.GetTextBoundsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextBoundsAsync", "code_sample": "" }, "@roblox/globaltype/TextService.GetTextSize/param/0": { "documentation": "Service internally responsible for handling the display of text." }, "@roblox/globaltype/TextService.GetTextSize/param/1": { "documentation": "The string for which the text size is to be calculated." }, "@roblox/globaltype/TextService.GetTextSize/param/2": { "documentation": "The integer representing the font size used. Does not accept an FontSize value." }, "@roblox/globaltype/TextService.GetTextSize/param/3": { "documentation": "The font used." }, "@roblox/globaltype/TextService.GetTextSize/param/4": { "documentation": "The GuiBase2d.AbsoluteSize of the text object to be used. Required to compute how the text will wrap." }, "@roblox/globaltype/TextService.GetTextSize/return/0": { "documentation": "The size of the space required, in pixels, by the string with the specified formatting." }, "@roblox/globaltype/TextService.GetTextSize": { "documentation": "Computes the Vector2 dimensions (in pixels) that will be taken up with text when using the specified formatting parameters and size constraints.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextService.GetTextSize/param/0" }, { "name": "string", "documentation": "@roblox/globaltype/TextService.GetTextSize/param/1" }, { "name": "fontSize", "documentation": "@roblox/globaltype/TextService.GetTextSize/param/2" }, { "name": "font", "documentation": "@roblox/globaltype/TextService.GetTextSize/param/3" }, { "name": "frameSize", "documentation": "@roblox/globaltype/TextService.GetTextSize/param/4" } ], "returns": [ "@roblox/globaltype/TextService.GetTextSize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextSize", "code_sample": "local TextService = game:GetService(\"TextService\")\n\nlocal function getTextBounds()\n\tlocal message = \"Hello world!\"\n\tlocal size = Vector2.new(1, 1)\n\tlocal bounds = TextService:GetTextSize(message, 12, \"SourceSans\", size)\n\treturn bounds\nend\n\nprint(getTextBounds())" }, "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/param/0": { "documentation": "Service internally responsible for handling the display of text." }, "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/param/1": { "documentation": "" }, "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/param/2": { "documentation": "" }, "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/return/0": { "documentation": "" }, "@roblox/globaltype/TextService.GetTextSizeOffsetAsync": { "documentation": "Returns the offset used to up-scale text based on the current GuiService.PreferredTextSize setting.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/param/0" }, { "name": "fontSize", "documentation": "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/param/1" }, { "name": "font", "documentation": "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/param/2" } ], "returns": [ "@roblox/globaltype/TextService.GetTextSizeOffsetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextService#GetTextSizeOffsetAsync", "code_sample": "" }, "@roblox/globaltype/Clothing": { "documentation": "Clothing is the base class for the Shirt and Pants clothing objects.", "keys": { "Color3": "@roblox/globaltype/Clothing.Color3" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clothing", "code_sample": "" }, "@roblox/globaltype/Clothing.Color3": { "documentation": "Determines the colorization to be applied to the Clothing texture.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clothing#Color3", "code_sample": "" }, "@roblox/globaltype/StyleBase": { "documentation": "The base class for StyleSheet and StyleRule.", "keys": { "GetStyleRules": "@roblox/globaltype/StyleBase.GetStyleRules", "InsertStyleRule": "@roblox/globaltype/StyleBase.InsertStyleRule", "SetStyleRules": "@roblox/globaltype/StyleBase.SetStyleRules" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleBase", "code_sample": "" }, "@roblox/globaltype/StyleBase.GetStyleRules/param/0": { "documentation": "The base class for StyleSheet and StyleRule." }, "@roblox/globaltype/StyleBase.GetStyleRules/return/0": { "documentation": "Array of StyleRules." }, "@roblox/globaltype/StyleBase.GetStyleRules": { "documentation": "Returns an array of associated StyleRules.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.GetStyleRules/param/0" } ], "returns": [ "@roblox/globaltype/StyleBase.GetStyleRules/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleBase#GetStyleRules", "code_sample": "" }, "@roblox/globaltype/StyleBase.InsertStyleRule/param/0": { "documentation": "The base class for StyleSheet and StyleRule." }, "@roblox/globaltype/StyleBase.InsertStyleRule/param/1": { "documentation": "The StyleRule to insert." }, "@roblox/globaltype/StyleBase.InsertStyleRule/param/2": { "documentation": "The number to set the rule's Priority to." }, "@roblox/globaltype/StyleBase.InsertStyleRule": { "documentation": "Inserts a new StyleRule into the array of rules.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.InsertStyleRule/param/0" }, { "name": "rule", "documentation": "@roblox/globaltype/StyleBase.InsertStyleRule/param/1" }, { "name": "priority", "documentation": "@roblox/globaltype/StyleBase.InsertStyleRule/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleBase#InsertStyleRule", "code_sample": "" }, "@roblox/globaltype/StyleBase.SetStyleRules/param/0": { "documentation": "The base class for StyleSheet and StyleRule." }, "@roblox/globaltype/StyleBase.SetStyleRules/param/1": { "documentation": "Array of StyleRules to set." }, "@roblox/globaltype/StyleBase.SetStyleRules": { "documentation": "Similar to InsertStyleRule() but lets you declare and set multiple StyleRules at once.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.SetStyleRules/param/0" }, { "name": "rules", "documentation": "@roblox/globaltype/StyleBase.SetStyleRules/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleBase#SetStyleRules", "code_sample": "" }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/StyleBase.StyleRulesChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StyleBase.StyleRulesChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/StyleBase.StyleRulesChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StyleBase.StyleRulesChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleBase.StyleRulesChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/StyleBase.StyleRulesChanged": { "documentation": "Fires when one or more StyleRules is explicitly changed on the connected StyleSheet or StyleRule.", "keys": { "Connect": "@roblox/globaltype/StyleBase.StyleRulesChanged.Connect", "ConnectParallel": "@roblox/globaltype/StyleBase.StyleRulesChanged.ConnectParallel", "Once": "@roblox/globaltype/StyleBase.StyleRulesChanged.Once", "Wait": "@roblox/globaltype/StyleBase.StyleRulesChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleBase#StyleRulesChanged", "code_sample": "" }, "@roblox/globaltype/DataStoreSetOptions": { "documentation": "Specifies additional parameters for a GlobalDataStore:SetAsync() call.", "keys": { "GetMetadata": "@roblox/globaltype/DataStoreSetOptions.GetMetadata", "SetMetadata": "@roblox/globaltype/DataStoreSetOptions.SetMetadata" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreSetOptions", "code_sample": "" }, "@roblox/globaltype/DataStoreSetOptions.GetMetadata/param/0": { "documentation": "Specifies additional parameters for a GlobalDataStore:SetAsync() call." }, "@roblox/globaltype/DataStoreSetOptions.GetMetadata/return/0": { "documentation": "Metadata associated with this DataStoreSetOptions instance." }, "@roblox/globaltype/DataStoreSetOptions.GetMetadata": { "documentation": "Gets the custom metadata set with this DataStoreSetOptions instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreSetOptions.GetMetadata/param/0" } ], "returns": [ "@roblox/globaltype/DataStoreSetOptions.GetMetadata/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreSetOptions#GetMetadata", "code_sample": "" }, "@roblox/globaltype/DataStoreSetOptions.SetMetadata/param/0": { "documentation": "Specifies additional parameters for a GlobalDataStore:SetAsync() call." }, "@roblox/globaltype/DataStoreSetOptions.SetMetadata/param/1": { "documentation": "Metadata values to set for the key." }, "@roblox/globaltype/DataStoreSetOptions.SetMetadata": { "documentation": "Sets custom metadata to be associated with the key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreSetOptions.SetMetadata/param/0" }, { "name": "attributes", "documentation": "@roblox/globaltype/DataStoreSetOptions.SetMetadata/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreSetOptions#SetMetadata", "code_sample": "" }, "@roblox/globaltype/TextButton": { "documentation": "A 2D user interface element that displays interactive text.", "keys": { "ContentText": "@roblox/globaltype/TextButton.ContentText", "Font": "@roblox/globaltype/TextButton.Font", "FontFace": "@roblox/globaltype/TextButton.FontFace", "FontSize": "@roblox/globaltype/TextButton.FontSize", "LineHeight": "@roblox/globaltype/TextButton.LineHeight", "LocalizedText": "@roblox/globaltype/TextButton.LocalizedText", "MaxVisibleGraphemes": "@roblox/globaltype/TextButton.MaxVisibleGraphemes", "OpenTypeFeatures": "@roblox/globaltype/TextButton.OpenTypeFeatures", "OpenTypeFeaturesError": "@roblox/globaltype/TextButton.OpenTypeFeaturesError", "RichText": "@roblox/globaltype/TextButton.RichText", "Text": "@roblox/globaltype/TextButton.Text", "TextBounds": "@roblox/globaltype/TextButton.TextBounds", "TextColor": "@roblox/globaltype/TextButton.TextColor", "TextColor3": "@roblox/globaltype/TextButton.TextColor3", "TextDirection": "@roblox/globaltype/TextButton.TextDirection", "TextFits": "@roblox/globaltype/TextButton.TextFits", "TextScaled": "@roblox/globaltype/TextButton.TextScaled", "TextSize": "@roblox/globaltype/TextButton.TextSize", "TextStrokeColor3": "@roblox/globaltype/TextButton.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/TextButton.TextStrokeTransparency", "TextTransparency": "@roblox/globaltype/TextButton.TextTransparency", "TextTruncate": "@roblox/globaltype/TextButton.TextTruncate", "TextWrap": "@roblox/globaltype/TextButton.TextWrap", "TextWrapped": "@roblox/globaltype/TextButton.TextWrapped", "TextXAlignment": "@roblox/globaltype/TextButton.TextXAlignment", "TextYAlignment": "@roblox/globaltype/TextButton.TextYAlignment" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton", "code_sample": "" }, "@roblox/globaltype/TextButton.ContentText": { "documentation": "A copy of TextButton.Text that contains exactly what is being rendered by the TextButton.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#ContentText", "code_sample": "" }, "@roblox/globaltype/TextButton.Font": { "documentation": "Determines the font used to render text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#Font", "code_sample": "local frame = script.Parent\n\n-- Create a TextLabel displaying each font\nfor _, font in pairs(Enum.Font:GetEnumItems()) do\n\tlocal textLabel = Instance.new(\"TextLabel\")\n\ttextLabel.Name = font.Name\n\t-- Set the text properties\n\ttextLabel.Text = font.Name\n\ttextLabel.Font = font\n\t-- Some rendering properties\n\ttextLabel.TextSize = 24\n\ttextLabel.TextXAlignment = Enum.TextXAlignment.Left\n\t-- Size the frame equal to the height of the text\n\ttextLabel.Size = UDim2.new(1, 0, 0, textLabel.TextSize)\n\t-- Add to the parent frame\n\ttextLabel.Parent = frame\nend\n\n-- Layout the frames in a list (if they aren't already)\nif not frame:FindFirstChildOfClass(\"UIListLayout\") then\n\tlocal uiListLayout = Instance.new(\"UIListLayout\")\n\tuiListLayout.Parent = frame\nend" }, "@roblox/globaltype/TextButton.FontFace": { "documentation": "Determines the font used to render text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#FontFace", "code_sample": "" }, "@roblox/globaltype/TextButton.FontSize": { "documentation": "Deprecated: This property is deprecated in favor of TextSize which is an integer and not an enum and thus offers far more options for sizes.
Determines the font size to be used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#FontSize", "code_sample": "" }, "@roblox/globaltype/TextButton.LineHeight": { "documentation": "Scales the spacing between lines of text in the TextButton.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#LineHeight", "code_sample": "" }, "@roblox/globaltype/TextButton.LocalizedText": { "documentation": "Sets whether a TextButton should be GuiBase2d.Localize or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#LocalizedText", "code_sample": "" }, "@roblox/globaltype/TextButton.MaxVisibleGraphemes": { "documentation": "The maximum number of graphemes the TextButton can show.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#MaxVisibleGraphemes", "code_sample": "" }, "@roblox/globaltype/TextButton.OpenTypeFeatures": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#OpenTypeFeatures", "code_sample": "" }, "@roblox/globaltype/TextButton.OpenTypeFeaturesError": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#OpenTypeFeaturesError", "code_sample": "" }, "@roblox/globaltype/TextButton.RichText": { "documentation": "Determines whether the TextButton renders its text using rich text formatting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#RichText", "code_sample": "" }, "@roblox/globaltype/TextButton.Text": { "documentation": "Determines the string rendered by the TextButton.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#Text", "code_sample": "" }, "@roblox/globaltype/TextButton.TextBounds": { "documentation": "Read-only property which reflects the absolute size of rendered text in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextBounds", "code_sample": "" }, "@roblox/globaltype/TextButton.TextColor": { "documentation": "Deprecated: This item has been superseded by TextButton.TextColor3 which should be used in all new work.
Determines the color of text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextColor", "code_sample": "" }, "@roblox/globaltype/TextButton.TextColor3": { "documentation": "Determines the color of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextColor3", "code_sample": "-- Place this code in a LocalScript within a TextLabel/TextButton\nlocal textLabel = script.Parent\n\n-- Some colors we'll use with TextColor3\nlocal colorNormal = Color3.new(0, 0, 0) -- black\nlocal colorSoon = Color3.new(1, 0.5, 0.5) -- red\nlocal colorDone = Color3.new(0.5, 1, 0.5) -- green\n\n-- Loop infinitely\nwhile true do\n\t-- Count backwards from 10 to 1\n\tfor i = 10, 1, -1 do\n\t\t-- Set the text\n\t\ttextLabel.Text = \"Time: \" .. i\n\t\t-- Set the color based on how much time is left\n\t\tif i > 3 then\n\t\t\ttextLabel.TextColor3 = colorNormal\n\t\telse\n\t\t\ttextLabel.TextColor3 = colorSoon\n\t\tend\n\t\ttask.wait(1)\n\tend\n\ttextLabel.Text = \"GO!\"\n\ttextLabel.TextColor3 = colorDone\n\ttask.wait(2)\nend" }, "@roblox/globaltype/TextButton.TextDirection": { "documentation": "Direction in which the text is rendered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextDirection", "code_sample": "" }, "@roblox/globaltype/TextButton.TextFits": { "documentation": "A boolean representation of whether the button's text fits within the size of it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextFits", "code_sample": "" }, "@roblox/globaltype/TextButton.TextScaled": { "documentation": "Changes whether text is resized to fit within the TextButton.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextScaled", "code_sample": "" }, "@roblox/globaltype/TextButton.TextSize": { "documentation": "Determines the line height of text in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextSize", "code_sample": "" }, "@roblox/globaltype/TextButton.TextStrokeColor3": { "documentation": "Determines the color of the text stroke (outline).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/TextButton.TextStrokeTransparency": { "documentation": "Determines the transparency of the text stroke (outline).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/TextButton.TextTransparency": { "documentation": "Determines the transparency of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextTransparency", "code_sample": "" }, "@roblox/globaltype/TextButton.TextTruncate": { "documentation": "Controls the truncation of the text displayed in the TextButton.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextTruncate", "code_sample": "" }, "@roblox/globaltype/TextButton.TextWrap": { "documentation": "Deprecated: This item has been superseded by TextButton.TextWrapped which should be used in all new work.
Determines whether or not text should wrap at the edges of the TextButton element's space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextWrap", "code_sample": "" }, "@roblox/globaltype/TextButton.TextWrapped": { "documentation": "Determines if text wraps to multiple lines within the TextButton element's space, truncating excess text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextWrapped", "code_sample": "" }, "@roblox/globaltype/TextButton.TextXAlignment": { "documentation": "Determines the horizontal alignment of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextXAlignment", "code_sample": "" }, "@roblox/globaltype/TextButton.TextYAlignment": { "documentation": "Determines the vertical alignment of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextButton#TextYAlignment", "code_sample": "" }, "@roblox/globaltype/Lighting": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects.", "keys": { "Ambient": "@roblox/globaltype/Lighting.Ambient", "Brightness": "@roblox/globaltype/Lighting.Brightness", "ClockTime": "@roblox/globaltype/Lighting.ClockTime", "ColorShift_Bottom": "@roblox/globaltype/Lighting.ColorShift_Bottom", "ColorShift_Top": "@roblox/globaltype/Lighting.ColorShift_Top", "EnvironmentDiffuseScale": "@roblox/globaltype/Lighting.EnvironmentDiffuseScale", "EnvironmentSpecularScale": "@roblox/globaltype/Lighting.EnvironmentSpecularScale", "ExposureCompensation": "@roblox/globaltype/Lighting.ExposureCompensation", "ExtendLightRangeTo120": "@roblox/globaltype/Lighting.ExtendLightRangeTo120", "FogColor": "@roblox/globaltype/Lighting.FogColor", "FogEnd": "@roblox/globaltype/Lighting.FogEnd", "FogStart": "@roblox/globaltype/Lighting.FogStart", "GeographicLatitude": "@roblox/globaltype/Lighting.GeographicLatitude", "GlobalShadows": "@roblox/globaltype/Lighting.GlobalShadows", "LightingStyle": "@roblox/globaltype/Lighting.LightingStyle", "OutdoorAmbient": "@roblox/globaltype/Lighting.OutdoorAmbient", "Outlines": "@roblox/globaltype/Lighting.Outlines", "PrioritizeLightingQuality": "@roblox/globaltype/Lighting.PrioritizeLightingQuality", "ShadowColor": "@roblox/globaltype/Lighting.ShadowColor", "ShadowSoftness": "@roblox/globaltype/Lighting.ShadowSoftness", "Technology": "@roblox/globaltype/Lighting.Technology", "TimeOfDay": "@roblox/globaltype/Lighting.TimeOfDay", "GetMinutesAfterMidnight": "@roblox/globaltype/Lighting.GetMinutesAfterMidnight", "getMinutesAfterMidnight": "@roblox/globaltype/Lighting.getMinutesAfterMidnight", "GetMoonDirection": "@roblox/globaltype/Lighting.GetMoonDirection", "GetMoonPhase": "@roblox/globaltype/Lighting.GetMoonPhase", "GetSunDirection": "@roblox/globaltype/Lighting.GetSunDirection", "SetMinutesAfterMidnight": "@roblox/globaltype/Lighting.SetMinutesAfterMidnight", "setMinutesAfterMidnight": "@roblox/globaltype/Lighting.setMinutesAfterMidnight" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting", "code_sample": "" }, "@roblox/globaltype/Lighting.Ambient": { "documentation": "The lighting hue applied to areas that are occluded from the sky, such as indoor areas.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#Ambient", "code_sample": "" }, "@roblox/globaltype/Lighting.Brightness": { "documentation": "The intensity of illumination in the place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#Brightness", "code_sample": "" }, "@roblox/globaltype/Lighting.ClockTime": { "documentation": "A numerical representation (in hours) of the current time of day used by Lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ClockTime", "code_sample": "" }, "@roblox/globaltype/Lighting.ColorShift_Bottom": { "documentation": "The hue represented in light reflected in the opposite surfaces to those facing the sun or moon.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ColorShift_Bottom", "code_sample": "" }, "@roblox/globaltype/Lighting.ColorShift_Top": { "documentation": "The hue represented in light reflected from surfaces facing the sun or moon.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ColorShift_Top", "code_sample": "" }, "@roblox/globaltype/Lighting.EnvironmentDiffuseScale": { "documentation": "Ambient light that is derived from the environment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#EnvironmentDiffuseScale", "code_sample": "" }, "@roblox/globaltype/Lighting.EnvironmentSpecularScale": { "documentation": "Specular light derived from environment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#EnvironmentSpecularScale", "code_sample": "" }, "@roblox/globaltype/Lighting.ExposureCompensation": { "documentation": "The exposure compensation value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ExposureCompensation", "code_sample": "" }, "@roblox/globaltype/Lighting.ExtendLightRangeTo120": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ExtendLightRangeTo120", "code_sample": "" }, "@roblox/globaltype/Lighting.FogColor": { "documentation": "A Color3 value giving the hue of Lighting fog.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#FogColor", "code_sample": "" }, "@roblox/globaltype/Lighting.FogEnd": { "documentation": "The depth from the Workspace.CurrentCamera, in studs, at which fog will be completely opaque.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#FogEnd", "code_sample": "" }, "@roblox/globaltype/Lighting.FogStart": { "documentation": "The depth from the Workspace.CurrentCamera, in studs, at which fog begins to show.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#FogStart", "code_sample": "" }, "@roblox/globaltype/Lighting.GeographicLatitude": { "documentation": "The geographic latitude, in degrees, of the scene, influencing the result of Lighting time on the position of the sun and moon.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#GeographicLatitude", "code_sample": "" }, "@roblox/globaltype/Lighting.GlobalShadows": { "documentation": "Toggles voxel-based dynamic lighting for the place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#GlobalShadows", "code_sample": "" }, "@roblox/globaltype/Lighting.LightingStyle": { "documentation": "The artistic intent behind lighting in the experience.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#LightingStyle", "code_sample": "" }, "@roblox/globaltype/Lighting.OutdoorAmbient": { "documentation": "The lighting hue applied to outdoor areas.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#OutdoorAmbient", "code_sample": "" }, "@roblox/globaltype/Lighting.Outlines": { "documentation": "Deprecated: This item is no longer supported as the outlines feature was removed from the Roblox platform.
Determines whether outlines are enabled or disabled in a place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#Outlines", "code_sample": "" }, "@roblox/globaltype/Lighting.PrioritizeLightingQuality": { "documentation": "Indicates whether you prefer lighting/shading quality or view distance to scale down first.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#PrioritizeLightingQuality", "code_sample": "" }, "@roblox/globaltype/Lighting.ShadowColor": { "documentation": "Deprecated: This item is deprecated and has no current functionality. Do not use it for new work.
This is supposed to change the color of player shadows, but currently doesn't do anything.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ShadowColor", "code_sample": "" }, "@roblox/globaltype/Lighting.ShadowSoftness": { "documentation": "Controls how blurry the shadows are.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#ShadowSoftness", "code_sample": "" }, "@roblox/globaltype/Lighting.Technology": { "documentation": "Determines the lighting system for rendering the 3D world. Non-scriptable.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#Technology", "code_sample": "" }, "@roblox/globaltype/Lighting.TimeOfDay": { "documentation": "A 24-hour string representation of the current time of day used by Lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#TimeOfDay", "code_sample": "" }, "@roblox/globaltype/Lighting.GetMinutesAfterMidnight/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.GetMinutesAfterMidnight/return/0": { "documentation": "The number of minutes after midnight." }, "@roblox/globaltype/Lighting.GetMinutesAfterMidnight": { "documentation": "Returns the number of minutes that have passed after midnight for the purposes of lighting.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.GetMinutesAfterMidnight/param/0" } ], "returns": [ "@roblox/globaltype/Lighting.GetMinutesAfterMidnight/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#GetMinutesAfterMidnight", "code_sample": "" }, "@roblox/globaltype/Lighting.getMinutesAfterMidnight/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.getMinutesAfterMidnight/return/0": { "documentation": "" }, "@roblox/globaltype/Lighting.getMinutesAfterMidnight": { "documentation": "Deprecated: This method is a deprecated variant of Lighting:GetMinutesAfterMidnight() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.getMinutesAfterMidnight/param/0" } ], "returns": [ "@roblox/globaltype/Lighting.getMinutesAfterMidnight/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#getMinutesAfterMidnight", "code_sample": "" }, "@roblox/globaltype/Lighting.GetMoonDirection/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.GetMoonDirection/return/0": { "documentation": "Vector3 representing the direction of the moon." }, "@roblox/globaltype/Lighting.GetMoonDirection": { "documentation": "Returns a Vector3 representing the direction of the moon.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.GetMoonDirection/param/0" } ], "returns": [ "@roblox/globaltype/Lighting.GetMoonDirection/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#GetMoonDirection", "code_sample": "" }, "@roblox/globaltype/Lighting.GetMoonPhase/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.GetMoonPhase/return/0": { "documentation": "" }, "@roblox/globaltype/Lighting.GetMoonPhase": { "documentation": "Returns the moon's current phase.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.GetMoonPhase/param/0" } ], "returns": [ "@roblox/globaltype/Lighting.GetMoonPhase/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#GetMoonPhase", "code_sample": "" }, "@roblox/globaltype/Lighting.GetSunDirection/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.GetSunDirection/return/0": { "documentation": "Vector3 representing the direction of the sun." }, "@roblox/globaltype/Lighting.GetSunDirection": { "documentation": "Returns a Vector3 representing the direction of the sun.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.GetSunDirection/param/0" } ], "returns": [ "@roblox/globaltype/Lighting.GetSunDirection/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#GetSunDirection", "code_sample": "" }, "@roblox/globaltype/Lighting.SetMinutesAfterMidnight/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.SetMinutesAfterMidnight/param/1": { "documentation": "The number of minutes after midnight." }, "@roblox/globaltype/Lighting.SetMinutesAfterMidnight": { "documentation": "Sets TimeOfDay and ClockTime to the given number of minutes after midnight.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.SetMinutesAfterMidnight/param/0" }, { "name": "minutes", "documentation": "@roblox/globaltype/Lighting.SetMinutesAfterMidnight/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#SetMinutesAfterMidnight", "code_sample": "" }, "@roblox/globaltype/Lighting.setMinutesAfterMidnight/param/0": { "documentation": "The Lighting service controls global lighting in an experience. It includes a range of adjustable properties that you can use to change how lighting appears and interacts with other objects." }, "@roblox/globaltype/Lighting.setMinutesAfterMidnight/param/1": { "documentation": "" }, "@roblox/globaltype/Lighting.setMinutesAfterMidnight": { "documentation": "Deprecated: This method is a deprecated variant of Lighting:SetMinutesAfterMidnight() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.setMinutesAfterMidnight/param/0" }, { "name": "minutes", "documentation": "@roblox/globaltype/Lighting.setMinutesAfterMidnight/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#setMinutesAfterMidnight", "code_sample": "" }, "@roblox/globaltype/Lighting.LightingChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Lighting.LightingChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Lighting.LightingChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.LightingChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Lighting.LightingChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Lighting.LightingChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Lighting.LightingChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Lighting.LightingChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.LightingChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Lighting.LightingChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Lighting.LightingChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Lighting.LightingChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Lighting.LightingChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.LightingChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Lighting.LightingChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Lighting.LightingChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Lighting.LightingChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Lighting.LightingChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Lighting.LightingChanged": { "documentation": "This event fires when a Lighting property is changed or a Sky is added or removed from Lighting.", "keys": { "Connect": "@roblox/globaltype/Lighting.LightingChanged.Connect", "ConnectParallel": "@roblox/globaltype/Lighting.LightingChanged.ConnectParallel", "Once": "@roblox/globaltype/Lighting.LightingChanged.Once", "Wait": "@roblox/globaltype/Lighting.LightingChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Lighting#LightingChanged", "code_sample": "" }, "@roblox/globaltype/CustomEvent": { "documentation": "Deprecated: CustomEvents have been superseded by BindableEvents and should not be used in new work.", "keys": { "GetAttachedReceivers": "@roblox/globaltype/CustomEvent.GetAttachedReceivers", "SetValue": "@roblox/globaltype/CustomEvent.SetValue" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEvent", "code_sample": "" }, "@roblox/globaltype/CustomEvent.GetAttachedReceivers/param/0": { "documentation": "Deprecated: CustomEvents have been superseded by BindableEvents and should not be used in new work." }, "@roblox/globaltype/CustomEvent.GetAttachedReceivers/return/0": { "documentation": "" }, "@roblox/globaltype/CustomEvent.GetAttachedReceivers": { "documentation": "Returns the CustomEventReceivers that are connected to the CustomEvent.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.GetAttachedReceivers/param/0" } ], "returns": [ "@roblox/globaltype/CustomEvent.GetAttachedReceivers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEvent#GetAttachedReceivers", "code_sample": "" }, "@roblox/globaltype/CustomEvent.SetValue/param/0": { "documentation": "Deprecated: CustomEvents have been superseded by BindableEvents and should not be used in new work." }, "@roblox/globaltype/CustomEvent.SetValue/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.SetValue": { "documentation": "Sets the value of the CustomEvent and fires the CustomEventReceiver.SourceValueChanged event for all connected CustomEventReceiver|receivers.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.SetValue/param/0" }, { "name": "newValue", "documentation": "@roblox/globaltype/CustomEvent.SetValue/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEvent#SetValue", "code_sample": "" }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverConnected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverConnected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.ReceiverConnected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverConnected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverConnected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverConnected": { "documentation": "Fires when a receiver is connected to the CustomEvent.", "keys": { "Connect": "@roblox/globaltype/CustomEvent.ReceiverConnected.Connect", "ConnectParallel": "@roblox/globaltype/CustomEvent.ReceiverConnected.ConnectParallel", "Once": "@roblox/globaltype/CustomEvent.ReceiverConnected.Once", "Wait": "@roblox/globaltype/CustomEvent.ReceiverConnected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEvent#ReceiverConnected", "code_sample": "" }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CustomEvent.ReceiverDisconnected": { "documentation": "Fires when a receiver is disconnected from the CustomEvent.", "keys": { "Connect": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Connect", "ConnectParallel": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.ConnectParallel", "Once": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Once", "Wait": "@roblox/globaltype/CustomEvent.ReceiverDisconnected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomEvent#ReceiverDisconnected", "code_sample": "" }, "@roblox/globaltype/PVAdornment": { "documentation": "An abstract class of which the inheritors can be adorned to objects of the PVInstance class.", "keys": { "Adornee": "@roblox/globaltype/PVAdornment.Adornee" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVAdornment", "code_sample": "" }, "@roblox/globaltype/PVAdornment.Adornee": { "documentation": "The PVInstance which this PVAdornment is attached to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVAdornment#Adornee", "code_sample": "" }, "@roblox/globaltype/EditableImage": { "documentation": "Instance which allows for the runtime creation and manipulation of images.", "keys": { "Size": "@roblox/globaltype/EditableImage.Size", "Destroy": "@roblox/globaltype/EditableImage.Destroy", "DrawCircle": "@roblox/globaltype/EditableImage.DrawCircle", "DrawImage": "@roblox/globaltype/EditableImage.DrawImage", "DrawImageProjected": "@roblox/globaltype/EditableImage.DrawImageProjected", "DrawImageTransformed": "@roblox/globaltype/EditableImage.DrawImageTransformed", "DrawLine": "@roblox/globaltype/EditableImage.DrawLine", "DrawRectangle": "@roblox/globaltype/EditableImage.DrawRectangle", "ReadPixelsBuffer": "@roblox/globaltype/EditableImage.ReadPixelsBuffer", "WritePixelsBuffer": "@roblox/globaltype/EditableImage.WritePixelsBuffer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage", "code_sample": "" }, "@roblox/globaltype/EditableImage.Size": { "documentation": "Size of the EditableImage in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#Size", "code_sample": "" }, "@roblox/globaltype/EditableImage.Destroy/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.Destroy": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.Destroy/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#Destroy", "code_sample": "" }, "@roblox/globaltype/EditableImage.DrawCircle/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.DrawCircle/param/1": { "documentation": "Center of the circle, relative to the top-left corner of the EditableImage. Positions outside the canvas bounds are allowed." }, "@roblox/globaltype/EditableImage.DrawCircle/param/2": { "documentation": "Radius of the circle in pixels." }, "@roblox/globaltype/EditableImage.DrawCircle/param/3": { "documentation": "Color of the circle." }, "@roblox/globaltype/EditableImage.DrawCircle/param/4": { "documentation": "Transparency of the circle with 0 being fully opaque and 1 being fully transparent." }, "@roblox/globaltype/EditableImage.DrawCircle/param/5": { "documentation": "How the pixels of the source image are blended with the pixels of the added image." }, "@roblox/globaltype/EditableImage.DrawCircle": { "documentation": "Draws a circle at the specified point.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.DrawCircle/param/0" }, { "name": "center", "documentation": "@roblox/globaltype/EditableImage.DrawCircle/param/1" }, { "name": "radius", "documentation": "@roblox/globaltype/EditableImage.DrawCircle/param/2" }, { "name": "color", "documentation": "@roblox/globaltype/EditableImage.DrawCircle/param/3" }, { "name": "transparency", "documentation": "@roblox/globaltype/EditableImage.DrawCircle/param/4" }, { "name": "combineType", "documentation": "@roblox/globaltype/EditableImage.DrawCircle/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawCircle", "code_sample": "" }, "@roblox/globaltype/EditableImage.DrawImage/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.DrawImage/param/1": { "documentation": "Position at which the top-left corner of the added image will be drawn." }, "@roblox/globaltype/EditableImage.DrawImage/param/2": { "documentation": "The EditableImage to draw into this EditableImage." }, "@roblox/globaltype/EditableImage.DrawImage/param/3": { "documentation": "How the pixels of the source image should be blended with the pixels of the added image." }, "@roblox/globaltype/EditableImage.DrawImage": { "documentation": "Draws another EditableImage into this EditableImage at the given position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.DrawImage/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/EditableImage.DrawImage/param/1" }, { "name": "image", "documentation": "@roblox/globaltype/EditableImage.DrawImage/param/2" }, { "name": "combineType", "documentation": "@roblox/globaltype/EditableImage.DrawImage/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImage", "code_sample": "" }, "@roblox/globaltype/EditableImage.DrawImageProjected/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.DrawImageProjected/param/1": { "documentation": "The EditableMesh used to project into." }, "@roblox/globaltype/EditableImage.DrawImageProjected/param/2": { "documentation": "Projection configuration dictionary including the following key-value pairs: " }, "@roblox/globaltype/EditableImage.DrawImageProjected/param/3": { "documentation": "Brush configuration dictionary including the following key-value pairs: " }, "@roblox/globaltype/EditableImage.DrawImageProjected": { "documentation": "Projects another EditableImage into an EditableMesh and stores the result on this EditableImage.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.DrawImageProjected/param/0" }, { "name": "mesh", "documentation": "@roblox/globaltype/EditableImage.DrawImageProjected/param/1" }, { "name": "projection", "documentation": "@roblox/globaltype/EditableImage.DrawImageProjected/param/2" }, { "name": "brushConfig", "documentation": "@roblox/globaltype/EditableImage.DrawImageProjected/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageProjected", "code_sample": "" }, "@roblox/globaltype/EditableImage.DrawImageTransformed/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.DrawImageTransformed/param/1": { "documentation": "Position in pixels where the pivot point of the source image will be placed on this image." }, "@roblox/globaltype/EditableImage.DrawImageTransformed/param/2": { "documentation": "Scaling factors for the source image along the X and Y axes." }, "@roblox/globaltype/EditableImage.DrawImageTransformed/param/3": { "documentation": "The rotation angle in degrees, applied around the pivot point of the source image." }, "@roblox/globaltype/EditableImage.DrawImageTransformed/param/4": { "documentation": "The source EditableImage to be drawn into this image." }, "@roblox/globaltype/EditableImage.DrawImageTransformed/param/5": { "documentation": "Optional dictionary for additional configuration: " }, "@roblox/globaltype/EditableImage.DrawImageTransformed": { "documentation": "Draws an image into this EditableImage with transformations including scaling and rotation, placing it at the specified position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.DrawImageTransformed/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/EditableImage.DrawImageTransformed/param/1" }, { "name": "scale", "documentation": "@roblox/globaltype/EditableImage.DrawImageTransformed/param/2" }, { "name": "rotation", "documentation": "@roblox/globaltype/EditableImage.DrawImageTransformed/param/3" }, { "name": "image", "documentation": "@roblox/globaltype/EditableImage.DrawImageTransformed/param/4" }, { "name": "options", "documentation": "@roblox/globaltype/EditableImage.DrawImageTransformed/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawImageTransformed", "code_sample": "" }, "@roblox/globaltype/EditableImage.DrawLine/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.DrawLine/param/1": { "documentation": "Start point of the line." }, "@roblox/globaltype/EditableImage.DrawLine/param/2": { "documentation": "End point of the line." }, "@roblox/globaltype/EditableImage.DrawLine/param/3": { "documentation": "Color of the line." }, "@roblox/globaltype/EditableImage.DrawLine/param/4": { "documentation": "Transparency of the line." }, "@roblox/globaltype/EditableImage.DrawLine/param/5": { "documentation": "How the pixels of the source image are blended with the pixels of the added image." }, "@roblox/globaltype/EditableImage.DrawLine": { "documentation": "Draws a line between two provided points.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.DrawLine/param/0" }, { "name": "p1", "documentation": "@roblox/globaltype/EditableImage.DrawLine/param/1" }, { "name": "p2", "documentation": "@roblox/globaltype/EditableImage.DrawLine/param/2" }, { "name": "color", "documentation": "@roblox/globaltype/EditableImage.DrawLine/param/3" }, { "name": "transparency", "documentation": "@roblox/globaltype/EditableImage.DrawLine/param/4" }, { "name": "combineType", "documentation": "@roblox/globaltype/EditableImage.DrawLine/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawLine", "code_sample": "" }, "@roblox/globaltype/EditableImage.DrawRectangle/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.DrawRectangle/param/1": { "documentation": "Position of the top-left of the rectangle. Unlike other drawing methods, this cannot be outside the canvas bounds of the EditableImage." }, "@roblox/globaltype/EditableImage.DrawRectangle/param/2": { "documentation": "Size of the rectangle to draw, in pixels." }, "@roblox/globaltype/EditableImage.DrawRectangle/param/3": { "documentation": "Color of the rectangle." }, "@roblox/globaltype/EditableImage.DrawRectangle/param/4": { "documentation": "Transparency of the rectangle." }, "@roblox/globaltype/EditableImage.DrawRectangle/param/5": { "documentation": "How the pixels of the source image are blended with the pixels of the added image." }, "@roblox/globaltype/EditableImage.DrawRectangle": { "documentation": "Draws a rectangle of the given size at the given top-left position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.DrawRectangle/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/EditableImage.DrawRectangle/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/EditableImage.DrawRectangle/param/2" }, { "name": "color", "documentation": "@roblox/globaltype/EditableImage.DrawRectangle/param/3" }, { "name": "transparency", "documentation": "@roblox/globaltype/EditableImage.DrawRectangle/param/4" }, { "name": "combineType", "documentation": "@roblox/globaltype/EditableImage.DrawRectangle/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#DrawRectangle", "code_sample": "" }, "@roblox/globaltype/EditableImage.ReadPixelsBuffer/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.ReadPixelsBuffer/param/1": { "documentation": "Top-left corner of the rectangular region of pixels to read." }, "@roblox/globaltype/EditableImage.ReadPixelsBuffer/param/2": { "documentation": "Size of the rectangular region of pixels to read." }, "@roblox/globaltype/EditableImage.ReadPixelsBuffer/return/0": { "documentation": "Buffer where each pixel is represented by four bytes (red, green, blue and alpha respectively). The length of the buffer can be calculated as X * Size.Y * 4 bytes." }, "@roblox/globaltype/EditableImage.ReadPixelsBuffer": { "documentation": "Reads a rectangular region of pixels into a buffer.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.ReadPixelsBuffer/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/EditableImage.ReadPixelsBuffer/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/EditableImage.ReadPixelsBuffer/param/2" } ], "returns": [ "@roblox/globaltype/EditableImage.ReadPixelsBuffer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#ReadPixelsBuffer", "code_sample": "" }, "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of images." }, "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/1": { "documentation": "Top-left corner of the rectangular region to draw the pixels into." }, "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/2": { "documentation": "Size of the rectangular region of pixels to write." }, "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/3": { "documentation": "A buffer where each pixel is represented by four bytes (red, green, blue, and alpha respectively). The length of the buffer should be X * Size.Y * 4 bytes." }, "@roblox/globaltype/EditableImage.WritePixelsBuffer": { "documentation": "Writes a rectangular region of pixels into the image.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/2" }, { "name": "buffer", "documentation": "@roblox/globaltype/EditableImage.WritePixelsBuffer/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableImage#WritePixelsBuffer", "code_sample": "" }, "@roblox/globaltype/Studio": { "documentation": "", "keys": { "Studio.\"function\" Color": "@roblox/globaltype/Studio.Studio.\"function\" Color", "Studio.\"local\" Color": "@roblox/globaltype/Studio.Studio.\"local\" Color", "Studio.\"nil\" Color": "@roblox/globaltype/Studio.Studio.\"nil\" Color", "Studio.\"self\" Color": "@roblox/globaltype/Studio.Studio.\"self\" Color", "Studio.\"TODO\" Color": "@roblox/globaltype/Studio.Studio.\"TODO\" Color", "ActionOnAutoResumeSync": "@roblox/globaltype/Studio.ActionOnAutoResumeSync", "ActionOnStopSync": "@roblox/globaltype/Studio.ActionOnStopSync", "Active Color": "@roblox/globaltype/Studio.Active Color", "Active Hover Over Color": "@roblox/globaltype/Studio.Active Hover Over Color", "Always Save Script Changes": "@roblox/globaltype/Studio.Always Save Script Changes", "Animate Hover Over": "@roblox/globaltype/Studio.Animate Hover Over", "Auto Clean Empty Line": "@roblox/globaltype/Studio.Auto Clean Empty Line", "Auto Closing Brackets": "@roblox/globaltype/Studio.Auto Closing Brackets", "Auto Closing Quotes": "@roblox/globaltype/Studio.Auto Closing Quotes", "Auto Delete Closing Brackets and Quotes": "@roblox/globaltype/Studio.Auto Delete Closing Brackets and Quotes", "Auto Indent Rule": "@roblox/globaltype/Studio.Auto Indent Rule", "Auto-Recovery Enabled": "@roblox/globaltype/Studio.Auto-Recovery Enabled", "Auto-Recovery Interval ": "@roblox/globaltype/Studio.Auto-Recovery Interval ", "AutocompleteAcceptanceBehavior": "@roblox/globaltype/Studio.AutocompleteAcceptanceBehavior", "Automatically trigger AI Code Completion": "@roblox/globaltype/Studio.Automatically trigger AI Code Completion", "AutoResumeSyncOnPlaceOpen": "@roblox/globaltype/Studio.AutoResumeSyncOnPlaceOpen", "AutoUpdateEnabled": "@roblox/globaltype/Studio.AutoUpdateEnabled", "Background Color": "@roblox/globaltype/Studio.Background Color", "Basic Objects Display Mode": "@roblox/globaltype/Studio.Basic Objects Display Mode", "Bool Color": "@roblox/globaltype/Studio.Bool Color", "Bracket Color": "@roblox/globaltype/Studio.Bracket Color", "Built-in Function Color": "@roblox/globaltype/Studio.Built-in Function Color", "Camera Mouse Wheel Speed": "@roblox/globaltype/Studio.Camera Mouse Wheel Speed", "Camera Pan Speed": "@roblox/globaltype/Studio.Camera Pan Speed", "Camera Shift Speed": "@roblox/globaltype/Studio.Camera Shift Speed", "Camera Speed": "@roblox/globaltype/Studio.Camera Speed", "Camera Speed Adjust Binding": "@roblox/globaltype/Studio.Camera Speed Adjust Binding", "Camera Zoom to Mouse Position": "@roblox/globaltype/Studio.Camera Zoom to Mouse Position", "CameraAdaptiveSpeed": "@roblox/globaltype/Studio.CameraAdaptiveSpeed", "CameraOrbitSensitivity": "@roblox/globaltype/Studio.CameraOrbitSensitivity", "CameraPanSensitivity": "@roblox/globaltype/Studio.CameraPanSensitivity", "CameraShiftFactor": "@roblox/globaltype/Studio.CameraShiftFactor", "CameraSpeedLockDefault": "@roblox/globaltype/Studio.CameraSpeedLockDefault", "CameraTweenFocus": "@roblox/globaltype/Studio.CameraTweenFocus", "CameraZoomSpeed": "@roblox/globaltype/Studio.CameraZoomSpeed", "Clear Output On Start": "@roblox/globaltype/Studio.Clear Output On Start", "CommandBarLocalState": "@roblox/globaltype/Studio.CommandBarLocalState", "Comment Color": "@roblox/globaltype/Studio.Comment Color", "Current Line Highlight Color": "@roblox/globaltype/Studio.Current Line Highlight Color", "Debugger Current Line Color": "@roblox/globaltype/Studio.Debugger Current Line Color", "Debugger Error Line Color": "@roblox/globaltype/Studio.Debugger Error Line Color", "DefaultInstancesDir": "@roblox/globaltype/Studio.DefaultInstancesDir", "DefaultScriptSyncFileType": "@roblox/globaltype/Studio.DefaultScriptSyncFileType", "DeprecatedObjectsShown": "@roblox/globaltype/Studio.DeprecatedObjectsShown", "DisplayLanguage": "@roblox/globaltype/Studio.DisplayLanguage", "DraggerActiveColor": "@roblox/globaltype/Studio.DraggerActiveColor", "DraggerMajorGridIncrement": "@roblox/globaltype/Studio.DraggerMajorGridIncrement", "DraggerMaxSoftSnaps": "@roblox/globaltype/Studio.DraggerMaxSoftSnaps", "DraggerPassiveColor": "@roblox/globaltype/Studio.DraggerPassiveColor", "DraggerShowHoverRuler": "@roblox/globaltype/Studio.DraggerShowHoverRuler", "DraggerShowMeasurement": "@roblox/globaltype/Studio.DraggerShowMeasurement", "DraggerShowTargetSnap": "@roblox/globaltype/Studio.DraggerShowTargetSnap", "DraggerSoftSnapMarginFactor": "@roblox/globaltype/Studio.DraggerSoftSnapMarginFactor", "DraggerSummonMarginFactor": "@roblox/globaltype/Studio.DraggerSummonMarginFactor", "DraggerTiltRotateDuration": "@roblox/globaltype/Studio.DraggerTiltRotateDuration", "Enable Autocomplete": "@roblox/globaltype/Studio.Enable Autocomplete", "Enable Autocomplete Doc View": "@roblox/globaltype/Studio.Enable Autocomplete Doc View", "Enable CoreScript Debugger": "@roblox/globaltype/Studio.Enable CoreScript Debugger", "Enable Http Sandboxing": "@roblox/globaltype/Studio.Enable Http Sandboxing", "Enable Internal Beta Features": "@roblox/globaltype/Studio.Enable Internal Beta Features", "Enable Internal Features": "@roblox/globaltype/Studio.Enable Internal Features", "Enable Script Analysis": "@roblox/globaltype/Studio.Enable Script Analysis", "Enable Scrollbar Markers": "@roblox/globaltype/Studio.Enable Scrollbar Markers", "Enable Signature Help": "@roblox/globaltype/Studio.Enable Signature Help", "Enable Signature Help Doc View": "@roblox/globaltype/Studio.Enable Signature Help Doc View", "Enable Temporary Tabs": "@roblox/globaltype/Studio.Enable Temporary Tabs", "Enable Temporary Tabs In Explorer": "@roblox/globaltype/Studio.Enable Temporary Tabs In Explorer", "Enable Type Hover": "@roblox/globaltype/Studio.Enable Type Hover", "EnableCodeAssist": "@roblox/globaltype/Studio.EnableCodeAssist", "EnableFindOnType": "@roblox/globaltype/Studio.EnableFindOnType", "EnableIndentationRulers": "@roblox/globaltype/Studio.EnableIndentationRulers", "EnableSelectionTooltips": "@roblox/globaltype/Studio.EnableSelectionTooltips", "EnableStudioStreaming": "@roblox/globaltype/Studio.EnableStudioStreaming", "Error Color": "@roblox/globaltype/Studio.Error Color", "Find Selection Background Color": "@roblox/globaltype/Studio.Find Selection Background Color", "Font": "@roblox/globaltype/Studio.Font", "Format On Paste": "@roblox/globaltype/Studio.Format On Paste", "Format On Type": "@roblox/globaltype/Studio.Format On Type", "Function Name Color": "@roblox/globaltype/Studio.Function Name Color", "Highlight Current Line": "@roblox/globaltype/Studio.Highlight Current Line", "Highlight Occurances": "@roblox/globaltype/Studio.Highlight Occurances", "HintColor": "@roblox/globaltype/Studio.HintColor", "Hover Animate Speed": "@roblox/globaltype/Studio.Hover Animate Speed", "Hover Box Thickness": "@roblox/globaltype/Studio.Hover Box Thickness", "Hover Line Thickness": "@roblox/globaltype/Studio.Hover Line Thickness", "Hover Over Color": "@roblox/globaltype/Studio.Hover Over Color", "IconOverrideDir": "@roblox/globaltype/Studio.IconOverrideDir", "Indent Using Spaces": "@roblox/globaltype/Studio.Indent Using Spaces", "IndentationRulerColor": "@roblox/globaltype/Studio.IndentationRulerColor", "InformationColor": "@roblox/globaltype/Studio.InformationColor", "Keyword Color": "@roblox/globaltype/Studio.Keyword Color", "LargeFileLineCountThreshold": "@roblox/globaltype/Studio.LargeFileLineCountThreshold", "LargeFileThreshold": "@roblox/globaltype/Studio.LargeFileThreshold", "Line Thickness": "@roblox/globaltype/Studio.Line Thickness", "LoadAllBuiltinPluginsInRunModes": "@roblox/globaltype/Studio.LoadAllBuiltinPluginsInRunModes", "LoadInternalPlugins": "@roblox/globaltype/Studio.LoadInternalPlugins", "LoadUserPluginsInRunModes": "@roblox/globaltype/Studio.LoadUserPluginsInRunModes", "LocalAssetsFolder": "@roblox/globaltype/Studio.LocalAssetsFolder", "LuaDebuggerEnabled": "@roblox/globaltype/Studio.LuaDebuggerEnabled", "LuaDebuggerEnabledAtStartup": "@roblox/globaltype/Studio.LuaDebuggerEnabledAtStartup", "Luau Keyword Color": "@roblox/globaltype/Studio.Luau Keyword Color", "Main Volume": "@roblox/globaltype/Studio.Main Volume", "Matching Word Background Color": "@roblox/globaltype/Studio.Matching Word Background Color", "MaxFindReplaceAllResults": "@roblox/globaltype/Studio.MaxFindReplaceAllResults", "Maximum Output Lines": "@roblox/globaltype/Studio.Maximum Output Lines", "Menu Item Background Color": "@roblox/globaltype/Studio.Menu Item Background Color", "Method Color": "@roblox/globaltype/Studio.Method Color", "Number Color": "@roblox/globaltype/Studio.Number Color", "Only Play Audio from Window in Focus": "@roblox/globaltype/Studio.Only Play Audio from Window in Focus", "Operator Color": "@roblox/globaltype/Studio.Operator Color", "Output Font": "@roblox/globaltype/Studio.Output Font", "Output Layout Mode": "@roblox/globaltype/Studio.Output Layout Mode", "PermissionLevelShown": "@roblox/globaltype/Studio.PermissionLevelShown", "Physical Draggers Select Scope By Default": "@roblox/globaltype/Studio.Physical Draggers Select Scope By Default", "Pivot Snap To Geometry Color": "@roblox/globaltype/Studio.Pivot Snap To Geometry Color", "PluginDebuggingEnabled": "@roblox/globaltype/Studio.PluginDebuggingEnabled", "PluginsDir": "@roblox/globaltype/Studio.PluginsDir", "Primary Text Color": "@roblox/globaltype/Studio.Primary Text Color", "Property Color": "@roblox/globaltype/Studio.Property Color", "ReloadBuiltinPluginsOnChange": "@roblox/globaltype/Studio.ReloadBuiltinPluginsOnChange", "ReloadLocalPluginsOnChange": "@roblox/globaltype/Studio.ReloadLocalPluginsOnChange", "Respect Studio shortcuts when game has focus": "@roblox/globaltype/Studio.Respect Studio shortcuts when game has focus", "Ruler Color": "@roblox/globaltype/Studio.Ruler Color", "Rulers": "@roblox/globaltype/Studio.Rulers", "RuntimeUndoBehavior": "@roblox/globaltype/Studio.RuntimeUndoBehavior", "Script Editor Color Preset": "@roblox/globaltype/Studio.Script Editor Color Preset", "Script Editor Scrollbar Background Color": "@roblox/globaltype/Studio.Script Editor Scrollbar Background Color", "Script Editor Scrollbar Handle Color": "@roblox/globaltype/Studio.Script Editor Scrollbar Handle Color", "ScriptTimeoutLength": "@roblox/globaltype/Studio.ScriptTimeoutLength", "Scroll Past Last Line": "@roblox/globaltype/Studio.Scroll Past Last Line", "Secondary Text Color": "@roblox/globaltype/Studio.Secondary Text Color", "Select Color": "@roblox/globaltype/Studio.Select Color", "Select": "@roblox/globaltype/Studio.Select", "Selected Menu Item Background Color": "@roblox/globaltype/Studio.Selected Menu Item Background Color", "Selected Text Color": "@roblox/globaltype/Studio.Selected Text Color", "Selection Background Color": "@roblox/globaltype/Studio.Selection Background Color", "Selection Box Thickness": "@roblox/globaltype/Studio.Selection Box Thickness", "Selection Color": "@roblox/globaltype/Studio.Selection Color", "Selection Line Thickness": "@roblox/globaltype/Studio.Selection Line Thickness", "Set Pivot of Imported Parts": "@roblox/globaltype/Studio.Set Pivot of Imported Parts", "Show Core GUI in Explorer while Playing": "@roblox/globaltype/Studio.Show Core GUI in Explorer while Playing", "Show Diagnostics Bar": "@roblox/globaltype/Studio.Show Diagnostics Bar", "Show FileSyncService": "@roblox/globaltype/Studio.Show FileSyncService", "Show Hidden Objects in Explorer": "@roblox/globaltype/Studio.Show Hidden Objects in Explorer", "Show Hover Over": "@roblox/globaltype/Studio.Show Hover Over", "Show Light Guides": "@roblox/globaltype/Studio.Show Light Guides", "Show Navigation Labels": "@roblox/globaltype/Studio.Show Navigation Labels", "Show Navigation Mesh": "@roblox/globaltype/Studio.Show Navigation Mesh", "Show Pathfinding Links": "@roblox/globaltype/Studio.Show Pathfinding Links", "Show Plugin GUI Service in Explorer": "@roblox/globaltype/Studio.Show Plugin GUI Service in Explorer", "Show plus button on hover in Explorer": "@roblox/globaltype/Studio.Show plus button on hover in Explorer", "Show Singly Selected Attachment Parent Frame": "@roblox/globaltype/Studio.Show Singly Selected Attachment Parent Frame", "Show Whitespace": "@roblox/globaltype/Studio.Show Whitespace", "ShowCorePackagesInExplorer": "@roblox/globaltype/Studio.ShowCorePackagesInExplorer", "Skip Closing Brackets and Quotes": "@roblox/globaltype/Studio.Skip Closing Brackets and Quotes", "String Color": "@roblox/globaltype/Studio.String Color", "Tab Width": "@roblox/globaltype/Studio.Tab Width", "Text Color": "@roblox/globaltype/Studio.Text Color", "Text Wrapping": "@roblox/globaltype/Studio.Text Wrapping", "Theme": "@roblox/globaltype/Studio.Theme", "UI Theme": "@roblox/globaltype/Studio.UI Theme", "Use Bounding Box Move Handles": "@roblox/globaltype/Studio.Use Bounding Box Move Handles", "Warning Color": "@roblox/globaltype/Studio.Warning Color", "Whitespace Color": "@roblox/globaltype/Studio.Whitespace Color", "GetAvailableThemes": "@roblox/globaltype/Studio.GetAvailableThemes" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio", "code_sample": "" }, "@roblox/globaltype/Studio.Studio.\"function\" Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Studio.\"function\" Color", "code_sample": "" }, "@roblox/globaltype/Studio.Studio.\"local\" Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Studio.\"local\" Color", "code_sample": "" }, "@roblox/globaltype/Studio.Studio.\"nil\" Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Studio.\"nil\" Color", "code_sample": "" }, "@roblox/globaltype/Studio.Studio.\"self\" Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Studio.\"self\" Color", "code_sample": "" }, "@roblox/globaltype/Studio.Studio.\"TODO\" Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Studio.\"TODO\" Color", "code_sample": "" }, "@roblox/globaltype/Studio.ActionOnAutoResumeSync": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ActionOnAutoResumeSync", "code_sample": "" }, "@roblox/globaltype/Studio.ActionOnStopSync": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ActionOnStopSync", "code_sample": "" }, "@roblox/globaltype/Studio.Active Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Active Color", "code_sample": "" }, "@roblox/globaltype/Studio.Active Hover Over Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Active Hover Over Color", "code_sample": "" }, "@roblox/globaltype/Studio.Always Save Script Changes": { "documentation": "If set to true, Roblox Studio will attempt to transfer script changes that were made during a Play Solo session to the opened place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Always Save Script Changes", "code_sample": "" }, "@roblox/globaltype/Studio.Animate Hover Over": { "documentation": "If set to true, the hover selection box that is shown when mousing over selectable objects in the Workspace will flash between Hover Over Color and Select Color based on the Hover Animate Speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Animate Hover Over", "code_sample": "" }, "@roblox/globaltype/Studio.Auto Clean Empty Line": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto Clean Empty Line", "code_sample": "" }, "@roblox/globaltype/Studio.Auto Closing Brackets": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto Closing Brackets", "code_sample": "" }, "@roblox/globaltype/Studio.Auto Closing Quotes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto Closing Quotes", "code_sample": "" }, "@roblox/globaltype/Studio.Auto Delete Closing Brackets and Quotes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto Delete Closing Brackets and Quotes", "code_sample": "" }, "@roblox/globaltype/Studio.Auto Indent Rule": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto Indent Rule", "code_sample": "" }, "@roblox/globaltype/Studio.Auto-Recovery Enabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto-Recovery Enabled", "code_sample": "" }, "@roblox/globaltype/Studio.Auto-Recovery Interval ": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Auto-Recovery Interval ", "code_sample": "" }, "@roblox/globaltype/Studio.AutocompleteAcceptanceBehavior": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#AutocompleteAcceptanceBehavior", "code_sample": "" }, "@roblox/globaltype/Studio.Automatically trigger AI Code Completion": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Automatically trigger AI Code Completion", "code_sample": "" }, "@roblox/globaltype/Studio.AutoResumeSyncOnPlaceOpen": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#AutoResumeSyncOnPlaceOpen", "code_sample": "" }, "@roblox/globaltype/Studio.AutoUpdateEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#AutoUpdateEnabled", "code_sample": "" }, "@roblox/globaltype/Studio.Background Color": { "documentation": "Specifies the background color of Roblox Studio's script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.Basic Objects Display Mode": { "documentation": "Sets the scrolling mode of the Advanced Objects tab in Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Basic Objects Display Mode", "code_sample": "" }, "@roblox/globaltype/Studio.Bool Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Bool Color", "code_sample": "" }, "@roblox/globaltype/Studio.Bracket Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Bracket Color", "code_sample": "" }, "@roblox/globaltype/Studio.Built-in Function Color": { "documentation": "Sets the color of built-in functions and keywords in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Built-in Function Color", "code_sample": "" }, "@roblox/globaltype/Studio.Camera Mouse Wheel Speed": { "documentation": "Sets how many studs the camera will move forward or backwards when using the mouse wheel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Camera Mouse Wheel Speed", "code_sample": "" }, "@roblox/globaltype/Studio.Camera Pan Speed": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Camera Pan Speed", "code_sample": "" }, "@roblox/globaltype/Studio.Camera Shift Speed": { "documentation": "Sets the speed in studs/sec that the camera moves while holding down Shift with the movement keys.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Camera Shift Speed", "code_sample": "" }, "@roblox/globaltype/Studio.Camera Speed": { "documentation": "Sets the speed in studs/sec that the camera moves when movement keys are pressed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Camera Speed", "code_sample": "" }, "@roblox/globaltype/Studio.Camera Speed Adjust Binding": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Camera Speed Adjust Binding", "code_sample": "" }, "@roblox/globaltype/Studio.Camera Zoom to Mouse Position": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Camera Zoom to Mouse Position", "code_sample": "" }, "@roblox/globaltype/Studio.CameraAdaptiveSpeed": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraAdaptiveSpeed", "code_sample": "" }, "@roblox/globaltype/Studio.CameraOrbitSensitivity": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraOrbitSensitivity", "code_sample": "" }, "@roblox/globaltype/Studio.CameraPanSensitivity": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraPanSensitivity", "code_sample": "" }, "@roblox/globaltype/Studio.CameraShiftFactor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraShiftFactor", "code_sample": "" }, "@roblox/globaltype/Studio.CameraSpeedLockDefault": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraSpeedLockDefault", "code_sample": "" }, "@roblox/globaltype/Studio.CameraTweenFocus": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraTweenFocus", "code_sample": "" }, "@roblox/globaltype/Studio.CameraZoomSpeed": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CameraZoomSpeed", "code_sample": "" }, "@roblox/globaltype/Studio.Clear Output On Start": { "documentation": "If set to true, the output will be automatically cleared when game sessions are switched.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Clear Output On Start", "code_sample": "" }, "@roblox/globaltype/Studio.CommandBarLocalState": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#CommandBarLocalState", "code_sample": "" }, "@roblox/globaltype/Studio.Comment Color": { "documentation": "Specifies the color of comments in Roblox Studio's script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Comment Color", "code_sample": "" }, "@roblox/globaltype/Studio.Current Line Highlight Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Current Line Highlight Color", "code_sample": "" }, "@roblox/globaltype/Studio.Debugger Current Line Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Debugger Current Line Color", "code_sample": "" }, "@roblox/globaltype/Studio.Debugger Error Line Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Debugger Error Line Color", "code_sample": "" }, "@roblox/globaltype/Studio.DefaultInstancesDir": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DefaultInstancesDir", "code_sample": "" }, "@roblox/globaltype/Studio.DefaultScriptSyncFileType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DefaultScriptSyncFileType", "code_sample": "" }, "@roblox/globaltype/Studio.DeprecatedObjectsShown": { "documentation": "If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DeprecatedObjectsShown", "code_sample": "" }, "@roblox/globaltype/Studio.DisplayLanguage": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DisplayLanguage", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerActiveColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerActiveColor", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerMajorGridIncrement": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerMajorGridIncrement", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerMaxSoftSnaps": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerMaxSoftSnaps", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerPassiveColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerPassiveColor", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerShowHoverRuler": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerShowHoverRuler", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerShowMeasurement": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerShowMeasurement", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerShowTargetSnap": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerShowTargetSnap", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerSoftSnapMarginFactor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerSoftSnapMarginFactor", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerSummonMarginFactor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerSummonMarginFactor", "code_sample": "" }, "@roblox/globaltype/Studio.DraggerTiltRotateDuration": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#DraggerTiltRotateDuration", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Autocomplete": { "documentation": "When set to true, the script editor and command bar will show an autocomplete menu while writing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Autocomplete", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Autocomplete Doc View": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Autocomplete Doc View", "code_sample": "" }, "@roblox/globaltype/Studio.Enable CoreScript Debugger": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable CoreScript Debugger", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Http Sandboxing": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Http Sandboxing", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Internal Beta Features": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Internal Beta Features", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Internal Features": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Internal Features", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Script Analysis": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Script Analysis", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Scrollbar Markers": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Scrollbar Markers", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Signature Help": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Signature Help", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Signature Help Doc View": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Signature Help Doc View", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Temporary Tabs": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Temporary Tabs", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Temporary Tabs In Explorer": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Temporary Tabs In Explorer", "code_sample": "" }, "@roblox/globaltype/Studio.Enable Type Hover": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Enable Type Hover", "code_sample": "" }, "@roblox/globaltype/Studio.EnableCodeAssist": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#EnableCodeAssist", "code_sample": "" }, "@roblox/globaltype/Studio.EnableFindOnType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#EnableFindOnType", "code_sample": "" }, "@roblox/globaltype/Studio.EnableIndentationRulers": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#EnableIndentationRulers", "code_sample": "" }, "@roblox/globaltype/Studio.EnableSelectionTooltips": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#EnableSelectionTooltips", "code_sample": "" }, "@roblox/globaltype/Studio.EnableStudioStreaming": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#EnableStudioStreaming", "code_sample": "" }, "@roblox/globaltype/Studio.Error Color": { "documentation": "Specifies the color of the wavy underline shown when malformed code is detected in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Error Color", "code_sample": "" }, "@roblox/globaltype/Studio.Find Selection Background Color": { "documentation": "Sets the highlight color of matches in the script editor's Find Selection operation (Ctrl+F).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Find Selection Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.Font": { "documentation": "Specifies the font used in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Font", "code_sample": "" }, "@roblox/globaltype/Studio.Format On Paste": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Format On Paste", "code_sample": "" }, "@roblox/globaltype/Studio.Format On Type": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Format On Type", "code_sample": "" }, "@roblox/globaltype/Studio.Function Name Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Function Name Color", "code_sample": "" }, "@roblox/globaltype/Studio.Highlight Current Line": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Highlight Current Line", "code_sample": "" }, "@roblox/globaltype/Studio.Highlight Occurances": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Highlight Occurances", "code_sample": "" }, "@roblox/globaltype/Studio.HintColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#HintColor", "code_sample": "" }, "@roblox/globaltype/Studio.Hover Animate Speed": { "documentation": "Specifies how frequently the hover animation flashes when the mouse is hovering over a selectable object in the Workspace.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Hover Animate Speed", "code_sample": "" }, "@roblox/globaltype/Studio.Hover Box Thickness": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Hover Box Thickness", "code_sample": "" }, "@roblox/globaltype/Studio.Hover Line Thickness": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Hover Line Thickness", "code_sample": "" }, "@roblox/globaltype/Studio.Hover Over Color": { "documentation": "Specifies the color that the hover selection box uses.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Hover Over Color", "code_sample": "" }, "@roblox/globaltype/Studio.IconOverrideDir": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#IconOverrideDir", "code_sample": "" }, "@roblox/globaltype/Studio.Indent Using Spaces": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Indent Using Spaces", "code_sample": "" }, "@roblox/globaltype/Studio.IndentationRulerColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#IndentationRulerColor", "code_sample": "" }, "@roblox/globaltype/Studio.InformationColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#InformationColor", "code_sample": "" }, "@roblox/globaltype/Studio.Keyword Color": { "documentation": "Sets the text color of built-in Luau keywords.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Keyword Color", "code_sample": "" }, "@roblox/globaltype/Studio.LargeFileLineCountThreshold": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LargeFileLineCountThreshold", "code_sample": "" }, "@roblox/globaltype/Studio.LargeFileThreshold": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LargeFileThreshold", "code_sample": "" }, "@roblox/globaltype/Studio.Line Thickness": { "documentation": "Sets the thickness of the Model.PrimaryPart selection adornee. This value is constrained between 0 and 0.05.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Line Thickness", "code_sample": "" }, "@roblox/globaltype/Studio.LoadAllBuiltinPluginsInRunModes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LoadAllBuiltinPluginsInRunModes", "code_sample": "" }, "@roblox/globaltype/Studio.LoadInternalPlugins": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LoadInternalPlugins", "code_sample": "" }, "@roblox/globaltype/Studio.LoadUserPluginsInRunModes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LoadUserPluginsInRunModes", "code_sample": "" }, "@roblox/globaltype/Studio.LocalAssetsFolder": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LocalAssetsFolder", "code_sample": "" }, "@roblox/globaltype/Studio.LuaDebuggerEnabled": { "documentation": "Specifies whether or not the Lua Debugger feature is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LuaDebuggerEnabled", "code_sample": "" }, "@roblox/globaltype/Studio.LuaDebuggerEnabledAtStartup": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#LuaDebuggerEnabledAtStartup", "code_sample": "" }, "@roblox/globaltype/Studio.Luau Keyword Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Luau Keyword Color", "code_sample": "" }, "@roblox/globaltype/Studio.Main Volume": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Main Volume", "code_sample": "" }, "@roblox/globaltype/Studio.Matching Word Background Color": { "documentation": "Sets the highlight color of double-clicked variables in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Matching Word Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.MaxFindReplaceAllResults": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#MaxFindReplaceAllResults", "code_sample": "" }, "@roblox/globaltype/Studio.Maximum Output Lines": { "documentation": "The maximum number of lines that can be displayed in the output.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Maximum Output Lines", "code_sample": "" }, "@roblox/globaltype/Studio.Menu Item Background Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Menu Item Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.Method Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Method Color", "code_sample": "" }, "@roblox/globaltype/Studio.Number Color": { "documentation": "Specifies the color of numbers in Roblox Studio's script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Number Color", "code_sample": "" }, "@roblox/globaltype/Studio.Only Play Audio from Window in Focus": { "documentation": "If set to true, audio being played will only be heard if the game window is being focused on.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Only Play Audio from Window in Focus", "code_sample": "" }, "@roblox/globaltype/Studio.Operator Color": { "documentation": "Sets the text color of operator characters in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Operator Color", "code_sample": "" }, "@roblox/globaltype/Studio.Output Font": { "documentation": "Specifies the font used by the output.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Output Font", "code_sample": "" }, "@roblox/globaltype/Studio.Output Layout Mode": { "documentation": "Sets the layout mode of the output.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Output Layout Mode", "code_sample": "" }, "@roblox/globaltype/Studio.PermissionLevelShown": { "documentation": "Sets the highest permission level that APIs have to have in order to be shown in the Object Browser. See PermissionLevelShown for more info.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#PermissionLevelShown", "code_sample": "" }, "@roblox/globaltype/Studio.Physical Draggers Select Scope By Default": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Physical Draggers Select Scope By Default", "code_sample": "" }, "@roblox/globaltype/Studio.Pivot Snap To Geometry Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Pivot Snap To Geometry Color", "code_sample": "" }, "@roblox/globaltype/Studio.PluginDebuggingEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#PluginDebuggingEnabled", "code_sample": "" }, "@roblox/globaltype/Studio.PluginsDir": { "documentation": "The directory where local plugins are stored.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#PluginsDir", "code_sample": "" }, "@roblox/globaltype/Studio.Primary Text Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Primary Text Color", "code_sample": "" }, "@roblox/globaltype/Studio.Property Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Property Color", "code_sample": "" }, "@roblox/globaltype/Studio.ReloadBuiltinPluginsOnChange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ReloadBuiltinPluginsOnChange", "code_sample": "" }, "@roblox/globaltype/Studio.ReloadLocalPluginsOnChange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ReloadLocalPluginsOnChange", "code_sample": "" }, "@roblox/globaltype/Studio.Respect Studio shortcuts when game has focus": { "documentation": "When set to true, Roblox Studio shortcuts will take priority over inputs being captured in the game window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Respect Studio shortcuts when game has focus", "code_sample": "" }, "@roblox/globaltype/Studio.Ruler Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Ruler Color", "code_sample": "" }, "@roblox/globaltype/Studio.Rulers": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Rulers", "code_sample": "" }, "@roblox/globaltype/Studio.RuntimeUndoBehavior": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#RuntimeUndoBehavior", "code_sample": "" }, "@roblox/globaltype/Studio.Script Editor Color Preset": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Script Editor Color Preset", "code_sample": "" }, "@roblox/globaltype/Studio.Script Editor Scrollbar Background Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Script Editor Scrollbar Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.Script Editor Scrollbar Handle Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Script Editor Scrollbar Handle Color", "code_sample": "" }, "@roblox/globaltype/Studio.ScriptTimeoutLength": { "documentation": "The time (in seconds) a script can wait to be resumed before timing out.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ScriptTimeoutLength", "code_sample": "" }, "@roblox/globaltype/Studio.Scroll Past Last Line": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Scroll Past Last Line", "code_sample": "" }, "@roblox/globaltype/Studio.Secondary Text Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Secondary Text Color", "code_sample": "" }, "@roblox/globaltype/Studio.Select Color": { "documentation": "The color of the selection box used with object selections in the Workspace.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Select Color", "code_sample": "" }, "@roblox/globaltype/Studio.Select": { "documentation": "Sets the color of the Model.PrimaryPart selection box.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Select", "code_sample": "" }, "@roblox/globaltype/Studio.Selected Menu Item Background Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Selected Menu Item Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.Selected Text Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Selected Text Color", "code_sample": "" }, "@roblox/globaltype/Studio.Selection Background Color": { "documentation": "Sets the background color of selected text in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Selection Background Color", "code_sample": "" }, "@roblox/globaltype/Studio.Selection Box Thickness": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Selection Box Thickness", "code_sample": "" }, "@roblox/globaltype/Studio.Selection Color": { "documentation": "Sets the text color of selected text in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Selection Color", "code_sample": "" }, "@roblox/globaltype/Studio.Selection Line Thickness": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Selection Line Thickness", "code_sample": "" }, "@roblox/globaltype/Studio.Set Pivot of Imported Parts": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Set Pivot of Imported Parts", "code_sample": "" }, "@roblox/globaltype/Studio.Show Core GUI in Explorer while Playing": { "documentation": "If set to true, the CoreGui will be visible in the Explorer while the game is running.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Core GUI in Explorer while Playing", "code_sample": "" }, "@roblox/globaltype/Studio.Show Diagnostics Bar": { "documentation": "If set to true, basic diagnostic information is shown in the bottom right.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Diagnostics Bar", "code_sample": "" }, "@roblox/globaltype/Studio.Show FileSyncService": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show FileSyncService", "code_sample": "" }, "@roblox/globaltype/Studio.Show Hidden Objects in Explorer": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Hidden Objects in Explorer", "code_sample": "" }, "@roblox/globaltype/Studio.Show Hover Over": { "documentation": "If set to true, hovering over an object in the Workspace will show a selection box.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Hover Over", "code_sample": "" }, "@roblox/globaltype/Studio.Show Light Guides": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Light Guides", "code_sample": "" }, "@roblox/globaltype/Studio.Show Navigation Labels": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Navigation Labels", "code_sample": "" }, "@roblox/globaltype/Studio.Show Navigation Mesh": { "documentation": "When set to true, the navigation mesh used by the PathfindingService will be visualized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Navigation Mesh", "code_sample": "" }, "@roblox/globaltype/Studio.Show Pathfinding Links": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Pathfinding Links", "code_sample": "" }, "@roblox/globaltype/Studio.Show Plugin GUI Service in Explorer": { "documentation": "When set to true, the PluginGuiService will be shown in Roblox Studio's explorer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Plugin GUI Service in Explorer", "code_sample": "" }, "@roblox/globaltype/Studio.Show plus button on hover in Explorer": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show plus button on hover in Explorer", "code_sample": "" }, "@roblox/globaltype/Studio.Show Singly Selected Attachment Parent Frame": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Singly Selected Attachment Parent Frame", "code_sample": "" }, "@roblox/globaltype/Studio.Show Whitespace": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Show Whitespace", "code_sample": "" }, "@roblox/globaltype/Studio.ShowCorePackagesInExplorer": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ShowCorePackagesInExplorer", "code_sample": "" }, "@roblox/globaltype/Studio.Skip Closing Brackets and Quotes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Skip Closing Brackets and Quotes", "code_sample": "" }, "@roblox/globaltype/Studio.String Color": { "documentation": "Specifies the color of strings in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#String Color", "code_sample": "" }, "@roblox/globaltype/Studio.Tab Width": { "documentation": "Specifies how many spaces are used to represent a tab in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Tab Width", "code_sample": "" }, "@roblox/globaltype/Studio.Text Color": { "documentation": "Specifies the color of normal text in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Text Color", "code_sample": "" }, "@roblox/globaltype/Studio.Text Wrapping": { "documentation": "If set to true, text in the script editor will be wrapped.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Text Wrapping", "code_sample": "" }, "@roblox/globaltype/Studio.Theme": { "documentation": "Used to get/set current theme used by Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Theme", "code_sample": "" }, "@roblox/globaltype/Studio.UI Theme": { "documentation": "Deprecated:
Specifies the color scheme of Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#UI Theme", "code_sample": "" }, "@roblox/globaltype/Studio.Use Bounding Box Move Handles": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Use Bounding Box Move Handles", "code_sample": "" }, "@roblox/globaltype/Studio.Warning Color": { "documentation": "Specifies the color of the wavy underline shown when the script analyzer picks up a problem that should be addressed in the script editor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Warning Color", "code_sample": "" }, "@roblox/globaltype/Studio.Whitespace Color": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#Whitespace Color", "code_sample": "" }, "@roblox/globaltype/Studio.GetAvailableThemes/param/0": { "documentation": "" }, "@roblox/globaltype/Studio.GetAvailableThemes/return/0": { "documentation": "A list of themes available in Studio." }, "@roblox/globaltype/Studio.GetAvailableThemes": { "documentation": "Returns a list of themes available in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Studio.GetAvailableThemes/param/0" } ], "returns": [ "@roblox/globaltype/Studio.GetAvailableThemes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#GetAvailableThemes", "code_sample": "local themes = settings().Studio:GetAvailableThemes()\n\nfor _, theme in pairs(themes) do\n\tprint(theme)\nend" }, "@roblox/globaltype/Studio.ThemeChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Studio.ThemeChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Studio.ThemeChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Studio.ThemeChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Studio.ThemeChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Studio.ThemeChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Studio.ThemeChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Studio.ThemeChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Studio.ThemeChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Studio.ThemeChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Studio.ThemeChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Studio.ThemeChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Studio.ThemeChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Studio.ThemeChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Studio.ThemeChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Studio.ThemeChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Studio.ThemeChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Studio.ThemeChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Studio.ThemeChanged": { "documentation": "Event called when Studio's theme changes.", "keys": { "Connect": "@roblox/globaltype/Studio.ThemeChanged.Connect", "ConnectParallel": "@roblox/globaltype/Studio.ThemeChanged.ConnectParallel", "Once": "@roblox/globaltype/Studio.ThemeChanged.Once", "Wait": "@roblox/globaltype/Studio.ThemeChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Studio#ThemeChanged", "code_sample": "" }, "@roblox/globaltype/Skin": { "documentation": "Deprecated: This object has been deprecated and superseded by BodyColors. The Skin object does not function on R15 characters and should not be used for new work. BodyColors functions with R15 characters and allows the colors of each limb to be set individually.
Historically changed the colors of body parts to match the Skin.SkinColor property. Superseded by the BodyColors class.", "keys": { "SkinColor": "@roblox/globaltype/Skin.SkinColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Skin", "code_sample": "" }, "@roblox/globaltype/Skin.SkinColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Skin#SkinColor", "code_sample": "" }, "@roblox/globaltype/Animation": { "documentation": "References an animation asset which can be loaded by an AnimationController.", "keys": { "AnimationId": "@roblox/globaltype/Animation.AnimationId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animation", "code_sample": "" }, "@roblox/globaltype/Animation.AnimationId": { "documentation": "Asset ID of the animation an Animation object is referencing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Animation#AnimationId", "code_sample": "" }, "@roblox/globaltype/PhysicsService": { "documentation": "", "keys": { "CollisionGroupContainsPart": "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart", "CollisionGroupsAreCollidable": "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable", "CollisionGroupSetCollidable": "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable", "CreateCollisionGroup": "@roblox/globaltype/PhysicsService.CreateCollisionGroup", "GetCollisionGroupId": "@roblox/globaltype/PhysicsService.GetCollisionGroupId", "GetCollisionGroupName": "@roblox/globaltype/PhysicsService.GetCollisionGroupName", "GetCollisionGroups": "@roblox/globaltype/PhysicsService.GetCollisionGroups", "GetMaxCollisionGroups": "@roblox/globaltype/PhysicsService.GetMaxCollisionGroups", "GetRegisteredCollisionGroups": "@roblox/globaltype/PhysicsService.GetRegisteredCollisionGroups", "IsCollisionGroupRegistered": "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered", "RegisterCollisionGroup": "@roblox/globaltype/PhysicsService.RegisterCollisionGroup", "RemoveCollisionGroup": "@roblox/globaltype/PhysicsService.RemoveCollisionGroup", "RenameCollisionGroup": "@roblox/globaltype/PhysicsService.RenameCollisionGroup", "SetPartCollisionGroup": "@roblox/globaltype/PhysicsService.SetPartCollisionGroup", "UnregisterCollisionGroup": "@roblox/globaltype/PhysicsService.UnregisterCollisionGroup" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService", "code_sample": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/param/2": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart": { "documentation": "Deprecated: This method has been deprecated. It's recommended that you query a part's collision group through its CollisionGroup property.
Returns whether the part is in the collision group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/param/1" }, { "name": "part", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/param/2" } ], "returns": [ "@roblox/globaltype/PhysicsService.CollisionGroupContainsPart/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CollisionGroupContainsPart", "code_sample": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/param/2": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable": { "documentation": "Returns whether the two groups will collide.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/param/0" }, { "name": "name1", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/param/1" }, { "name": "name2", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/param/2" } ], "returns": [ "@roblox/globaltype/PhysicsService.CollisionGroupsAreCollidable/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CollisionGroupsAreCollidable", "code_sample": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/2": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/3": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable": { "documentation": "Sets the collision status between two groups.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/0" }, { "name": "name1", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/1" }, { "name": "name2", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/2" }, { "name": "collidable", "documentation": "@roblox/globaltype/PhysicsService.CollisionGroupSetCollidable/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CollisionGroupSetCollidable", "code_sample": "" }, "@roblox/globaltype/PhysicsService.CreateCollisionGroup/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CreateCollisionGroup/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CreateCollisionGroup/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.CreateCollisionGroup": { "documentation": "Deprecated: This method has been superseded by RegisterCollisionGroup() which should be used for all new work.
Creates a new collision group with the given name, and returns the ID of the created group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.CreateCollisionGroup/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.CreateCollisionGroup/param/1" } ], "returns": [ "@roblox/globaltype/PhysicsService.CreateCollisionGroup/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#CreateCollisionGroup", "code_sample": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroupId/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroupId/param/1": { "documentation": "The name of the collision group being retrieved." }, "@roblox/globaltype/PhysicsService.GetCollisionGroupId/return/0": { "documentation": "The ID of the retrieved collision group, or nil if no such group exists." }, "@roblox/globaltype/PhysicsService.GetCollisionGroupId": { "documentation": "Deprecated: This method has been deprecated. It's recommended that you query collision groups by name through a part's CollisionGroup property.
Returns the ID of the collision group with the specified name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.GetCollisionGroupId/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.GetCollisionGroupId/param/1" } ], "returns": [ "@roblox/globaltype/PhysicsService.GetCollisionGroupId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroupId", "code_sample": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroupName/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroupName/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroupName/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroupName": { "documentation": "Deprecated: This method has been deprecated. It's recommended that you query collision groups by name through a part's CollisionGroup property.
Returns the name of the group with the corresponding ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.GetCollisionGroupName/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.GetCollisionGroupName/param/1" } ], "returns": [ "@roblox/globaltype/PhysicsService.GetCollisionGroupName/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroupName", "code_sample": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroups/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroups/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetCollisionGroups": { "documentation": "Deprecated: This method has been superseded by GetRegisteredCollisionGroups() which should be used for all new work.
Returns a table with info on all of the place's collision groups.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.GetCollisionGroups/param/0" } ], "returns": [ "@roblox/globaltype/PhysicsService.GetCollisionGroups/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetCollisionGroups", "code_sample": "" }, "@roblox/globaltype/PhysicsService.GetMaxCollisionGroups/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetMaxCollisionGroups/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetMaxCollisionGroups": { "documentation": "Returns the maximum number of collision groups.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.GetMaxCollisionGroups/param/0" } ], "returns": [ "@roblox/globaltype/PhysicsService.GetMaxCollisionGroups/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetMaxCollisionGroups", "code_sample": "" }, "@roblox/globaltype/PhysicsService.GetRegisteredCollisionGroups/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetRegisteredCollisionGroups/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.GetRegisteredCollisionGroups": { "documentation": "Returns a table with info on all of the place's collision groups.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.GetRegisteredCollisionGroups/param/0" } ], "returns": [ "@roblox/globaltype/PhysicsService.GetRegisteredCollisionGroups/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#GetRegisteredCollisionGroups", "code_sample": "" }, "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered/return/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered": { "documentation": "Checks if a collision group is registered.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered/param/1" } ], "returns": [ "@roblox/globaltype/PhysicsService.IsCollisionGroupRegistered/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#IsCollisionGroupRegistered", "code_sample": "" }, "@roblox/globaltype/PhysicsService.RegisterCollisionGroup/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RegisterCollisionGroup/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RegisterCollisionGroup": { "documentation": "Registers a new collision group with the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.RegisterCollisionGroup/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.RegisterCollisionGroup/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#RegisterCollisionGroup", "code_sample": "" }, "@roblox/globaltype/PhysicsService.RemoveCollisionGroup/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RemoveCollisionGroup/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RemoveCollisionGroup": { "documentation": "Deprecated: This method has been superseded by UnregisterCollisionGroup() which should be used for all new work.
Removes the collision group with the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.RemoveCollisionGroup/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.RemoveCollisionGroup/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#RemoveCollisionGroup", "code_sample": "" }, "@roblox/globaltype/PhysicsService.RenameCollisionGroup/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RenameCollisionGroup/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RenameCollisionGroup/param/2": { "documentation": "" }, "@roblox/globaltype/PhysicsService.RenameCollisionGroup": { "documentation": "Renames specified collision group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.RenameCollisionGroup/param/0" }, { "name": "from", "documentation": "@roblox/globaltype/PhysicsService.RenameCollisionGroup/param/1" }, { "name": "to", "documentation": "@roblox/globaltype/PhysicsService.RenameCollisionGroup/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#RenameCollisionGroup", "code_sample": "" }, "@roblox/globaltype/PhysicsService.SetPartCollisionGroup/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.SetPartCollisionGroup/param/1": { "documentation": "The part being set." }, "@roblox/globaltype/PhysicsService.SetPartCollisionGroup/param/2": { "documentation": "The name of collision group that the part's collision group is being set to." }, "@roblox/globaltype/PhysicsService.SetPartCollisionGroup": { "documentation": "Deprecated: This method has been deprecated. It's recommended that you set a part's collision group by name through its CollisionGroup property.
Sets the collision group of a part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.SetPartCollisionGroup/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/PhysicsService.SetPartCollisionGroup/param/1" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.SetPartCollisionGroup/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#SetPartCollisionGroup", "code_sample": "" }, "@roblox/globaltype/PhysicsService.UnregisterCollisionGroup/param/0": { "documentation": "" }, "@roblox/globaltype/PhysicsService.UnregisterCollisionGroup/param/1": { "documentation": "" }, "@roblox/globaltype/PhysicsService.UnregisterCollisionGroup": { "documentation": "Unregisters the collision group for the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PhysicsService.UnregisterCollisionGroup/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/PhysicsService.UnregisterCollisionGroup/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PhysicsService#UnregisterCollisionGroup", "code_sample": "" }, "@roblox/globaltype/MatchmakingService": { "documentation": "The service responsible for managing custom matchmaking data.", "keys": { "GetServerAttribute": "@roblox/globaltype/MatchmakingService.GetServerAttribute", "InitializeServerAttributesForStudio": "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio", "SetServerAttribute": "@roblox/globaltype/MatchmakingService.SetServerAttribute" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MatchmakingService", "code_sample": "" }, "@roblox/globaltype/MatchmakingService.GetServerAttribute/param/0": { "documentation": "The service responsible for managing custom matchmaking data." }, "@roblox/globaltype/MatchmakingService.GetServerAttribute/param/1": { "documentation": "The name of the server attribute. Limited to a maximum of 50 characters." }, "@roblox/globaltype/MatchmakingService.GetServerAttribute/return/0": { "documentation": "Returns the server attribute value if the attribute is found and if the error is nil. Otherwise, returns nil for the attribute value and an error message." }, "@roblox/globaltype/MatchmakingService.GetServerAttribute": { "documentation": "Retrieves the value of a specific server attribute.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MatchmakingService.GetServerAttribute/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/MatchmakingService.GetServerAttribute/param/1" } ], "returns": [ "@roblox/globaltype/MatchmakingService.GetServerAttribute/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#GetServerAttribute", "code_sample": "" }, "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio/param/0": { "documentation": "The service responsible for managing custom matchmaking data." }, "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio/param/1": { "documentation": "An array of attribute name-value pairs." }, "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio/return/0": { "documentation": "Returns true if the call succeeded. Otherwise, returns false and an error message." }, "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio": { "documentation": "Initiates the server attribute schema and its values to test in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio/param/0" }, { "name": "serverAttributes", "documentation": "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio/param/1" } ], "returns": [ "@roblox/globaltype/MatchmakingService.InitializeServerAttributesForStudio/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#InitializeServerAttributesForStudio", "code_sample": "" }, "@roblox/globaltype/MatchmakingService.SetServerAttribute/param/0": { "documentation": "The service responsible for managing custom matchmaking data." }, "@roblox/globaltype/MatchmakingService.SetServerAttribute/param/1": { "documentation": "The name of the server attribute. Limited to a maximum of 50 characters." }, "@roblox/globaltype/MatchmakingService.SetServerAttribute/param/2": { "documentation": "The value of the server attribute. Limited to a maximum of 50 characters." }, "@roblox/globaltype/MatchmakingService.SetServerAttribute/return/0": { "documentation": "Returns true if the call succeeded. Otherwise, returns false and an error message." }, "@roblox/globaltype/MatchmakingService.SetServerAttribute": { "documentation": "Assigns a value to a specific server attribute.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MatchmakingService.SetServerAttribute/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/MatchmakingService.SetServerAttribute/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/MatchmakingService.SetServerAttribute/param/2" } ], "returns": [ "@roblox/globaltype/MatchmakingService.SetServerAttribute/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MatchmakingService#SetServerAttribute", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGui": { "documentation": "", "keys": { "HostWidgetWasRestored": "@roblox/globaltype/DockWidgetPluginGui.HostWidgetWasRestored" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DockWidgetPluginGui", "code_sample": "" }, "@roblox/globaltype/DockWidgetPluginGui.HostWidgetWasRestored": { "documentation": "Describes whether the previous state of this DockWidgetPluginGui was restored when it was created.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DockWidgetPluginGui#HostWidgetWasRestored", "code_sample": "" }, "@roblox/globaltype/UILayout": { "documentation": "The base class for UI layout classes.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UILayout", "code_sample": "" }, "@roblox/globaltype/CollectionService": { "documentation": "A service which manages instance collections using assigned tags.", "keys": { "AddTag": "@roblox/globaltype/CollectionService.AddTag", "GetAllTags": "@roblox/globaltype/CollectionService.GetAllTags", "GetCollection": "@roblox/globaltype/CollectionService.GetCollection", "GetInstanceAddedSignal": "@roblox/globaltype/CollectionService.GetInstanceAddedSignal", "GetInstanceRemovedSignal": "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal", "GetTagged": "@roblox/globaltype/CollectionService.GetTagged", "GetTags": "@roblox/globaltype/CollectionService.GetTags", "HasTag": "@roblox/globaltype/CollectionService.HasTag", "RemoveTag": "@roblox/globaltype/CollectionService.RemoveTag" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService", "code_sample": "" }, "@roblox/globaltype/CollectionService.AddTag/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.AddTag/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.AddTag/param/2": { "documentation": "" }, "@roblox/globaltype/CollectionService.AddTag": { "documentation": "Applies a tag to an Instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.AddTag/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/CollectionService.AddTag/param/1" }, { "name": "tag", "documentation": "@roblox/globaltype/CollectionService.AddTag/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#AddTag", "code_sample": "" }, "@roblox/globaltype/CollectionService.GetAllTags/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.GetAllTags/return/0": { "documentation": "" }, "@roblox/globaltype/CollectionService.GetAllTags": { "documentation": "Returns an array of all tags in the experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.GetAllTags/param/0" } ], "returns": [ "@roblox/globaltype/CollectionService.GetAllTags/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetAllTags", "code_sample": "" }, "@roblox/globaltype/CollectionService.GetCollection/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.GetCollection/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.GetCollection/return/0": { "documentation": "" }, "@roblox/globaltype/CollectionService.GetCollection": { "documentation": "Deprecated: This item has been superseded by a CollectionService tagging method. The equivalent function using the new method is CollectionService:GetTagged() which should be used in new work.
Returns all instances of a given class which are in the DataModel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.GetCollection/param/0" }, { "name": "class", "documentation": "@roblox/globaltype/CollectionService.GetCollection/param/1" } ], "returns": [ "@roblox/globaltype/CollectionService.GetCollection/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetCollection", "code_sample": "local CollectionService = game:GetService(\"CollectionService\")\n\nfor _index = 1, 10 do\n\tlocal configuration = Instance.new(\"Configuration\")\n\tconfiguration.Parent = workspace\nend\n\nlocal objects = CollectionService:GetCollection(\"Configuration\")\nprint(#objects)" }, "@roblox/globaltype/CollectionService.GetInstanceAddedSignal/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.GetInstanceAddedSignal/param/1": { "documentation": "The tag to watch for." }, "@roblox/globaltype/CollectionService.GetInstanceAddedSignal/return/0": { "documentation": "An event that fires when you add the tag to an instance." }, "@roblox/globaltype/CollectionService.GetInstanceAddedSignal": { "documentation": "Returns a signal that fires when a given tag is added to an instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.GetInstanceAddedSignal/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/CollectionService.GetInstanceAddedSignal/param/1" } ], "returns": [ "@roblox/globaltype/CollectionService.GetInstanceAddedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetInstanceAddedSignal", "code_sample": "" }, "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal/param/1": { "documentation": "The tag to watch for." }, "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal/return/0": { "documentation": "An event that fires when you remove the tag from an instance." }, "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal": { "documentation": "Returns a signal that fires when a given tag is removed from an instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal/param/1" } ], "returns": [ "@roblox/globaltype/CollectionService.GetInstanceRemovedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetInstanceRemovedSignal", "code_sample": "" }, "@roblox/globaltype/CollectionService.GetTagged/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.GetTagged/param/1": { "documentation": "The tag to search for." }, "@roblox/globaltype/CollectionService.GetTagged/return/0": { "documentation": "An array of all instances with the tag." }, "@roblox/globaltype/CollectionService.GetTagged": { "documentation": "Returns an array of instances in the game with a given tag.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.GetTagged/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/CollectionService.GetTagged/param/1" } ], "returns": [ "@roblox/globaltype/CollectionService.GetTagged/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetTagged", "code_sample": "" }, "@roblox/globaltype/CollectionService.GetTags/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.GetTags/param/1": { "documentation": "The instance whose tags should be returned." }, "@roblox/globaltype/CollectionService.GetTags/return/0": { "documentation": "An array of strings which are the tags applied to the given instance." }, "@roblox/globaltype/CollectionService.GetTags": { "documentation": "Gets an array of all tags applied to a given instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.GetTags/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/CollectionService.GetTags/param/1" } ], "returns": [ "@roblox/globaltype/CollectionService.GetTags/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#GetTags", "code_sample": "" }, "@roblox/globaltype/CollectionService.HasTag/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.HasTag/param/1": { "documentation": "The instance to check for the presence of a tag." }, "@roblox/globaltype/CollectionService.HasTag/param/2": { "documentation": "The tag to check for." }, "@roblox/globaltype/CollectionService.HasTag/return/0": { "documentation": "Whether the instance has the tag." }, "@roblox/globaltype/CollectionService.HasTag": { "documentation": "Check whether an instance has a given tag.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.HasTag/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/CollectionService.HasTag/param/1" }, { "name": "tag", "documentation": "@roblox/globaltype/CollectionService.HasTag/param/2" } ], "returns": [ "@roblox/globaltype/CollectionService.HasTag/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#HasTag", "code_sample": "" }, "@roblox/globaltype/CollectionService.RemoveTag/param/0": { "documentation": "A service which manages instance collections using assigned tags." }, "@roblox/globaltype/CollectionService.RemoveTag/param/1": { "documentation": "The instance to remove the tag from." }, "@roblox/globaltype/CollectionService.RemoveTag/param/2": { "documentation": "The tag to remove from the instance." }, "@roblox/globaltype/CollectionService.RemoveTag": { "documentation": "Removes a tag from an instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.RemoveTag/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/CollectionService.RemoveTag/param/1" }, { "name": "tag", "documentation": "@roblox/globaltype/CollectionService.RemoveTag/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#RemoveTag", "code_sample": "" }, "@roblox/globaltype/CollectionService.ItemAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.ItemAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.ItemAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.ItemAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemAdded": { "documentation": "Deprecated: This item has been superseded by a CollectionService tagging method. There is currently no means of checking when a tag is added.
Fires when a Configuration, CustomEvent, CustomEventReceiver, Dialog, or VehicleSeat is added to the DataModel.", "keys": { "Connect": "@roblox/globaltype/CollectionService.ItemAdded.Connect", "ConnectParallel": "@roblox/globaltype/CollectionService.ItemAdded.ConnectParallel", "Once": "@roblox/globaltype/CollectionService.ItemAdded.Once", "Wait": "@roblox/globaltype/CollectionService.ItemAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemAdded", "code_sample": "" }, "@roblox/globaltype/CollectionService.ItemRemoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemRemoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.ItemRemoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemRemoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemRemoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.ItemRemoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemRemoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemRemoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.ItemRemoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemRemoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.ItemRemoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.ItemRemoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CollectionService.ItemRemoved": { "documentation": "Deprecated: This item has been superseded by a CollectionService tagging method. There is currently no means of checking when a tag is removed.
Fires when a Configuration, CustomEvent, CustomEventReceiver, Dialog, or VehicleSeat is removed from the DataModel.", "keys": { "Connect": "@roblox/globaltype/CollectionService.ItemRemoved.Connect", "ConnectParallel": "@roblox/globaltype/CollectionService.ItemRemoved.ConnectParallel", "Once": "@roblox/globaltype/CollectionService.ItemRemoved.Once", "Wait": "@roblox/globaltype/CollectionService.ItemRemoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#ItemRemoved", "code_sample": "local CollectionService = game:GetService(\"CollectionService\")\n\nCollectionService.ItemRemoved:Connect(function(instance)\n\tprint(instance.ClassName .. \" removed from the DataModel\")\nend)\n\nlocal part = Instance.new(\"Part\")\npart.Parent = workspace\npart:Destroy() --// Doesn't fire because CollectionService ignores Parts\n\nlocal dialog = Instance.new(\"Dialog\")\ndialog.Parent = workspace\ndialog:Destroy() --> Dialog removed from the DataModel" }, "@roblox/globaltype/CollectionService.TagAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.TagAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.TagAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.TagAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.TagAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.TagAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.TagAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagAdded": { "documentation": "Fires when a tag is added to an instance and the added tag is the only occurrence of that tag in the place.", "keys": { "Connect": "@roblox/globaltype/CollectionService.TagAdded.Connect", "ConnectParallel": "@roblox/globaltype/CollectionService.TagAdded.ConnectParallel", "Once": "@roblox/globaltype/CollectionService.TagAdded.Once", "Wait": "@roblox/globaltype/CollectionService.TagAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#TagAdded", "code_sample": "" }, "@roblox/globaltype/CollectionService.TagRemoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagRemoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.TagRemoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagRemoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagRemoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.TagRemoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagRemoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagRemoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CollectionService.TagRemoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagRemoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CollectionService.TagRemoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CollectionService.TagRemoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CollectionService.TagRemoved": { "documentation": "Fires when a tag is removed from an instance and the removed tag is no longer used anywhere in the place.", "keys": { "Connect": "@roblox/globaltype/CollectionService.TagRemoved.Connect", "ConnectParallel": "@roblox/globaltype/CollectionService.TagRemoved.ConnectParallel", "Once": "@roblox/globaltype/CollectionService.TagRemoved.Once", "Wait": "@roblox/globaltype/CollectionService.TagRemoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CollectionService#TagRemoved", "code_sample": "" }, "@roblox/globaltype/MemoryStoreHashMap": { "documentation": "Provides access to a hash map within MemoryStoreService.", "keys": { "GetAsync": "@roblox/globaltype/MemoryStoreHashMap.GetAsync", "ListItemsAsync": "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync", "RemoveAsync": "@roblox/globaltype/MemoryStoreHashMap.RemoveAsync", "SetAsync": "@roblox/globaltype/MemoryStoreHashMap.SetAsync", "UpdateAsync": "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMap", "code_sample": "" }, "@roblox/globaltype/MemoryStoreHashMap.GetAsync/param/0": { "documentation": "Provides access to a hash map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreHashMap.GetAsync/param/1": { "documentation": "The key whose value you want to retrieve." }, "@roblox/globaltype/MemoryStoreHashMap.GetAsync/return/0": { "documentation": "The value, or nil if the key doesn't exist." }, "@roblox/globaltype/MemoryStoreHashMap.GetAsync": { "documentation": "Retrieves the value of a key in the hash map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreHashMap.GetAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreHashMap.GetAsync/param/1" } ], "returns": [ "@roblox/globaltype/MemoryStoreHashMap.GetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMap#GetAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\n\nlocal hashMap = MemoryStoreService:GetHashMap(\"HashMap1\")\n\nlocal key = \"User_1234\"\nlocal value = 1000\nlocal expiration = 30\n\nlocal setSuccess, _ = pcall(function()\n\treturn hashMap:SetAsync(key, value, expiration)\nend)\n\nif setSuccess then\n\tprint(\"Set succeeded!\")\nend\n\nlocal item\nlocal getSuccess, getError = pcall(function()\n\titem = hashMap:GetAsync(key)\nend)\n\nif getSuccess then\n\tprint(item)\nelse\n\twarn(getError)\nend" }, "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync/param/0": { "documentation": "Provides access to a hash map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync/param/1": { "documentation": "Maximum possible number of items that can be returned." }, "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync/return/0": { "documentation": "A MemoryStoreHashMapPages instance that enumerates the items as MemoryStoreHashMapPages instances." }, "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync": { "documentation": "Returns a MemoryStoreHashMapPages object for enumerating through items in the hash map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync/param/0" }, { "name": "count", "documentation": "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync/param/1" } ], "returns": [ "@roblox/globaltype/MemoryStoreHashMap.ListItemsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMap#ListItemsAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreHashMap.RemoveAsync/param/0": { "documentation": "Provides access to a hash map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreHashMap.RemoveAsync/param/1": { "documentation": "The key to remove." }, "@roblox/globaltype/MemoryStoreHashMap.RemoveAsync": { "documentation": "Removes an item from the hash map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreHashMap.RemoveAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreHashMap.RemoveAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMap#RemoveAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\n\nlocal hashMap = MemoryStoreService:GetHashMap(\"HashMap1\")\n\nlocal key = \"User_1234\"\nlocal value = 1000\nlocal expiration = 30\n\nlocal setSuccess, setError = pcall(function()\n\treturn hashMap:SetAsync(key, value, expiration)\nend)\n\nif not setSuccess then\n\twarn(setError)\nend\n\nlocal removeSuccess, removeError = pcall(function()\n\thashMap:RemoveAsync(key)\nend)\n\nif removeSuccess then\n\tprint(\"Remove succeeded!\")\nelse\n\twarn(removeError)\nend" }, "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/0": { "documentation": "Provides access to a hash map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/1": { "documentation": "The key whose value to set." }, "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/2": { "documentation": "The value to set." }, "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/3": { "documentation": "Item expiration in seconds, after which the item is automatically removed from the hash map. The maximum expiration time is 45 days (3,888,000 seconds)." }, "@roblox/globaltype/MemoryStoreHashMap.SetAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MemoryStoreHashMap.SetAsync": { "documentation": "Sets the value of a key in the hash map.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/2" }, { "name": "expiration", "documentation": "@roblox/globaltype/MemoryStoreHashMap.SetAsync/param/3" } ], "returns": [ "@roblox/globaltype/MemoryStoreHashMap.SetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMap#SetAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\n\nlocal hashMap = MemoryStoreService:GetHashMap(\"HashMap1\")\n\nlocal key = \"User_1234\"\nlocal value = 1000\nlocal expiration = 30\n\nlocal setSuccess, setError = pcall(function()\n\treturn hashMap:SetAsync(key, value, expiration)\nend)\n\nif setSuccess then\n\tprint(\"Set succeeded!\")\nelse\n\twarn(setError)\nend" }, "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/0": { "documentation": "Provides access to a hash map within MemoryStoreService." }, "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/1": { "documentation": "The key whose value you want to update." }, "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/2": { "documentation": "The transform function, which you provide. This function takes the old value as an input and returns the new value." }, "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/3": { "documentation": "Item expiration in seconds, after which the item is automatically removed from the hash map. The maximum expiration time is 45 days (3,888,000 seconds)." }, "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/return/0": { "documentation": "The last value returned by the transform function." }, "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync": { "documentation": "Retrieves the value of a key from a hash map and lets you update it to a new value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/1" }, { "name": "transformFunction", "documentation": "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/2" }, { "name": "expiration", "documentation": "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/param/3" } ], "returns": [ "@roblox/globaltype/MemoryStoreHashMap.UpdateAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreHashMap#UpdateAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\nlocal hashMap = MemoryStoreService:GetHashMap(\"ResourceInventory\")\n\nlocal function contributeResources(itemResource, addedCount)\n\tlocal success, newResourceCount = pcall(function()\n\t\treturn hashMap:UpdateAsync(itemResource, function(resource)\n\t\t\tresource = resource or { count = 0 }\n\t\t\tresource.count = resource.count + addedCount\n\n\t\t\t-- ensure we don't exceed the maximum resource count\n\t\t\tif resource.count > 500 then\n\t\t\t\tresource.count = 500\n\t\t\tend\n\t\t\treturn resource\n\t\tend, 1200)\n\tend)\n\tif success then\n\t\tprint(newResourceCount)\n\tend\nend\n\ncontributeResources(\"myResource\", 50)" }, "@roblox/globaltype/GuidRegistryService": { "documentation": "An internal service, whose functionality is not accessible to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuidRegistryService", "code_sample": "" }, "@roblox/globaltype/FileMesh": { "documentation": "The FileMesh object applies a mesh to a BasePart when parented to it. Its properties are inherited by the SpecialMesh object.", "keys": { "MeshId": "@roblox/globaltype/FileMesh.MeshId", "TextureId": "@roblox/globaltype/FileMesh.TextureId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FileMesh", "code_sample": "" }, "@roblox/globaltype/FileMesh.MeshId": { "documentation": "The MeshId is the content ID of the mesh that is to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FileMesh#MeshId", "code_sample": "" }, "@roblox/globaltype/FileMesh.TextureId": { "documentation": "The TextureId is the content ID of the texture that is to be applied to the mesh.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FileMesh#TextureId", "code_sample": "" }, "@roblox/globaltype/AudioListener": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world.", "keys": { "AcousticSimulationEnabled": "@roblox/globaltype/AudioListener.AcousticSimulationEnabled", "AngleAttenuation": "@roblox/globaltype/AudioListener.AngleAttenuation", "AudioInteractionGroup": "@roblox/globaltype/AudioListener.AudioInteractionGroup", "DistanceAttenuation": "@roblox/globaltype/AudioListener.DistanceAttenuation", "PositionOverride": "@roblox/globaltype/AudioListener.PositionOverride", "SimulationFidelity": "@roblox/globaltype/AudioListener.SimulationFidelity", "GetAngleAttenuation": "@roblox/globaltype/AudioListener.GetAngleAttenuation", "GetAudibilityFor": "@roblox/globaltype/AudioListener.GetAudibilityFor", "GetConnectedWires": "@roblox/globaltype/AudioListener.GetConnectedWires", "GetDistanceAttenuation": "@roblox/globaltype/AudioListener.GetDistanceAttenuation", "GetInputPins": "@roblox/globaltype/AudioListener.GetInputPins", "GetInteractingEmitters": "@roblox/globaltype/AudioListener.GetInteractingEmitters", "GetOutputPins": "@roblox/globaltype/AudioListener.GetOutputPins", "SetAngleAttenuation": "@roblox/globaltype/AudioListener.SetAngleAttenuation", "SetDistanceAttenuation": "@roblox/globaltype/AudioListener.SetDistanceAttenuation" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener", "code_sample": "local listener = Instance.new(\"AudioListener\")\nlocal output = Instance.new(\"AudioDeviceOutput\")\nlocal wire = Instance.new(\"Wire\")\n\nlistener.Parent = workspace.Camera\nwire.Parent = listener\noutput.Parent = wire\n\nwire.SourceInstance = listener\nwire.TargetInstance = output" }, "@roblox/globaltype/AudioListener.AcousticSimulationEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#AcousticSimulationEnabled", "code_sample": "" }, "@roblox/globaltype/AudioListener.AngleAttenuation": { "documentation": "Represents how the perceived volume of the emitted sound changes based on the angle between a AudioEmitter and the LookVector associated with the AudioListener.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#AngleAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioListener.AudioInteractionGroup": { "documentation": "Controls which AudioEmitters are audible to this AudioListener.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#AudioInteractionGroup", "code_sample": "" }, "@roblox/globaltype/AudioListener.DistanceAttenuation": { "documentation": "Represents how the perceived volume of emitted sounds change as the distance between AudioEmitters and the AudioListener increases.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#DistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioListener.PositionOverride": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#PositionOverride", "code_sample": "" }, "@roblox/globaltype/AudioListener.SimulationFidelity": { "documentation": "Deprecated:
Controls how detailed the audio simulation should be for this AudioListener.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#SimulationFidelity", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetAngleAttenuation/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetAngleAttenuation/return/0": { "documentation": "Table mapping angle to volume, as described above." }, "@roblox/globaltype/AudioListener.GetAngleAttenuation": { "documentation": "Gets the angle attenuation curve that the AudioListener is using, or an empty table if it's using the default curve.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetAngleAttenuation/param/0" } ], "returns": [ "@roblox/globaltype/AudioListener.GetAngleAttenuation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetAngleAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetAudibilityFor/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetAudibilityFor/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetAudibilityFor/return/0": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetAudibilityFor": { "documentation": "Calculates how audible an AudioEmitter is for this listener", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetAudibilityFor/param/0" }, { "name": "emitter", "documentation": "@roblox/globaltype/AudioListener.GetAudibilityFor/param/1" } ], "returns": [ "@roblox/globaltype/AudioListener.GetAudibilityFor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetAudibilityFor", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetConnectedWires/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioListener.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioListener.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetDistanceAttenuation/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetDistanceAttenuation/return/0": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetDistanceAttenuation": { "documentation": "Gets the distance attenuation curve that the AudioListener is using, or an empty table if it's using the default curve.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetDistanceAttenuation/param/0" } ], "returns": [ "@roblox/globaltype/AudioListener.GetDistanceAttenuation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetDistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetInputPins/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioListener.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetInteractingEmitters/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetInteractingEmitters/return/0": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetInteractingEmitters": { "documentation": "Lists all AudioEmitters that this listener is capable of hearing.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetInteractingEmitters/param/0" } ], "returns": [ "@roblox/globaltype/AudioListener.GetInteractingEmitters/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetInteractingEmitters", "code_sample": "" }, "@roblox/globaltype/AudioListener.GetOutputPins/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioListener.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioListener.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioListener.SetAngleAttenuation/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.SetAngleAttenuation/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.SetAngleAttenuation": { "documentation": "Sets the angle attenuation curve that the AudioListener should use, or uses a constant curve of volume 1 if none is provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.SetAngleAttenuation/param/0" }, { "name": "curve", "documentation": "@roblox/globaltype/AudioListener.SetAngleAttenuation/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#SetAngleAttenuation", "code_sample": "local Workspace = game:GetService(\"Workspace\")\n\nlocal currentCamera = Workspace.CurrentCamera\n\nlocal listener = Instance.new(\"AudioListener\")\nlistener.Parent = currentCamera\nlocal wire = Instance.new(\"Wire\")\nwire.Parent = listener\nlocal output = Instance.new(\"AudioDeviceOutput\")\noutput.Parent = wire\n\nlistener:SetAngleAttenuation({\n\t[0] = 1, -- Emitters directly in front of the listener will be full volume\n\t[180] = 0.5 -- Emitters directly behind the listener will be half volume\n})\n\nwire.SourceInstance = listener\nwire.TargetInstance = output" }, "@roblox/globaltype/AudioListener.SetDistanceAttenuation/param/0": { "documentation": "Records an audio stream from its surrounding AudioEmitters in the 3D world." }, "@roblox/globaltype/AudioListener.SetDistanceAttenuation/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.SetDistanceAttenuation": { "documentation": "Sets the distance attenuation curve that the AudioListener should use, or uses an inverse rolloff curve if none is provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.SetDistanceAttenuation/param/0" }, { "name": "curve", "documentation": "@roblox/globaltype/AudioListener.SetDistanceAttenuation/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#SetDistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioListener.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioListener.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioListener.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioListener.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioListener.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioListener.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioListener.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioListener.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioListener.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioListener.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioListener.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioListener via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioListener.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioListener.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioListener.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioListener.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioListener#WiringChanged", "code_sample": "" }, "@roblox/globaltype/TriangleMeshPart": { "documentation": "Abstract intermediate class that manages physical geometry properties for PartOperations and MeshParts.", "keys": { "CollisionFidelity": "@roblox/globaltype/TriangleMeshPart.CollisionFidelity", "FluidFidelity": "@roblox/globaltype/TriangleMeshPart.FluidFidelity", "MeshSize": "@roblox/globaltype/TriangleMeshPart.MeshSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart", "code_sample": "" }, "@roblox/globaltype/TriangleMeshPart.CollisionFidelity": { "documentation": "Determines the level of detail the part's physics will adhere to its mesh.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#CollisionFidelity", "code_sample": "" }, "@roblox/globaltype/TriangleMeshPart.FluidFidelity": { "documentation": "Determines the geometric representation used to compute aerodynamic forces and torques.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#FluidFidelity", "code_sample": "" }, "@roblox/globaltype/TriangleMeshPart.MeshSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TriangleMeshPart#MeshSize", "code_sample": "" }, "@roblox/globaltype/ImageHandleAdornment": { "documentation": "An image handle that can be adorned to a BasePart.", "keys": { "Image": "@roblox/globaltype/ImageHandleAdornment.Image", "Size": "@roblox/globaltype/ImageHandleAdornment.Size" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment", "code_sample": "" }, "@roblox/globaltype/ImageHandleAdornment.Image": { "documentation": "Image to draw for the adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#Image", "code_sample": "" }, "@roblox/globaltype/ImageHandleAdornment.Size": { "documentation": "Size of the image in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ImageHandleAdornment#Size", "code_sample": "" }, "@roblox/globaltype/UGCValidationService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UGCValidationService", "code_sample": "" }, "@roblox/globaltype/RodConstraint": { "documentation": "Keeps two attachments separated by its defined Length.", "keys": { "CurrentDistance": "@roblox/globaltype/RodConstraint.CurrentDistance", "Length": "@roblox/globaltype/RodConstraint.Length", "LimitAngle0": "@roblox/globaltype/RodConstraint.LimitAngle0", "LimitAngle1": "@roblox/globaltype/RodConstraint.LimitAngle1", "LimitsEnabled": "@roblox/globaltype/RodConstraint.LimitsEnabled", "Thickness": "@roblox/globaltype/RodConstraint.Thickness" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint", "code_sample": "" }, "@roblox/globaltype/RodConstraint.CurrentDistance": { "documentation": "The current distance between the constraint's Attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint#CurrentDistance", "code_sample": "" }, "@roblox/globaltype/RodConstraint.Length": { "documentation": "The distance apart at which the constraint attempts to keep its Attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint#Length", "code_sample": "" }, "@roblox/globaltype/RodConstraint.LimitAngle0": { "documentation": "The maximum angle between the rod and Attachment0 when LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint#LimitAngle0", "code_sample": "" }, "@roblox/globaltype/RodConstraint.LimitAngle1": { "documentation": "The maximum angle between the rod and Attachment1 when LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint#LimitAngle1", "code_sample": "" }, "@roblox/globaltype/RodConstraint.LimitsEnabled": { "documentation": "Determines whether LimitAngle0 and LimitAngle1 control the angles between the rod and the respective attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/RodConstraint.Thickness": { "documentation": "The visualized thickness of the RodConstraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RodConstraint#Thickness", "code_sample": "" }, "@roblox/globaltype/Rotate": { "documentation": "Deprecated: This class works alongside the deprecated SurfaceType and should not be used for future work; use HingeConstraint instead.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Rotate", "code_sample": "" }, "@roblox/globaltype/TeamCreateData": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeamCreateData", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataEnum": { "documentation": "Registers information about an Enum and its EnumItems.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataEnum", "code_sample": "" }, "@roblox/globaltype/HiddenSurfaceRemovalAsset": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HiddenSurfaceRemovalAsset", "code_sample": "" }, "@roblox/globaltype/PrismaticConstraint": { "documentation": "Constraint which creates a rigid joint between two Attachments, allowing them to slide along one axis but not rotate.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PrismaticConstraint", "code_sample": "" }, "@roblox/globaltype/ShirtGraphic": { "documentation": "Applies a texture to the front surface of a character's torso, used to display t-shirts.", "keys": { "Color3": "@roblox/globaltype/ShirtGraphic.Color3", "Graphic": "@roblox/globaltype/ShirtGraphic.Graphic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic", "code_sample": "" }, "@roblox/globaltype/ShirtGraphic.Color3": { "documentation": "Determines the colorization to be applied to the ShirtGraphic texture.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#Color3", "code_sample": "" }, "@roblox/globaltype/ShirtGraphic.Graphic": { "documentation": "The content ID link pointing to the ShirtGraphic texture hosted on the Roblox website. This property sets the texture associated with a t-shirt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ShirtGraphic#Graphic", "code_sample": "" }, "@roblox/globaltype/SoundGroup": { "documentation": "A SoundGroup is used to manage the volume and sound effects on multiple Sounds at once. Sounds in the SoundGroup will have their volume and effects adjusted by the SoundGroup.", "keys": { "Volume": "@roblox/globaltype/SoundGroup.Volume" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundGroup", "code_sample": "" }, "@roblox/globaltype/SoundGroup.Volume": { "documentation": "The volume multiplier applied to Sounds that are in the SoundGroup.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundGroup#Volume", "code_sample": "" }, "@roblox/globaltype/InputObject": { "documentation": "An object created when an input begins that describes a particular user input.", "keys": { "Delta": "@roblox/globaltype/InputObject.Delta", "KeyCode": "@roblox/globaltype/InputObject.KeyCode", "Position": "@roblox/globaltype/InputObject.Position", "UserInputState": "@roblox/globaltype/InputObject.UserInputState", "UserInputType": "@roblox/globaltype/InputObject.UserInputType", "IsModifierKeyDown": "@roblox/globaltype/InputObject.IsModifierKeyDown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject", "code_sample": "" }, "@roblox/globaltype/InputObject.Delta": { "documentation": "A Vector3 describing the delta between input movements.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject#Delta", "code_sample": "" }, "@roblox/globaltype/InputObject.KeyCode": { "documentation": "Contains an Enum that describes the kind of input used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject#KeyCode", "code_sample": "" }, "@roblox/globaltype/InputObject.Position": { "documentation": "A Vector3 describing the positional value of this input.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject#Position", "code_sample": "" }, "@roblox/globaltype/InputObject.UserInputState": { "documentation": "Describes the state of an input being performed, following a specific flow depending on the UserInputType.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject#UserInputState", "code_sample": "" }, "@roblox/globaltype/InputObject.UserInputType": { "documentation": "Describes the kind of input being performed (mouse, keyboard, gamepad, touch, etc.).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject#UserInputType", "code_sample": "" }, "@roblox/globaltype/InputObject.IsModifierKeyDown/param/0": { "documentation": "An object created when an input begins that describes a particular user input." }, "@roblox/globaltype/InputObject.IsModifierKeyDown/param/1": { "documentation": "" }, "@roblox/globaltype/InputObject.IsModifierKeyDown/return/0": { "documentation": "true if the passed in modifierKey is being held down; false otherwise." }, "@roblox/globaltype/InputObject.IsModifierKeyDown": { "documentation": "Returns whether the passed in modifier key is down.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputObject.IsModifierKeyDown/param/0" }, { "name": "modifierKey", "documentation": "@roblox/globaltype/InputObject.IsModifierKeyDown/param/1" } ], "returns": [ "@roblox/globaltype/InputObject.IsModifierKeyDown/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputObject#IsModifierKeyDown", "code_sample": "" }, "@roblox/globaltype/RunningAverageItemDouble": { "documentation": "Measures the runtime average of a double value.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunningAverageItemDouble", "code_sample": "" }, "@roblox/globaltype/ScriptDocument": { "documentation": "", "keys": { "CloseAsync": "@roblox/globaltype/ScriptDocument.CloseAsync", "EditTextAsync": "@roblox/globaltype/ScriptDocument.EditTextAsync", "ForceSetSelectionAsync": "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync", "GetLine": "@roblox/globaltype/ScriptDocument.GetLine", "GetLineCount": "@roblox/globaltype/ScriptDocument.GetLineCount", "GetScript": "@roblox/globaltype/ScriptDocument.GetScript", "GetSelectedText": "@roblox/globaltype/ScriptDocument.GetSelectedText", "GetSelection": "@roblox/globaltype/ScriptDocument.GetSelection", "GetSelectionEnd": "@roblox/globaltype/ScriptDocument.GetSelectionEnd", "GetSelectionStart": "@roblox/globaltype/ScriptDocument.GetSelectionStart", "GetText": "@roblox/globaltype/ScriptDocument.GetText", "GetViewport": "@roblox/globaltype/ScriptDocument.GetViewport", "HasSelectedText": "@roblox/globaltype/ScriptDocument.HasSelectedText", "IsCommandBar": "@roblox/globaltype/ScriptDocument.IsCommandBar", "MultiEditTextAsync": "@roblox/globaltype/ScriptDocument.MultiEditTextAsync", "RequestSetSelectionAsync": "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.CloseAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.CloseAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.CloseAsync": { "documentation": "Requests that the editor associated with this document close. Yields the current thread until the editor responds to the request.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.CloseAsync/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.CloseAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#CloseAsync", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal documents = ScriptEditorService:GetScriptDocuments()\nlocal scriptDocument\n-- Find the first open script document\nfor _, document in documents do\n\t-- The Command Bar can't be closed, so don't select it\n\tif not document:IsCommandBar() then\n\t\tscriptDocument = document\n\t\tbreak\n\tend\nend\n\nif scriptDocument then\n\tlocal success, err = scriptDocument:CloseAsync()\n\tif success then\n\t\tprint(`Closed {scriptDocument.Name}`)\n\telse\n\t\twarn(`Failed to close {scriptDocument.Name} because: {err}`)\n\tend\nelse\n\tprint(\"No open scripts\")\nend" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/param/3": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/param/4": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/param/5": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.EditTextAsync": { "documentation": "Replaces the text in the specified range from (startLine, startColumn) to (endLine, endColumn) with newText.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.EditTextAsync/param/0" }, { "name": "newText", "documentation": "@roblox/globaltype/ScriptDocument.EditTextAsync/param/1" }, { "name": "startLine", "documentation": "@roblox/globaltype/ScriptDocument.EditTextAsync/param/2" }, { "name": "startCharacter", "documentation": "@roblox/globaltype/ScriptDocument.EditTextAsync/param/3" }, { "name": "endLine", "documentation": "@roblox/globaltype/ScriptDocument.EditTextAsync/param/4" }, { "name": "endCharacter", "documentation": "@roblox/globaltype/ScriptDocument.EditTextAsync/param/5" } ], "returns": [ "@roblox/globaltype/ScriptDocument.EditTextAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#EditTextAsync", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/3": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/4": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync": { "documentation": "Asks the editor to set its cursor selection to the argument values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/0" }, { "name": "cursorLine", "documentation": "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/1" }, { "name": "cursorCharacter", "documentation": "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/2" }, { "name": "anchorLine", "documentation": "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/3" }, { "name": "anchorCharacter", "documentation": "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/param/4" } ], "returns": [ "@roblox/globaltype/ScriptDocument.ForceSetSelectionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#ForceSetSelectionAsync", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.GetLine/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetLine/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetLine/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetLine": { "documentation": "Returns the text of the specified line. When no argument is provided, returns the line of the current cursor position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetLine/param/0" }, { "name": "lineIndex", "documentation": "@roblox/globaltype/ScriptDocument.GetLine/param/1" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetLine/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetLine", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.GetLineCount/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetLineCount/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetLineCount": { "documentation": "Returns the number of lines in the document.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetLineCount/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetLineCount/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetLineCount", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tlocal lineCount = scriptDocument:GetLineCount()\n\tprint(`The script has {lineCount} lines!`)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.GetScript/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetScript/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetScript": { "documentation": "Returns the underlying LuaSourceContainer instance, if one exists, otherwise nil.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetScript/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetScript/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetScript", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tlocal openScript = scriptDocument:GetScript()\n\tprint(`Currently open script: {openScript:GetFullName()}`)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.GetSelectedText/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelectedText/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelectedText": { "documentation": "Gets the text selected in the editor, or an empty string if there is no selection.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetSelectedText/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetSelectedText/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectedText", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tscriptDocument.SelectionChanged:Connect(function()\n\t\tif scriptDocument:HasSelectedText() then\n\t\t\tlocal selectedText = scriptDocument:GetSelectedText()\n\t\t\tprint(`Currently selected text: {selectedText}`)\n\t\telse\n\t\t\tprint(\"No text currently selected\")\n\t\tend\n\tend)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.GetSelection/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelection/return/0": { "documentation": "CursorLine, CursorChar, AnchorLine, AnchorChar." }, "@roblox/globaltype/ScriptDocument.GetSelection": { "documentation": "Returns the last known selection of the Script Editor in the format: CursorLine, CursorChar, AnchorLine, AnchorChar. If the Script Editor has no selection, CursorLine == AnchorLine and CursorChar == AnchorChar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetSelection/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetSelection/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelection", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.GetSelectionEnd/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelectionEnd/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelectionEnd": { "documentation": "Gets the larger of the cursor position and anchor. If the editor has no selection, they are the same value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetSelectionEnd/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetSelectionEnd/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectionEnd", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tlocal startLine, startCharacter = scriptDocument:GetSelectionStart()\n\tlocal endLine, endCharacter = scriptDocument:GetSelectionEnd()\n\tprint(`Selection start: Line {startLine}, Char {startCharacter}`)\n\tprint(`Selection end: Line {endLine}, Char {endCharacter}`)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.GetSelectionStart/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelectionStart/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetSelectionStart": { "documentation": "Gets the smaller of the cursor position and anchor. If the editor has no selection, they are the same value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetSelectionStart/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetSelectionStart/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetSelectionStart", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tlocal startLine, startCharacter = scriptDocument:GetSelectionStart()\n\tlocal endLine, endCharacter = scriptDocument:GetSelectionEnd()\n\tprint(`Selection start: Line {startLine}, Char {startCharacter}`)\n\tprint(`Selection end: Line {endLine}, Char {endCharacter}`)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.GetText/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetText/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetText/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetText/param/3": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetText/param/4": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetText/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetText": { "documentation": "Returns text from the open editor.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetText/param/0" }, { "name": "startLine", "documentation": "@roblox/globaltype/ScriptDocument.GetText/param/1" }, { "name": "startCharacter", "documentation": "@roblox/globaltype/ScriptDocument.GetText/param/2" }, { "name": "endLine", "documentation": "@roblox/globaltype/ScriptDocument.GetText/param/3" }, { "name": "endCharacter", "documentation": "@roblox/globaltype/ScriptDocument.GetText/param/4" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetText/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetText", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tlocal text = scriptDocument:GetText()\n\tprint(`Script contents: {text}`)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.GetViewport/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetViewport/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.GetViewport": { "documentation": "Returns the currently displayed line numbers in the editor change.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.GetViewport/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.GetViewport/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#GetViewport", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tlocal firstLine, lastLine = scriptDocument:GetViewport()\n\tprint(`Currently viewing lines {firstLine} to {lastLine}`)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.HasSelectedText/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.HasSelectedText/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.HasSelectedText": { "documentation": "Returns whether or not the editor has any text selected.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.HasSelectedText/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.HasSelectedText/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#HasSelectedText", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar while a script is open\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal function getFirstOpenDocument()\n\tlocal documents = ScriptEditorService:GetScriptDocuments()\n\tfor _, document in documents do\n\t\tif not document:IsCommandBar() then\n\t\t\treturn document\n\t\tend\n\tend\n\treturn nil\nend\n\nlocal scriptDocument = getFirstOpenDocument()\n\nif scriptDocument then\n\tscriptDocument.SelectionChanged:Connect(function()\n\t\tif scriptDocument:HasSelectedText() then\n\t\t\tlocal selectedText = scriptDocument:GetSelectedText()\n\t\t\tprint(`Currently selected text: {selectedText}`)\n\t\telse\n\t\t\tprint(\"No text currently selected\")\n\t\tend\n\tend)\nelse\n\tprint(\"No scripts open\")\nend" }, "@roblox/globaltype/ScriptDocument.IsCommandBar/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.IsCommandBar/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.IsCommandBar": { "documentation": "Returns true if the ScriptDocument represents the Command bar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.IsCommandBar/param/0" } ], "returns": [ "@roblox/globaltype/ScriptDocument.IsCommandBar/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#IsCommandBar", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal documents = ScriptEditorService:GetScriptDocuments()\n\nfor _, document in documents do\n\tif document:IsCommandBar() then\n\t\tprint(\"Command bar document:\", document)\n\tend\nend" }, "@roblox/globaltype/ScriptDocument.MultiEditTextAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.MultiEditTextAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.MultiEditTextAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.MultiEditTextAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.MultiEditTextAsync/param/0" }, { "name": "edits", "documentation": "@roblox/globaltype/ScriptDocument.MultiEditTextAsync/param/1" } ], "returns": [ "@roblox/globaltype/ScriptDocument.MultiEditTextAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#MultiEditTextAsync", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/3": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/4": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync": { "documentation": "Asks the editor to set its cursor selection to the argument values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/0" }, { "name": "cursorLine", "documentation": "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/1" }, { "name": "cursorCharacter", "documentation": "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/2" }, { "name": "anchorLine", "documentation": "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/3" }, { "name": "anchorCharacter", "documentation": "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/param/4" } ], "returns": [ "@roblox/globaltype/ScriptDocument.RequestSetSelectionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#RequestSetSelectionAsync", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.SelectionChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.SelectionChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.SelectionChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.SelectionChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.SelectionChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.SelectionChanged": { "documentation": "Fires when the ScriptDocument changes, including immediately after a text change.", "keys": { "Connect": "@roblox/globaltype/ScriptDocument.SelectionChanged.Connect", "ConnectParallel": "@roblox/globaltype/ScriptDocument.SelectionChanged.ConnectParallel", "Once": "@roblox/globaltype/ScriptDocument.SelectionChanged.Once", "Wait": "@roblox/globaltype/ScriptDocument.SelectionChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#SelectionChanged", "code_sample": "" }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.ViewportChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.ViewportChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ViewportChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptDocument.ViewportChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptDocument.ViewportChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptDocument.ViewportChanged": { "documentation": "Fires when the displayed line numbers in the editor change.", "keys": { "Connect": "@roblox/globaltype/ScriptDocument.ViewportChanged.Connect", "ConnectParallel": "@roblox/globaltype/ScriptDocument.ViewportChanged.ConnectParallel", "Once": "@roblox/globaltype/ScriptDocument.ViewportChanged.Once", "Wait": "@roblox/globaltype/ScriptDocument.ViewportChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptDocument#ViewportChanged", "code_sample": "" }, "@roblox/globaltype/StyleDerive": { "documentation": "When parented to a StyleSheet, references another StyleSheet from which the parent inherits StyleRules and token definitions.", "keys": { "Priority": "@roblox/globaltype/StyleDerive.Priority", "StyleSheet": "@roblox/globaltype/StyleDerive.StyleSheet" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleDerive", "code_sample": "" }, "@roblox/globaltype/StyleDerive.Priority": { "documentation": "A number that determines how style properties inherited through this StyleDerive apply relative to the same properties inherited through other StyleDerives.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleDerive#Priority", "code_sample": "" }, "@roblox/globaltype/StyleDerive.StyleSheet": { "documentation": "The StyleSheet from which the parent StyleSheet inherits StyleRules and token definitions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleDerive#StyleSheet", "code_sample": "" }, "@roblox/globaltype/VectorForce": { "documentation": "Applies constant force to an assembly.", "keys": { "ApplyAtCenterOfMass": "@roblox/globaltype/VectorForce.ApplyAtCenterOfMass", "Force": "@roblox/globaltype/VectorForce.Force", "RelativeTo": "@roblox/globaltype/VectorForce.RelativeTo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VectorForce", "code_sample": "" }, "@roblox/globaltype/VectorForce.ApplyAtCenterOfMass": { "documentation": "Whether force is applied at the center of mass of the parent assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VectorForce#ApplyAtCenterOfMass", "code_sample": "" }, "@roblox/globaltype/VectorForce.Force": { "documentation": "The strength and direction of the force.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VectorForce#Force", "code_sample": "" }, "@roblox/globaltype/VectorForce.RelativeTo": { "documentation": "The CFrame in which the force is expressed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VectorForce#RelativeTo", "code_sample": "" }, "@roblox/globaltype/VehicleController": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleController", "code_sample": "" }, "@roblox/globaltype/CookiesService": { "documentation": "A backend service used by Roblox to control HTTP cookies. Its functions are not available to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CookiesService", "code_sample": "" }, "@roblox/globaltype/SurfaceGui": { "documentation": "Container for GuiObjects that are rendered on the surface of a part.", "keys": { "AlwaysOnTop": "@roblox/globaltype/SurfaceGui.AlwaysOnTop", "Brightness": "@roblox/globaltype/SurfaceGui.Brightness", "CanvasSize": "@roblox/globaltype/SurfaceGui.CanvasSize", "ClipsDescendants": "@roblox/globaltype/SurfaceGui.ClipsDescendants", "LightInfluence": "@roblox/globaltype/SurfaceGui.LightInfluence", "MaxDistance": "@roblox/globaltype/SurfaceGui.MaxDistance", "PixelsPerStud": "@roblox/globaltype/SurfaceGui.PixelsPerStud", "SizingMode": "@roblox/globaltype/SurfaceGui.SizingMode", "ToolPunchThroughDistance": "@roblox/globaltype/SurfaceGui.ToolPunchThroughDistance", "ZOffset": "@roblox/globaltype/SurfaceGui.ZOffset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.AlwaysOnTop": { "documentation": "Determines whether the SurfaceGui will always be rendered on top of other 3D objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#AlwaysOnTop", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.Brightness": { "documentation": "Determines the factor by which the SurfaceGui container's light is scaled when LightInfluence is 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#Brightness", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.CanvasSize": { "documentation": "The size of a \"virtual screen\" in \"virtual pixels\" which makes SurfaceGuis pixel-to-pixel compatible with ScreenGuis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#CanvasSize", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.ClipsDescendants": { "documentation": "Whether portions of GuiObjects that fall outside of the SurfaceGui canvas borders will be drawn.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#ClipsDescendants", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.LightInfluence": { "documentation": "Controls how much the SurfaceGui is influenced by environmental lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#LightInfluence", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.MaxDistance": { "documentation": "Controls how far away the SurfaceGui can be displayed before it stops rendering.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#MaxDistance", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.PixelsPerStud": { "documentation": "Determines the density of pixels used for each world-space stud to render the contents of the SurfaceGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#PixelsPerStud", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.SizingMode": { "documentation": "Determines whether the SurfaceGui will render at a fixed size or scale with its size in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#SizingMode", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.ToolPunchThroughDistance": { "documentation": "Sets the distance in which left clicking starts acting on the SurfaceGui instead of for the held Tool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#ToolPunchThroughDistance", "code_sample": "" }, "@roblox/globaltype/SurfaceGui.ZOffset": { "documentation": "Layers this SurfaceGui in relation to other SurfaceGuis on the same face.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGui#ZOffset", "code_sample": "" }, "@roblox/globaltype/StandardPages": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StandardPages", "code_sample": "" }, "@roblox/globaltype/SurfaceLight": { "documentation": "A light source that emits illumination of a specified color and brightness from a face for a specified range.", "keys": { "Angle": "@roblox/globaltype/SurfaceLight.Angle", "Face": "@roblox/globaltype/SurfaceLight.Face", "Range": "@roblox/globaltype/SurfaceLight.Range" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceLight", "code_sample": "local part = Instance.new(\"Part\")\npart.Anchored = true\npart.Position = Vector3.new(0, 0, 0)\npart.Parent = workspace\n\nlocal light = Instance.new(\"SurfaceLight\")\nlight.Color = Color3.fromRGB(255, 255, 255)\nlight.Brightness = 1\nlight.Range = 16\nlight.Parent = part" }, "@roblox/globaltype/SurfaceLight.Angle": { "documentation": "The angle of which the light is shone from the SurfaceLight.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceLight#Angle", "code_sample": "" }, "@roblox/globaltype/SurfaceLight.Face": { "documentation": "Sets the side of the parent that the SurfaceLight comes from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceLight#Face", "code_sample": "" }, "@roblox/globaltype/SurfaceLight.Range": { "documentation": "The distance from the SurfaceLight's face that will illuminate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceLight#Range", "code_sample": "" }, "@roblox/globaltype/StringValue": { "documentation": "A container object for a single string.", "keys": { "Value": "@roblox/globaltype/StringValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StringValue", "code_sample": "-- Demonstrate the Changed event by creating a Part\nlocal part = Instance.new(\"Part\")\npart.Changed:Connect(print)\n-- This fires Changed with \"Transparency\"\npart.Transparency = 0.5\n-- Similarly, this fires Changed with \"Number\"\npart.Name = \"SomePart\"\n-- Since changing BrickColor will also change other\n-- properties at the same time, this line fires Changed\n-- with \"BrickColor\", \"Color3\" and \"Color3uint16\".\npart.BrickColor = BrickColor.Red()\n\n-- A NumberValue holds a double-precision floating-point number\nlocal vNumber = Instance.new(\"NumberValue\")\nvNumber.Changed:Connect(print)\n-- This fires Changed with 123.456 (not \"Value\")\nvNumber.Value = 123.456\n-- This does not fire Changed\nvNumber.Name = \"SomeNumber\"\n\n-- A StringValue stores one string\nlocal vString = Instance.new(\"StringValue\")\nvString.Changed:Connect(print)\n-- This fires Changed with \"Hello\" (not \"Value\")\nvString.Value = \"Hello\"" }, "@roblox/globaltype/StringValue.Value": { "documentation": "The stored string.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StringValue#Value", "code_sample": "" }, "@roblox/globaltype/StringValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/StringValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StringValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/StringValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/StringValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StringValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/StringValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/StringValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StringValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/StringValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/StringValue.Changed": { "documentation": "Fires whenever StringValue.Value is changed.", "keys": { "Connect": "@roblox/globaltype/StringValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/StringValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/StringValue.Changed.Once", "Wait": "@roblox/globaltype/StringValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StringValue#Changed", "code_sample": "local value = Instance.new(\"StringValue\")\nvalue.Parent = workspace\n\nvalue.Changed:Connect(function(NewValue)\n\tprint(NewValue)\nend)\n\nvalue.Value = \"Hello world!\"" }, "@roblox/globaltype/StringValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/StringValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StringValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/StringValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/StringValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StringValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/StringValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/StringValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/StringValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/StringValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/StringValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StringValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/StringValue.changed": { "documentation": "Deprecated: This deprecated event is a variant of StringValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/StringValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/StringValue.changed.ConnectParallel", "Once": "@roblox/globaltype/StringValue.changed.Once", "Wait": "@roblox/globaltype/StringValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StringValue#changed", "code_sample": "" }, "@roblox/globaltype/DataStoreObjectVersionInfo": { "documentation": "An instance describing version information for a key.", "keys": { "CreatedTime": "@roblox/globaltype/DataStoreObjectVersionInfo.CreatedTime", "IsDeleted": "@roblox/globaltype/DataStoreObjectVersionInfo.IsDeleted", "Version": "@roblox/globaltype/DataStoreObjectVersionInfo.Version" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreObjectVersionInfo", "code_sample": "" }, "@roblox/globaltype/DataStoreObjectVersionInfo.CreatedTime": { "documentation": "Indicates when the version was created in milliseconds since epoch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreObjectVersionInfo#CreatedTime", "code_sample": "" }, "@roblox/globaltype/DataStoreObjectVersionInfo.IsDeleted": { "documentation": "Whether the version has been marked as deleted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreObjectVersionInfo#IsDeleted", "code_sample": "" }, "@roblox/globaltype/DataStoreObjectVersionInfo.Version": { "documentation": "Uniquely identifies a particular version of the key.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreObjectVersionInfo#Version", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt": { "documentation": "An object that lets you prompt players to interact with an object in the 3D world.", "keys": { "ActionText": "@roblox/globaltype/ProximityPrompt.ActionText", "AutoLocalize": "@roblox/globaltype/ProximityPrompt.AutoLocalize", "ClickablePrompt": "@roblox/globaltype/ProximityPrompt.ClickablePrompt", "Enabled": "@roblox/globaltype/ProximityPrompt.Enabled", "Exclusivity": "@roblox/globaltype/ProximityPrompt.Exclusivity", "GamepadKeyCode": "@roblox/globaltype/ProximityPrompt.GamepadKeyCode", "HoldDuration": "@roblox/globaltype/ProximityPrompt.HoldDuration", "KeyboardKeyCode": "@roblox/globaltype/ProximityPrompt.KeyboardKeyCode", "MaxActivationDistance": "@roblox/globaltype/ProximityPrompt.MaxActivationDistance", "MaxIndicatorDistance": "@roblox/globaltype/ProximityPrompt.MaxIndicatorDistance", "ObjectText": "@roblox/globaltype/ProximityPrompt.ObjectText", "RequiresLineOfSight": "@roblox/globaltype/ProximityPrompt.RequiresLineOfSight", "RootLocalizationTable": "@roblox/globaltype/ProximityPrompt.RootLocalizationTable", "Style": "@roblox/globaltype/ProximityPrompt.Style", "UIOffset": "@roblox/globaltype/ProximityPrompt.UIOffset", "InputHoldBegin": "@roblox/globaltype/ProximityPrompt.InputHoldBegin", "InputHoldEnd": "@roblox/globaltype/ProximityPrompt.InputHoldEnd" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt", "code_sample": "local proximityPrompt = script.Parent\nlocal seat = proximityPrompt.Parent.Seat\n\nseat:GetPropertyChangedSignal(\"Occupant\"):Connect(function()\n\tif seat.Occupant then\n\t\tproximityPrompt.Enabled = false\n\telse\n\t\tproximityPrompt.Enabled = true\n\tend\nend)\n\nproximityPrompt.Triggered:Connect(function(player)\n\tseat:Sit(player.Character.Humanoid)\nend)" }, "@roblox/globaltype/ProximityPrompt.ActionText": { "documentation": "The action text shown to the user.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#ActionText", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.AutoLocalize": { "documentation": "Whether the prompt's ProximityPrompt.ActionText and ProximityPrompt.ObjectText will be localized according to the ProximityPrompt.RootLocalizationTable.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#AutoLocalize", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.ClickablePrompt": { "documentation": "Whether the prompt can be activated by clicking/tapping on the prompt UI.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#ClickablePrompt", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.Enabled": { "documentation": "Whether or not this prompt should be shown.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#Enabled", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.Exclusivity": { "documentation": "Used to customize which prompts can be shown at the same time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#Exclusivity", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.GamepadKeyCode": { "documentation": "The gamepad button the player should press to trigger the prompt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#GamepadKeyCode", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.HoldDuration": { "documentation": "The duration, in seconds, that the player must hold the button/key down to trigger the prompt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#HoldDuration", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.KeyboardKeyCode": { "documentation": "The key the player should press to trigger the prompt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#KeyboardKeyCode", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.MaxActivationDistance": { "documentation": "The maximum distance a Player's character can be from the ProximityPrompt for the prompt to appear.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#MaxActivationDistance", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.MaxIndicatorDistance": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#MaxIndicatorDistance", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.ObjectText": { "documentation": "An optional property that determines the object name text shown to the user.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#ObjectText", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.RequiresLineOfSight": { "documentation": "Whether the prompt is hidden if the path between the player's Camera and object parented to the ProximityPrompt is obstructed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#RequiresLineOfSight", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.RootLocalizationTable": { "documentation": "A reference to a LocalizationTable to be used to apply automated localization to this prompt's ProximityPrompt.ActionText and ProximityPrompt.ObjectText.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#RootLocalizationTable", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.Style": { "documentation": "The style of the prompt's UI.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#Style", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.UIOffset": { "documentation": "The pixel offset applied to the prompt's UI.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#UIOffset", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.InputHoldBegin/param/0": { "documentation": "An object that lets you prompt players to interact with an object in the 3D world." }, "@roblox/globaltype/ProximityPrompt.InputHoldBegin": { "documentation": "Fires a signal indicating that the user began pressing the prompt GUI button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.InputHoldBegin/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#InputHoldBegin", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.InputHoldEnd/param/0": { "documentation": "An object that lets you prompt players to interact with an object in the 3D world." }, "@roblox/globaltype/ProximityPrompt.InputHoldEnd": { "documentation": "Fires a signal indicating that the user ended pressing the prompt GUI button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.InputHoldEnd/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#InputHoldEnd", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorHidden": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Once", "Wait": "@roblox/globaltype/ProximityPrompt.IndicatorHidden.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#IndicatorHidden", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.IndicatorShown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.IndicatorShown": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.IndicatorShown.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Once", "Wait": "@roblox/globaltype/ProximityPrompt.IndicatorShown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#IndicatorShown", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan": { "documentation": "Triggered when a player begins holding down the key/button connected to a prompt with a non-zero ProximityPrompt.HoldDuration.", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Once", "Wait": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldBegan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#PromptButtonHoldBegan", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded": { "documentation": "Triggers when the player ends holding down the button on a prompt with a non-zero ProximityPrompt.HoldDuration.", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Once", "Wait": "@roblox/globaltype/ProximityPrompt.PromptButtonHoldEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#PromptButtonHoldEnded", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptHidden.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptHidden.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptHidden.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptHidden.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptHidden.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptHidden": { "documentation": "Triggers when the prompt becomes hidden.", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.PromptHidden.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.PromptHidden.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.PromptHidden.Once", "Wait": "@roblox/globaltype/ProximityPrompt.PromptHidden.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#PromptHidden", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.PromptShown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptShown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptShown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptShown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptShown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptShown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptShown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptShown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.PromptShown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptShown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.PromptShown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.PromptShown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.PromptShown": { "documentation": "Triggers when the prompt becomes visible.", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.PromptShown.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.PromptShown.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.PromptShown.Once", "Wait": "@roblox/globaltype/ProximityPrompt.PromptShown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#PromptShown", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.Triggered.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.Triggered.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.Triggered.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.Triggered.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.Triggered.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.Triggered.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.Triggered.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.Triggered.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.Triggered.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.Triggered.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.Triggered.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.Triggered.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.Triggered": { "documentation": "Triggered when the prompt key/button is pressed, or after a specified amount of time holding the button, if ProximityPrompt.HoldDuration is used.", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.Triggered.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.Triggered.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.Triggered.Once", "Wait": "@roblox/globaltype/ProximityPrompt.Triggered.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#Triggered", "code_sample": "" }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPrompt.TriggerEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPrompt.TriggerEnded": { "documentation": "Triggers when key/button is released, for longer events where the user is required to hold down the button.", "keys": { "Connect": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPrompt.TriggerEnded.ConnectParallel", "Once": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Once", "Wait": "@roblox/globaltype/ProximityPrompt.TriggerEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPrompt#TriggerEnded", "code_sample": "" }, "@roblox/globaltype/AudioRecorder": { "documentation": "Records audio streams in-experience.", "keys": { "IsRecording": "@roblox/globaltype/AudioRecorder.IsRecording", "TimeLength": "@roblox/globaltype/AudioRecorder.TimeLength", "CanRecordAsync": "@roblox/globaltype/AudioRecorder.CanRecordAsync", "Clear": "@roblox/globaltype/AudioRecorder.Clear", "GetConnectedWires": "@roblox/globaltype/AudioRecorder.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioRecorder.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioRecorder.GetOutputPins", "GetTemporaryContent": "@roblox/globaltype/AudioRecorder.GetTemporaryContent", "GetUnrecordableInstancesAsync": "@roblox/globaltype/AudioRecorder.GetUnrecordableInstancesAsync", "RecordAsync": "@roblox/globaltype/AudioRecorder.RecordAsync", "Stop": "@roblox/globaltype/AudioRecorder.Stop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.IsRecording": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#IsRecording", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.TimeLength": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#TimeLength", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.CanRecordAsync/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.CanRecordAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.CanRecordAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.CanRecordAsync/param/0" } ], "returns": [ "@roblox/globaltype/AudioRecorder.CanRecordAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#CanRecordAsync", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.Clear/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.Clear": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.Clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#Clear", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.GetConnectedWires/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.GetConnectedWires": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioRecorder.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioRecorder.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.GetInputPins/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioRecorder.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.GetOutputPins/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioRecorder.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.GetTemporaryContent/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.GetTemporaryContent/return/0": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.GetTemporaryContent": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.GetTemporaryContent/param/0" } ], "returns": [ "@roblox/globaltype/AudioRecorder.GetTemporaryContent/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetTemporaryContent", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.GetUnrecordableInstancesAsync/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.GetUnrecordableInstancesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.GetUnrecordableInstancesAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.GetUnrecordableInstancesAsync/param/0" } ], "returns": [ "@roblox/globaltype/AudioRecorder.GetUnrecordableInstancesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetUnrecordableInstancesAsync", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.RecordAsync/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.RecordAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.RecordAsync/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#RecordAsync", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.Stop/param/0": { "documentation": "Records audio streams in-experience." }, "@roblox/globaltype/AudioRecorder.Stop": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.Stop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#Stop", "code_sample": "" }, "@roblox/globaltype/AudioRecorder.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioRecorder.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioRecorder.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioRecorder.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioRecorder.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioRecorder.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioRecorder.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioRecorder.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioRecorder.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioRecorder.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioRecorder.WiringChanged": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/AudioRecorder.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioRecorder.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioRecorder.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioRecorder.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#WiringChanged", "code_sample": "" }, "@roblox/globaltype/HttpService": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods.", "keys": { "HttpEnabled": "@roblox/globaltype/HttpService.HttpEnabled", "CreateWebStreamClient": "@roblox/globaltype/HttpService.CreateWebStreamClient", "GenerateGUID": "@roblox/globaltype/HttpService.GenerateGUID", "GetAsync": "@roblox/globaltype/HttpService.GetAsync", "GetSecret": "@roblox/globaltype/HttpService.GetSecret", "JSONDecode": "@roblox/globaltype/HttpService.JSONDecode", "JSONEncode": "@roblox/globaltype/HttpService.JSONEncode", "PostAsync": "@roblox/globaltype/HttpService.PostAsync", "RequestAsync": "@roblox/globaltype/HttpService.RequestAsync", "UrlEncode": "@roblox/globaltype/HttpService.UrlEncode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService", "code_sample": "local HttpService = game:GetService(\"HttpService\")\n\nlocal URL_ASTROS = \"http://api.open-notify.org/astros.json\"\n\n-- Make the request to our endpoint URL\nlocal response = HttpService:GetAsync(URL_ASTROS)\n\n-- Parse the JSON response\nlocal data = HttpService:JSONDecode(response)\n\n-- Information in the data table is dependent on the response JSON\nif data.message == \"success\" then\n\tprint(\"There are currently \" .. data.number .. \" astronauts in space:\")\n\tfor i, person in pairs(data.people) do\n\t\tprint(i .. \": \" .. person.name .. \" is on \" .. person.craft)\n\tend\nend" }, "@roblox/globaltype/HttpService.HttpEnabled": { "documentation": "Indicates whether HTTP requests can be sent to external websites.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#HttpEnabled", "code_sample": "" }, "@roblox/globaltype/HttpService.CreateWebStreamClient/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.CreateWebStreamClient/param/1": { "documentation": "The type of streaming connection to intiialize the client with." }, "@roblox/globaltype/HttpService.CreateWebStreamClient/param/2": { "documentation": "A dictionary containing information to be requested from the server. It is identical to requestOptions in HttpService:RequestAsync()." }, "@roblox/globaltype/HttpService.CreateWebStreamClient/return/0": { "documentation": "A stateful client that emits events in the stream lifecycle." }, "@roblox/globaltype/HttpService.CreateWebStreamClient": { "documentation": "Creates a client that opens a persistent connection to stream data.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.CreateWebStreamClient/param/0" }, { "name": "streamClientType", "documentation": "@roblox/globaltype/HttpService.CreateWebStreamClient/param/1" }, { "name": "requestOptions", "documentation": "@roblox/globaltype/HttpService.CreateWebStreamClient/param/2" } ], "returns": [ "@roblox/globaltype/HttpService.CreateWebStreamClient/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#CreateWebStreamClient", "code_sample": "" }, "@roblox/globaltype/HttpService.GenerateGUID/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.GenerateGUID/param/1": { "documentation": "Whether the returned string should be wrapped in curly braces ({})." }, "@roblox/globaltype/HttpService.GenerateGUID/return/0": { "documentation": "The randomly generated UUID." }, "@roblox/globaltype/HttpService.GenerateGUID": { "documentation": "Generates a UUID/GUID random string, optionally with curly braces.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.GenerateGUID/param/0" }, { "name": "wrapInCurlyBraces", "documentation": "@roblox/globaltype/HttpService.GenerateGUID/param/1" } ], "returns": [ "@roblox/globaltype/HttpService.GenerateGUID/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#GenerateGUID", "code_sample": "local HttpService = game:GetService(\"HttpService\")\n\nlocal result = HttpService:GenerateGUID(true)\n\nprint(result) --> Example output: {4c50eba2-d2ed-4d79-bec1-02a967f49c58}" }, "@roblox/globaltype/HttpService.GetAsync/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.GetAsync/param/1": { "documentation": "The web address you are requesting data from." }, "@roblox/globaltype/HttpService.GetAsync/param/2": { "documentation": "Whether the request stores (caches) the response." }, "@roblox/globaltype/HttpService.GetAsync/param/3": { "documentation": "Used to specify some HTTP request headers." }, "@roblox/globaltype/HttpService.GetAsync/return/0": { "documentation": "The GET request's response body." }, "@roblox/globaltype/HttpService.GetAsync": { "documentation": "Sends an HTTP GET request.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.GetAsync/param/0" }, { "name": "url", "documentation": "@roblox/globaltype/HttpService.GetAsync/param/1" }, { "name": "nocache", "documentation": "@roblox/globaltype/HttpService.GetAsync/param/2" }, { "name": "headers", "documentation": "@roblox/globaltype/HttpService.GetAsync/param/3" } ], "returns": [ "@roblox/globaltype/HttpService.GetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#GetAsync", "code_sample": "local HttpService = game:GetService(\"HttpService\")\n\nlocal URL_ASTROS = \"http://api.open-notify.org/astros.json\"\n\n-- Make the request to our endpoint URL\nlocal response = HttpService:GetAsync(URL_ASTROS)\n\n-- Parse the JSON response\nlocal data = HttpService:JSONDecode(response)\n\n-- Information in the data table is dependent on the response JSON\nif data.message == \"success\" then\n\tprint(\"There are currently \" .. data.number .. \" astronauts in space:\")\n\tfor i, person in pairs(data.people) do\n\t\tprint(i .. \": \" .. person.name .. \" is on \" .. person.craft)\n\tend\nend" }, "@roblox/globaltype/HttpService.GetSecret/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.GetSecret/param/1": { "documentation": "" }, "@roblox/globaltype/HttpService.GetSecret/return/0": { "documentation": "" }, "@roblox/globaltype/HttpService.GetSecret": { "documentation": "Returns a Secret from the secrets store.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.GetSecret/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/HttpService.GetSecret/param/1" } ], "returns": [ "@roblox/globaltype/HttpService.GetSecret/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#GetSecret", "code_sample": "" }, "@roblox/globaltype/HttpService.JSONDecode/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.JSONDecode/param/1": { "documentation": "The JSON object being decoded." }, "@roblox/globaltype/HttpService.JSONDecode/return/0": { "documentation": "The decoded JSON object as a Luau table." }, "@roblox/globaltype/HttpService.JSONDecode": { "documentation": "Decodes a JSON string into a Luau table.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.JSONDecode/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/HttpService.JSONDecode/param/1" } ], "returns": [ "@roblox/globaltype/HttpService.JSONDecode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONDecode", "code_sample": "" }, "@roblox/globaltype/HttpService.JSONEncode/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.JSONEncode/param/1": { "documentation": "The input Luau table." }, "@roblox/globaltype/HttpService.JSONEncode/return/0": { "documentation": "The returned JSON string." }, "@roblox/globaltype/HttpService.JSONEncode": { "documentation": "Generate a JSON string from a Luau table.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.JSONEncode/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/HttpService.JSONEncode/param/1" } ], "returns": [ "@roblox/globaltype/HttpService.JSONEncode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#JSONEncode", "code_sample": "local HttpService = game:GetService(\"HttpService\")\n\nlocal tab = {\n\t-- Remember: these lines are equivalent\n\t--[\"message\"] = \"success\",\n\tmessage = \"success\",\n\n\tinfo = {\n\t\tpoints = 123,\n\t\tisLeader = true,\n\t\tuser = {\n\t\t\tid = 12345,\n\t\t\tname = \"JohnDoe\",\n\t\t},\n\t\tpast_scores = { 50, 42, 95 },\n\t\tbest_friend = nil,\n\t},\n}\n\nlocal json = HttpService:JSONEncode(tab)\nprint(json)" }, "@roblox/globaltype/HttpService.PostAsync/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.PostAsync/param/1": { "documentation": "The destination address for the data." }, "@roblox/globaltype/HttpService.PostAsync/param/2": { "documentation": "The data being sent." }, "@roblox/globaltype/HttpService.PostAsync/param/3": { "documentation": "Modifies the value in the Content-Type header sent with the request." }, "@roblox/globaltype/HttpService.PostAsync/param/4": { "documentation": "Determines whether the data is compressed (gzipped) when sent." }, "@roblox/globaltype/HttpService.PostAsync/param/5": { "documentation": "Used to specify some HTTP request headers." }, "@roblox/globaltype/HttpService.PostAsync/return/0": { "documentation": "The HTTP response sent back indicating the request result." }, "@roblox/globaltype/HttpService.PostAsync": { "documentation": "Sends an HTTP POST request.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.PostAsync/param/0" }, { "name": "url", "documentation": "@roblox/globaltype/HttpService.PostAsync/param/1" }, { "name": "data", "documentation": "@roblox/globaltype/HttpService.PostAsync/param/2" }, { "name": "content_type", "documentation": "@roblox/globaltype/HttpService.PostAsync/param/3" }, { "name": "compress", "documentation": "@roblox/globaltype/HttpService.PostAsync/param/4" }, { "name": "headers", "documentation": "@roblox/globaltype/HttpService.PostAsync/param/5" } ], "returns": [ "@roblox/globaltype/HttpService.PostAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#PostAsync", "code_sample": "" }, "@roblox/globaltype/HttpService.RequestAsync/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.RequestAsync/param/1": { "documentation": "A dictionary containing information to be requested from the server specified." }, "@roblox/globaltype/HttpService.RequestAsync/return/0": { "documentation": "A dictionary containing response information from the server specified." }, "@roblox/globaltype/HttpService.RequestAsync": { "documentation": "Sends an HTTP request using any HTTP method given a dictionary of information.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.RequestAsync/param/0" }, { "name": "requestOptions", "documentation": "@roblox/globaltype/HttpService.RequestAsync/param/1" } ], "returns": [ "@roblox/globaltype/HttpService.RequestAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#RequestAsync", "code_sample": "" }, "@roblox/globaltype/HttpService.UrlEncode/param/0": { "documentation": "Allows sending HTTP requests and provides various web-related and JSON methods." }, "@roblox/globaltype/HttpService.UrlEncode/param/1": { "documentation": "The string (URL) to encode." }, "@roblox/globaltype/HttpService.UrlEncode/return/0": { "documentation": "The encoded string." }, "@roblox/globaltype/HttpService.UrlEncode": { "documentation": "Replaces URL-unsafe characters with '%' and two hexadecimal characters.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpService.UrlEncode/param/0" }, { "name": "input", "documentation": "@roblox/globaltype/HttpService.UrlEncode/param/1" } ], "returns": [ "@roblox/globaltype/HttpService.UrlEncode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpService#UrlEncode", "code_sample": "local HttpService = game:GetService(\"HttpService\")\n\nlocal content = \"Je suis allé au cinéma.\" -- French for \"I went to the movies\"\nlocal result = HttpService:UrlEncode(content)\n\nprint(result) --> Je%20suis%20all%C3%A9%20au%20cinema%2E" }, "@roblox/globaltype/ClickDetector": { "documentation": "An object that provides user input on in-experience BaseParts and Models.", "keys": { "CursorIcon": "@roblox/globaltype/ClickDetector.CursorIcon", "CursorIconContent": "@roblox/globaltype/ClickDetector.CursorIconContent", "MaxActivationDistance": "@roblox/globaltype/ClickDetector.MaxActivationDistance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector", "code_sample": "local clickDetector = script.Parent\n\nlocal function onClicked(player)\n\t-- Show a message to the player\n\tlocal msg = Instance.new(\"Message\")\n\tmsg.Parent = player:FindFirstChild(\"PlayerGui\")\n\tmsg.Text = \"Hello, \" .. player.Name\n\twait(2.5)\n\tmsg:Destroy()\nend\n\n-- Connect the function to the MouseClick event\nclickDetector.MouseClick:Connect(onClicked)" }, "@roblox/globaltype/ClickDetector.CursorIcon": { "documentation": "Sets the cursor icon to display when the mouse is hovered over the parent of this ClickDetector or DragDetector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#CursorIcon", "code_sample": "" }, "@roblox/globaltype/ClickDetector.CursorIconContent": { "documentation": "Sets the cursor icon to display when the mouse is hovered over the parent of this ClickDetector or DragDetector. Only supports asset URIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#CursorIconContent", "code_sample": "" }, "@roblox/globaltype/ClickDetector.MaxActivationDistance": { "documentation": "Maximum distance between a character and the ClickDetector or DragDetector for the player to be able to interact with it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#MaxActivationDistance", "code_sample": "" }, "@roblox/globaltype/ClickDetector.MouseClick.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseClick.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseClick.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseClick.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseClick.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseClick.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseClick.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseClick.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseClick.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseClick.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseClick.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseClick.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseClick": { "documentation": "Fires when a player interacts with the parent of a ClickDetector or DragDetector.", "keys": { "Connect": "@roblox/globaltype/ClickDetector.MouseClick.Connect", "ConnectParallel": "@roblox/globaltype/ClickDetector.MouseClick.ConnectParallel", "Once": "@roblox/globaltype/ClickDetector.MouseClick.Once", "Wait": "@roblox/globaltype/ClickDetector.MouseClick.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#MouseClick", "code_sample": "" }, "@roblox/globaltype/ClickDetector.mouseClick.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.mouseClick.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.mouseClick.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.mouseClick.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.mouseClick.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.mouseClick.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.mouseClick.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.mouseClick.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.mouseClick.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.mouseClick.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.mouseClick.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.mouseClick.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.mouseClick": { "documentation": "Deprecated: This deprecated event is a variant of ClickDetector.MouseClick, which should be used instead.", "keys": { "Connect": "@roblox/globaltype/ClickDetector.mouseClick.Connect", "ConnectParallel": "@roblox/globaltype/ClickDetector.mouseClick.ConnectParallel", "Once": "@roblox/globaltype/ClickDetector.mouseClick.Once", "Wait": "@roblox/globaltype/ClickDetector.mouseClick.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#mouseClick", "code_sample": "" }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverEnter": { "documentation": "Fires when the parent of a ClickDetector or DragDetector is hovered over by a player.", "keys": { "Connect": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Connect", "ConnectParallel": "@roblox/globaltype/ClickDetector.MouseHoverEnter.ConnectParallel", "Once": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Once", "Wait": "@roblox/globaltype/ClickDetector.MouseHoverEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#MouseHoverEnter", "code_sample": "local clickDetector = script.Parent:FindFirstChildOfClass(\"ClickDetector\")\n\nclickDetector.MouseHoverEnter:Connect(function(player)\n\tprint(player.Name .. \" hovered over my parent!\")\nend)\n\nclickDetector.MouseHoverLeave:Connect(function(player)\n\tprint(player.Name .. \" hovered off my parent!\")\nend)" }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.MouseHoverLeave.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.MouseHoverLeave": { "documentation": "Fires when a player's cursor hovers off the parent of a ClickDetector or DragDetector.", "keys": { "Connect": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Connect", "ConnectParallel": "@roblox/globaltype/ClickDetector.MouseHoverLeave.ConnectParallel", "Once": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Once", "Wait": "@roblox/globaltype/ClickDetector.MouseHoverLeave.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#MouseHoverLeave", "code_sample": "local clickDetector = script.Parent:FindFirstChildOfClass(\"ClickDetector\")\n\nclickDetector.MouseHoverEnter:Connect(function(player)\n\tprint(player.Name .. \" hovered over my parent!\")\nend)\n\nclickDetector.MouseHoverLeave:Connect(function(player)\n\tprint(player.Name .. \" hovered off my parent!\")\nend)" }, "@roblox/globaltype/ClickDetector.RightMouseClick.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.RightMouseClick.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.RightMouseClick.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.RightMouseClick.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.RightMouseClick.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.RightMouseClick.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.RightMouseClick.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.RightMouseClick.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ClickDetector.RightMouseClick.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.RightMouseClick.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ClickDetector.RightMouseClick.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ClickDetector.RightMouseClick.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ClickDetector.RightMouseClick": { "documentation": "Fires when a player right clicks their mouse cursor on a ClickDetector or DragDetector.", "keys": { "Connect": "@roblox/globaltype/ClickDetector.RightMouseClick.Connect", "ConnectParallel": "@roblox/globaltype/ClickDetector.RightMouseClick.ConnectParallel", "Once": "@roblox/globaltype/ClickDetector.RightMouseClick.Once", "Wait": "@roblox/globaltype/ClickDetector.RightMouseClick.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClickDetector#RightMouseClick", "code_sample": "" }, "@roblox/globaltype/DraggerService": { "documentation": "", "keys": { "AlignDraggedObjects": "@roblox/globaltype/DraggerService.AlignDraggedObjects", "AngleSnapEnabled": "@roblox/globaltype/DraggerService.AngleSnapEnabled", "AngleSnapIncrement": "@roblox/globaltype/DraggerService.AngleSnapIncrement", "AnimateHover": "@roblox/globaltype/DraggerService.AnimateHover", "CollisionsEnabled": "@roblox/globaltype/DraggerService.CollisionsEnabled", "DraggerCoordinateSpace": "@roblox/globaltype/DraggerService.DraggerCoordinateSpace", "DraggerMovementMode": "@roblox/globaltype/DraggerService.DraggerMovementMode", "GeometrySnapColor": "@roblox/globaltype/DraggerService.GeometrySnapColor", "HoverAnimateFrequency": "@roblox/globaltype/DraggerService.HoverAnimateFrequency", "HoverThickness": "@roblox/globaltype/DraggerService.HoverThickness", "JointsEnabled": "@roblox/globaltype/DraggerService.JointsEnabled", "LinearSnapEnabled": "@roblox/globaltype/DraggerService.LinearSnapEnabled", "LinearSnapIncrement": "@roblox/globaltype/DraggerService.LinearSnapIncrement", "PartSnapEnabled": "@roblox/globaltype/DraggerService.PartSnapEnabled", "PivotSnapToGeometry": "@roblox/globaltype/DraggerService.PivotSnapToGeometry", "ShowHover": "@roblox/globaltype/DraggerService.ShowHover", "ShowPivotIndicator": "@roblox/globaltype/DraggerService.ShowPivotIndicator" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService", "code_sample": "" }, "@roblox/globaltype/DraggerService.AlignDraggedObjects": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#AlignDraggedObjects", "code_sample": "" }, "@roblox/globaltype/DraggerService.AngleSnapEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#AngleSnapEnabled", "code_sample": "" }, "@roblox/globaltype/DraggerService.AngleSnapIncrement": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#AngleSnapIncrement", "code_sample": "" }, "@roblox/globaltype/DraggerService.AnimateHover": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#AnimateHover", "code_sample": "" }, "@roblox/globaltype/DraggerService.CollisionsEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#CollisionsEnabled", "code_sample": "" }, "@roblox/globaltype/DraggerService.DraggerCoordinateSpace": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#DraggerCoordinateSpace", "code_sample": "" }, "@roblox/globaltype/DraggerService.DraggerMovementMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#DraggerMovementMode", "code_sample": "" }, "@roblox/globaltype/DraggerService.GeometrySnapColor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#GeometrySnapColor", "code_sample": "" }, "@roblox/globaltype/DraggerService.HoverAnimateFrequency": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#HoverAnimateFrequency", "code_sample": "" }, "@roblox/globaltype/DraggerService.HoverThickness": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#HoverThickness", "code_sample": "" }, "@roblox/globaltype/DraggerService.JointsEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#JointsEnabled", "code_sample": "" }, "@roblox/globaltype/DraggerService.LinearSnapEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#LinearSnapEnabled", "code_sample": "" }, "@roblox/globaltype/DraggerService.LinearSnapIncrement": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#LinearSnapIncrement", "code_sample": "" }, "@roblox/globaltype/DraggerService.PartSnapEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#PartSnapEnabled", "code_sample": "" }, "@roblox/globaltype/DraggerService.PivotSnapToGeometry": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#PivotSnapToGeometry", "code_sample": "" }, "@roblox/globaltype/DraggerService.ShowHover": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#ShowHover", "code_sample": "" }, "@roblox/globaltype/DraggerService.ShowPivotIndicator": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraggerService#ShowPivotIndicator", "code_sample": "" }, "@roblox/globaltype/BaseRemoteEvent": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseRemoteEvent", "code_sample": "" }, "@roblox/globaltype/VisibilityCheckDispatcher": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisibilityCheckDispatcher", "code_sample": "" }, "@roblox/globaltype/LuaSettings": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LuaSettings", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider": { "documentation": "Provides functions to load and preview AnimationClips.", "keys": { "GetAnimationClip": "@roblox/globaltype/AnimationClipProvider.GetAnimationClip", "GetAnimationClipAsync": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync", "GetAnimationClipById": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById", "GetAnimationsAsync": "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync", "GetAnimations": "@roblox/globaltype/AnimationClipProvider.GetAnimations", "GetClipEvaluatorAsync": "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync", "RegisterActiveAnimationClip": "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip", "RegisterAnimationClip": "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClip/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClip/param/1": { "documentation": "The content ID of the animation." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClip/return/0": { "documentation": "The AnimationClip found." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClip": { "documentation": "Deprecated: This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use GetAnimationClipAsync instead.
Returns a AnimationClip from a given asset URL.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClip/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClip/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.GetAnimationClip/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationClip", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync/param/1": { "documentation": "The content ID of the animation." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync/return/0": { "documentation": "The AnimationClip found." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync": { "documentation": "Returns a AnimationClip based on the specified assetId asynchronously.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.GetAnimationClipAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationClipAsync", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/param/1": { "documentation": "The content ID of the animation." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/param/2": { "documentation": "True if a cached version can be returned." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/return/0": { "documentation": "The AnimationClip found." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById": { "documentation": "Deprecated: This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use GetAnimationClipAsync instead.
Returns a AnimationClip from the supplied assetId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/param/1" }, { "name": "useCache", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/param/2" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.GetAnimationClipById/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationClipById", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync/param/1": { "documentation": "The user ID of the user." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync/return/0": { "documentation": "An InventoryPages of animations." }, "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync": { "documentation": "This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.GetAnimationsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationsAsync", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.GetAnimations/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.GetAnimations/param/1": { "documentation": "The user ID of the user." }, "@roblox/globaltype/AnimationClipProvider.GetAnimations/return/0": { "documentation": "An InventoryPages of animations." }, "@roblox/globaltype/AnimationClipProvider.GetAnimations": { "documentation": "Deprecated:
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimations/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/AnimationClipProvider.GetAnimations/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.GetAnimations/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimations", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.GetClipEvaluatorAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetClipEvaluatorAsync", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip/param/1": { "documentation": "The AnimationClip to be used." }, "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip/return/0": { "documentation": "A temporary asset ID generated for localized animation playback." }, "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip": { "documentation": "Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip/param/0" }, { "name": "animationClip", "documentation": "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.RegisterActiveAnimationClip/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#RegisterActiveAnimationClip", "code_sample": "" }, "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip/param/0": { "documentation": "Provides functions to load and preview AnimationClips." }, "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip/param/1": { "documentation": "The AnimationClip to be used." }, "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip/return/0": { "documentation": "A temporary asset ID generated for localized animation playback." }, "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip": { "documentation": "Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. Generates a hash.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip/param/0" }, { "name": "animationClip", "documentation": "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip/param/1" } ], "returns": [ "@roblox/globaltype/AnimationClipProvider.RegisterAnimationClip/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#RegisterAnimationClip", "code_sample": "" }, "@roblox/globaltype/RotationCurve": { "documentation": "Represents a sequence of rotations and the interpolation curve between them.", "keys": { "Length": "@roblox/globaltype/RotationCurve.Length", "GetKeyAtIndex": "@roblox/globaltype/RotationCurve.GetKeyAtIndex", "GetKeyIndicesAtTime": "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime", "GetKeys": "@roblox/globaltype/RotationCurve.GetKeys", "GetValueAtTime": "@roblox/globaltype/RotationCurve.GetValueAtTime", "InsertKey": "@roblox/globaltype/RotationCurve.InsertKey", "RemoveKeyAtIndex": "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex", "SetKeys": "@roblox/globaltype/RotationCurve.SetKeys" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve", "code_sample": "" }, "@roblox/globaltype/RotationCurve.Length": { "documentation": "Number of rotation keys in this curve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#Length", "code_sample": "" }, "@roblox/globaltype/RotationCurve.GetKeyAtIndex/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.GetKeyAtIndex/param/1": { "documentation": "" }, "@roblox/globaltype/RotationCurve.GetKeyAtIndex/return/0": { "documentation": "" }, "@roblox/globaltype/RotationCurve.GetKeyAtIndex": { "documentation": "Returns a copy of a key at a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.GetKeyAtIndex/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/RotationCurve.GetKeyAtIndex/param/1" } ], "returns": [ "@roblox/globaltype/RotationCurve.GetKeyAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#GetKeyAtIndex", "code_sample": "" }, "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime/param/1": { "documentation": "" }, "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime/return/0": { "documentation": "" }, "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime": { "documentation": "Returns the index of the last and first key of a period of time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime/param/1" } ], "returns": [ "@roblox/globaltype/RotationCurve.GetKeyIndicesAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#GetKeyIndicesAtTime", "code_sample": "" }, "@roblox/globaltype/RotationCurve.GetKeys/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.GetKeys/return/0": { "documentation": "Array of RotationCurveKeys." }, "@roblox/globaltype/RotationCurve.GetKeys": { "documentation": "Returns a copy of all the keys in the rotation curve as a Luau array of RotationCurveKeys.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.GetKeys/param/0" } ], "returns": [ "@roblox/globaltype/RotationCurve.GetKeys/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#GetKeys", "code_sample": "" }, "@roblox/globaltype/RotationCurve.GetValueAtTime/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.GetValueAtTime/param/1": { "documentation": "Time at which to sample the curve." }, "@roblox/globaltype/RotationCurve.GetValueAtTime/return/0": { "documentation": "Value of the curve at the requested time." }, "@roblox/globaltype/RotationCurve.GetValueAtTime": { "documentation": "Samples the rotation curve at a given time and returns the corresponding rotation as a CFrame.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.GetValueAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/RotationCurve.GetValueAtTime/param/1" } ], "returns": [ "@roblox/globaltype/RotationCurve.GetValueAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#GetValueAtTime", "code_sample": "" }, "@roblox/globaltype/RotationCurve.InsertKey/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.InsertKey/param/1": { "documentation": "RotationCurveKey to insert." }, "@roblox/globaltype/RotationCurve.InsertKey/return/0": { "documentation": "(see description) ." }, "@roblox/globaltype/RotationCurve.InsertKey": { "documentation": "Adds the key passed as an argument to this curve. If a key at the same time is found, it will be replaced.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.InsertKey/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/RotationCurve.InsertKey/param/1" } ], "returns": [ "@roblox/globaltype/RotationCurve.InsertKey/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#InsertKey", "code_sample": "" }, "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/param/1": { "documentation": "Starting index from which to remove keys." }, "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/param/2": { "documentation": "Number of keys to remove." }, "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/return/0": { "documentation": "Number of keys removed." }, "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex": { "documentation": "Removes a given number of keys starting from a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/param/0" }, { "name": "startingIndex", "documentation": "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/param/1" }, { "name": "count", "documentation": "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/param/2" } ], "returns": [ "@roblox/globaltype/RotationCurve.RemoveKeyAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#RemoveKeyAtIndex", "code_sample": "" }, "@roblox/globaltype/RotationCurve.SetKeys/param/0": { "documentation": "Represents a sequence of rotations and the interpolation curve between them." }, "@roblox/globaltype/RotationCurve.SetKeys/param/1": { "documentation": "Array of RotationCurveKeys." }, "@roblox/globaltype/RotationCurve.SetKeys/return/0": { "documentation": "Number of keys inserted." }, "@roblox/globaltype/RotationCurve.SetKeys": { "documentation": "Resets this curve's keys using the RotationCurveKey array passed as an argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RotationCurve.SetKeys/param/0" }, { "name": "keys", "documentation": "@roblox/globaltype/RotationCurve.SetKeys/param/1" } ], "returns": [ "@roblox/globaltype/RotationCurve.SetKeys/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotationCurve#SetKeys", "code_sample": "" }, "@roblox/globaltype/ReplicatedStorage": { "documentation": "A container service for objects that are replicated to all clients.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReplicatedStorage", "code_sample": "" }, "@roblox/globaltype/VRService": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR).", "keys": { "AutomaticScaling": "@roblox/globaltype/VRService.AutomaticScaling", "AvatarGestures": "@roblox/globaltype/VRService.AvatarGestures", "ControllerModels": "@roblox/globaltype/VRService.ControllerModels", "FadeOutViewOnCollision": "@roblox/globaltype/VRService.FadeOutViewOnCollision", "GuiInputUserCFrame": "@roblox/globaltype/VRService.GuiInputUserCFrame", "LaserPointer": "@roblox/globaltype/VRService.LaserPointer", "ThirdPersonFollowCamEnabled": "@roblox/globaltype/VRService.ThirdPersonFollowCamEnabled", "VREnabled": "@roblox/globaltype/VRService.VREnabled", "GetTouchpadMode": "@roblox/globaltype/VRService.GetTouchpadMode", "GetUserCFrame": "@roblox/globaltype/VRService.GetUserCFrame", "GetUserCFrameEnabled": "@roblox/globaltype/VRService.GetUserCFrameEnabled", "RecenterUserHeadCFrame": "@roblox/globaltype/VRService.RecenterUserHeadCFrame", "RequestNavigation": "@roblox/globaltype/VRService.RequestNavigation", "SetTouchpadMode": "@roblox/globaltype/VRService.SetTouchpadMode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService", "code_sample": "" }, "@roblox/globaltype/VRService.AutomaticScaling": { "documentation": "Automatically adjusts scaling in VR to align the player with their avatar.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#AutomaticScaling", "code_sample": "" }, "@roblox/globaltype/VRService.AvatarGestures": { "documentation": "When true, a VR player will be able to animate their hands and head using their controllers and headset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#AvatarGestures", "code_sample": "" }, "@roblox/globaltype/VRService.ControllerModels": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#ControllerModels", "code_sample": "" }, "@roblox/globaltype/VRService.FadeOutViewOnCollision": { "documentation": "When true, a VR player's view will fade to black when their head collides with an object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#FadeOutViewOnCollision", "code_sample": "" }, "@roblox/globaltype/VRService.GuiInputUserCFrame": { "documentation": "Describes what UserCFrame is responsible for input in VR.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#GuiInputUserCFrame", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nif VRService.VREnabled then\n\tprint(VRService.GuiInputUserCFrame.Name)\nelse\n\tprint(\"No VR device detected!\")\nend" }, "@roblox/globaltype/VRService.LaserPointer": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#LaserPointer", "code_sample": "" }, "@roblox/globaltype/VRService.ThirdPersonFollowCamEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#ThirdPersonFollowCamEnabled", "code_sample": "" }, "@roblox/globaltype/VRService.VREnabled": { "documentation": "Describes whether the user is using a virtual reality device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#VREnabled", "code_sample": "local VRService = game:GetService(\"VRService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.CharacterAdded:Wait()\nlocal head = character:WaitForChild(\"Head\")\n\nlocal function TrackHead(inputType, value)\n\tif inputType == Enum.UserCFrame.Head then\n\t\thead.CFrame = value\n\tend\nend\n\nif VRService.VREnabled then\n\t-- Set the initial CFrame\n\thead.CFrame = VRService:GetUserCFrame(Enum.UserCFrame.Head)\n\n\t-- Track VR headset movement and mirror for character's head\n\tVRService.UserCFrameChanged:Connect(TrackHead)\nend" }, "@roblox/globaltype/VRService.GetTouchpadMode/param/0": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR)." }, "@roblox/globaltype/VRService.GetTouchpadMode/param/1": { "documentation": "The specified VRTouchpad." }, "@roblox/globaltype/VRService.GetTouchpadMode/return/0": { "documentation": "The mode of the specified VRTouchpad." }, "@roblox/globaltype/VRService.GetTouchpadMode": { "documentation": "Returns the VRTouchpadMode indicating the mode of a specified VRTouchpad.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.GetTouchpadMode/param/0" }, { "name": "pad", "documentation": "@roblox/globaltype/VRService.GetTouchpadMode/param/1" } ], "returns": [ "@roblox/globaltype/VRService.GetTouchpadMode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#GetTouchpadMode", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nVRService:GetTouchpadMode(Enum.VRTouchpad.Left)" }, "@roblox/globaltype/VRService.GetUserCFrame/param/0": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR)." }, "@roblox/globaltype/VRService.GetUserCFrame/param/1": { "documentation": "The specified UserCFrame." }, "@roblox/globaltype/VRService.GetUserCFrame/return/0": { "documentation": "" }, "@roblox/globaltype/VRService.GetUserCFrame": { "documentation": "Returns a CFrame describing the position & orientation of a specified virtual reality device as an offset from a point in real world space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.GetUserCFrame/param/0" }, { "name": "type", "documentation": "@roblox/globaltype/VRService.GetUserCFrame/param/1" } ], "returns": [ "@roblox/globaltype/VRService.GetUserCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#GetUserCFrame", "code_sample": "local Workspace = game:GetService(\"Workspace\")\nlocal VRService = game:GetService(\"VRService\")\n\nlocal camera = Workspace.CurrentCamera\nlocal part = script.Parent.Part\nlocal handOffset = VRService:GetUserCFrame(Enum.UserCFrame.LeftHand)\n\n-- Account for headscale\nhandOffset = handOffset.Rotation + handOffset.Position * camera.HeadScale\npart.CFrame = camera.CFrame * handOffset" }, "@roblox/globaltype/VRService.GetUserCFrameEnabled/param/0": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR)." }, "@roblox/globaltype/VRService.GetUserCFrameEnabled/param/1": { "documentation": "The specified type of VR device." }, "@roblox/globaltype/VRService.GetUserCFrameEnabled/return/0": { "documentation": "A boolean indicating whether the specified VR device is enabled (true) or disabled (false)." }, "@roblox/globaltype/VRService.GetUserCFrameEnabled": { "documentation": "Returns true if the specified UserCFrame is available to be listened to.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.GetUserCFrameEnabled/param/0" }, { "name": "type", "documentation": "@roblox/globaltype/VRService.GetUserCFrameEnabled/param/1" } ], "returns": [ "@roblox/globaltype/VRService.GetUserCFrameEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#GetUserCFrameEnabled", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nlocal isEnabled = VRService:GetUserCFrameEnabled(Enum.UserCFrame.Head)\nif isEnabled then\n\tprint(\"VR device is enabled!\")\nelse\n\tprint(\"VR device is disabled!\")\nend" }, "@roblox/globaltype/VRService.RecenterUserHeadCFrame/param/0": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR)." }, "@roblox/globaltype/VRService.RecenterUserHeadCFrame": { "documentation": "Re-centers the CFrame to the current location of the VR headset being worn by the user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.RecenterUserHeadCFrame/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#RecenterUserHeadCFrame", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nVRService:RecenterUserHeadCFrame()" }, "@roblox/globaltype/VRService.RequestNavigation/param/0": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR)." }, "@roblox/globaltype/VRService.RequestNavigation/param/1": { "documentation": "The specified CFrame coordinates." }, "@roblox/globaltype/VRService.RequestNavigation/param/2": { "documentation": "The VR device for which the navigation is requested." }, "@roblox/globaltype/VRService.RequestNavigation": { "documentation": "Requests navigation to the specified CFrame using the specified UserCFrame as the origin for the visualizer parabola.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.RequestNavigation/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/VRService.RequestNavigation/param/1" }, { "name": "inputUserCFrame", "documentation": "@roblox/globaltype/VRService.RequestNavigation/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#RequestNavigation", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nlocal destination = workspace:FindFirstChild(\"NavigationDestination\")\n\nVRService:RequestNavigation(Enum.UserCFrame.Head, destination.CFrame)" }, "@roblox/globaltype/VRService.SetTouchpadMode/param/0": { "documentation": "Service responsible for handling interactions between Roblox and Virtual Reality (VR)." }, "@roblox/globaltype/VRService.SetTouchpadMode/param/1": { "documentation": "The specified VRTouchpad you want to set the mode of." }, "@roblox/globaltype/VRService.SetTouchpadMode/param/2": { "documentation": "The mode you want to set the specified VRTouchpad to." }, "@roblox/globaltype/VRService.SetTouchpadMode": { "documentation": "Sets the mode of the specified VRTouchpad to the specified VRTouchpadMode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.SetTouchpadMode/param/0" }, { "name": "pad", "documentation": "@roblox/globaltype/VRService.SetTouchpadMode/param/1" }, { "name": "mode", "documentation": "@roblox/globaltype/VRService.SetTouchpadMode/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#SetTouchpadMode", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nVRService:SetTouchpadMode(Enum.VRTouchpad.Left, Enum.VRTouchpadMode.Touch)" }, "@roblox/globaltype/VRService.NavigationRequested.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.NavigationRequested.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.NavigationRequested.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.NavigationRequested.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.NavigationRequested.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.NavigationRequested.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.NavigationRequested.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.NavigationRequested.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.NavigationRequested.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.NavigationRequested.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.NavigationRequested.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.NavigationRequested.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.NavigationRequested.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.NavigationRequested.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.NavigationRequested.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.NavigationRequested.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.NavigationRequested.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.NavigationRequested.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VRService.NavigationRequested": { "documentation": "Fired when navigation is requested from VRService.", "keys": { "Connect": "@roblox/globaltype/VRService.NavigationRequested.Connect", "ConnectParallel": "@roblox/globaltype/VRService.NavigationRequested.ConnectParallel", "Once": "@roblox/globaltype/VRService.NavigationRequested.Once", "Wait": "@roblox/globaltype/VRService.NavigationRequested.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#NavigationRequested", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nVRService.NavigationRequested:Connect(function(cframe, inputUserCFrame)\n\tprint(inputUserCFrame.Name .. \" made request with CFrame: \" .. cframe)\nend)" }, "@roblox/globaltype/VRService.TouchpadModeChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.TouchpadModeChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.TouchpadModeChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.TouchpadModeChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.TouchpadModeChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.TouchpadModeChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.TouchpadModeChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.TouchpadModeChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.TouchpadModeChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.TouchpadModeChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.TouchpadModeChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.TouchpadModeChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VRService.TouchpadModeChanged": { "documentation": "Fires if the VRTouchpadMode of a VRTouchpad is changed.", "keys": { "Connect": "@roblox/globaltype/VRService.TouchpadModeChanged.Connect", "ConnectParallel": "@roblox/globaltype/VRService.TouchpadModeChanged.ConnectParallel", "Once": "@roblox/globaltype/VRService.TouchpadModeChanged.Once", "Wait": "@roblox/globaltype/VRService.TouchpadModeChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#TouchpadModeChanged", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nVRService.TouchpadModeChanged:Connect(function(pad, mode)\n\tprint(pad.Name .. \" Touchpad changed to state: \" .. mode.Name)\nend)" }, "@roblox/globaltype/VRService.UserCFrameChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.UserCFrameChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.UserCFrameChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.UserCFrameChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameChanged": { "documentation": "Fires when a UserCFrame is changed.", "keys": { "Connect": "@roblox/globaltype/VRService.UserCFrameChanged.Connect", "ConnectParallel": "@roblox/globaltype/VRService.UserCFrameChanged.ConnectParallel", "Once": "@roblox/globaltype/VRService.UserCFrameChanged.Once", "Wait": "@roblox/globaltype/VRService.UserCFrameChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#UserCFrameChanged", "code_sample": "" }, "@roblox/globaltype/VRService.UserCFrameEnabled.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameEnabled.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.UserCFrameEnabled.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameEnabled.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameEnabled.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.UserCFrameEnabled.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameEnabled.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameEnabled.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VRService.UserCFrameEnabled.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameEnabled.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VRService.UserCFrameEnabled.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VRService.UserCFrameEnabled.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VRService.UserCFrameEnabled": { "documentation": "Fires when a UserCFrame is enabled or disabled.", "keys": { "Connect": "@roblox/globaltype/VRService.UserCFrameEnabled.Connect", "ConnectParallel": "@roblox/globaltype/VRService.UserCFrameEnabled.ConnectParallel", "Once": "@roblox/globaltype/VRService.UserCFrameEnabled.Once", "Wait": "@roblox/globaltype/VRService.UserCFrameEnabled.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VRService#UserCFrameEnabled", "code_sample": "local VRService = game:GetService(\"VRService\")\n\nVRService.UserCFrameEnabled:Connect(function(type, enabled)\n\tif enabled then\n\t\tprint(type.Name .. \" got enabled!\")\n\telse\n\t\tprint(type.Name .. \" got disabled!\")\n\tend\nend)" }, "@roblox/globaltype/PluginDebugService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginDebugService", "code_sample": "" }, "@roblox/globaltype/BodyGyro": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use AlignOrientation instead, and see the legacy conversion notes.
Applies a torque to maintain a constant orientation.", "keys": { "CFrame": "@roblox/globaltype/BodyGyro.CFrame", "cframe": "@roblox/globaltype/BodyGyro.cframe", "D": "@roblox/globaltype/BodyGyro.D", "MaxTorque": "@roblox/globaltype/BodyGyro.MaxTorque", "maxTorque": "@roblox/globaltype/BodyGyro.maxTorque", "P": "@roblox/globaltype/BodyGyro.P" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro", "code_sample": "" }, "@roblox/globaltype/BodyGyro.CFrame": { "documentation": "Determines the target orientation (translational component ignored).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro#CFrame", "code_sample": "" }, "@roblox/globaltype/BodyGyro.cframe": { "documentation": "Deprecated: This property is a deprecated variant of BodyGyro.CFrame which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro#cframe", "code_sample": "" }, "@roblox/globaltype/BodyGyro.D": { "documentation": "Determines the amount of dampening to use in reaching the goal CFrame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro#D", "code_sample": "" }, "@roblox/globaltype/BodyGyro.MaxTorque": { "documentation": "Determines the limit on how much torque that may be applied to each axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro#MaxTorque", "code_sample": "" }, "@roblox/globaltype/BodyGyro.maxTorque": { "documentation": "Deprecated: This property is a deprecated variant of BodyGyro.MaxTorque which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro#maxTorque", "code_sample": "" }, "@roblox/globaltype/BodyGyro.P": { "documentation": "Determines how aggressive of a torque is applied in reaching the goal orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyGyro#P", "code_sample": "" }, "@roblox/globaltype/Constraint": { "documentation": "The base class for constraint-based objects.", "keys": { "Active": "@roblox/globaltype/Constraint.Active", "Attachment0": "@roblox/globaltype/Constraint.Attachment0", "Attachment1": "@roblox/globaltype/Constraint.Attachment1", "Color": "@roblox/globaltype/Constraint.Color", "Enabled": "@roblox/globaltype/Constraint.Enabled", "Visible": "@roblox/globaltype/Constraint.Visible", "GetDebugAppliedForce": "@roblox/globaltype/Constraint.GetDebugAppliedForce", "GetDebugAppliedTorque": "@roblox/globaltype/Constraint.GetDebugAppliedTorque" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint", "code_sample": "" }, "@roblox/globaltype/Constraint.Active": { "documentation": "Indicates if the constraint is currently active in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#Active", "code_sample": "" }, "@roblox/globaltype/Constraint.Attachment0": { "documentation": "The Attachment that is connected to Constraint.Attachment1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#Attachment0", "code_sample": "" }, "@roblox/globaltype/Constraint.Attachment1": { "documentation": "The Attachment that is connected to Constraint.Attachment0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#Attachment1", "code_sample": "" }, "@roblox/globaltype/Constraint.Color": { "documentation": "The color of the constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#Color", "code_sample": "" }, "@roblox/globaltype/Constraint.Enabled": { "documentation": "Toggles whether or not the constraint is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#Enabled", "code_sample": "" }, "@roblox/globaltype/Constraint.Visible": { "documentation": "Toggles the constraint's visibility.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#Visible", "code_sample": "" }, "@roblox/globaltype/Constraint.GetDebugAppliedForce/param/0": { "documentation": "The base class for constraint-based objects." }, "@roblox/globaltype/Constraint.GetDebugAppliedForce/param/1": { "documentation": "" }, "@roblox/globaltype/Constraint.GetDebugAppliedForce/return/0": { "documentation": "" }, "@roblox/globaltype/Constraint.GetDebugAppliedForce": { "documentation": "Deprecated: This method should not be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Constraint.GetDebugAppliedForce/param/0" }, { "name": "bodyId", "documentation": "@roblox/globaltype/Constraint.GetDebugAppliedForce/param/1" } ], "returns": [ "@roblox/globaltype/Constraint.GetDebugAppliedForce/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#GetDebugAppliedForce", "code_sample": "" }, "@roblox/globaltype/Constraint.GetDebugAppliedTorque/param/0": { "documentation": "The base class for constraint-based objects." }, "@roblox/globaltype/Constraint.GetDebugAppliedTorque/param/1": { "documentation": "" }, "@roblox/globaltype/Constraint.GetDebugAppliedTorque/return/0": { "documentation": "" }, "@roblox/globaltype/Constraint.GetDebugAppliedTorque": { "documentation": "Deprecated: This method should not be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Constraint.GetDebugAppliedTorque/param/0" }, { "name": "bodyId", "documentation": "@roblox/globaltype/Constraint.GetDebugAppliedTorque/param/1" } ], "returns": [ "@roblox/globaltype/Constraint.GetDebugAppliedTorque/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Constraint#GetDebugAppliedTorque", "code_sample": "" }, "@roblox/globaltype/StudioTheme": { "documentation": "", "keys": { "GetColor": "@roblox/globaltype/StudioTheme.GetColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTheme", "code_sample": "" }, "@roblox/globaltype/StudioTheme.GetColor/param/0": { "documentation": "" }, "@roblox/globaltype/StudioTheme.GetColor/param/1": { "documentation": "The element you want to get the theme color for." }, "@roblox/globaltype/StudioTheme.GetColor/param/2": { "documentation": "The modifier you want to place on the StyleGuideColor element." }, "@roblox/globaltype/StudioTheme.GetColor/return/0": { "documentation": "The corresponding Color3 theme value." }, "@roblox/globaltype/StudioTheme.GetColor": { "documentation": "Returns the color corresponding to the arguments provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioTheme.GetColor/param/0" }, { "name": "styleguideitem", "documentation": "@roblox/globaltype/StudioTheme.GetColor/param/1" }, { "name": "modifier", "documentation": "@roblox/globaltype/StudioTheme.GetColor/param/2" } ], "returns": [ "@roblox/globaltype/StudioTheme.GetColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTheme#GetColor", "code_sample": "" }, "@roblox/globaltype/SwimController": { "documentation": "", "keys": { "AccelerationTime": "@roblox/globaltype/SwimController.AccelerationTime", "PitchMaxTorque": "@roblox/globaltype/SwimController.PitchMaxTorque", "PitchSpeedFactor": "@roblox/globaltype/SwimController.PitchSpeedFactor", "RollMaxTorque": "@roblox/globaltype/SwimController.RollMaxTorque", "RollSpeedFactor": "@roblox/globaltype/SwimController.RollSpeedFactor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SwimController", "code_sample": "" }, "@roblox/globaltype/SwimController.AccelerationTime": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SwimController#AccelerationTime", "code_sample": "" }, "@roblox/globaltype/SwimController.PitchMaxTorque": { "documentation": "The maximum torque used to rotate to the desired pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SwimController#PitchMaxTorque", "code_sample": "" }, "@roblox/globaltype/SwimController.PitchSpeedFactor": { "documentation": "Multiplied by ControllerManager.BaseTurnSpeed to determine the maximum angular velocity for pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SwimController#PitchSpeedFactor", "code_sample": "" }, "@roblox/globaltype/SwimController.RollMaxTorque": { "documentation": "The maximum torque applied to rotate to the desired roll.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SwimController#RollMaxTorque", "code_sample": "" }, "@roblox/globaltype/SwimController.RollSpeedFactor": { "documentation": "Multiplied by ControllerManager.BaseTurnSpeed to determine the maximum angular velocity for roll.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SwimController#RollSpeedFactor", "code_sample": "" }, "@roblox/globaltype/UIGradient": { "documentation": "Applies a color and transparency gradient to the UI elements rendered by the parent GuiObject.", "keys": { "Color": "@roblox/globaltype/UIGradient.Color", "Enabled": "@roblox/globaltype/UIGradient.Enabled", "Offset": "@roblox/globaltype/UIGradient.Offset", "Rotation": "@roblox/globaltype/UIGradient.Rotation", "Transparency": "@roblox/globaltype/UIGradient.Transparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGradient", "code_sample": "" }, "@roblox/globaltype/UIGradient.Color": { "documentation": "Determines the color blended with the parent GuiObject along the length of the gradient.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGradient#Color", "code_sample": "" }, "@roblox/globaltype/UIGradient.Enabled": { "documentation": "Whether the gradient is enabled or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGradient#Enabled", "code_sample": "" }, "@roblox/globaltype/UIGradient.Offset": { "documentation": "Determines the scalar translation of the gradient from the center of the parent GuiObject.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGradient#Offset", "code_sample": "" }, "@roblox/globaltype/UIGradient.Rotation": { "documentation": "Determines the clockwise rotation in degrees of the gradient starting from left to right.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGradient#Rotation", "code_sample": "" }, "@roblox/globaltype/UIGradient.Transparency": { "documentation": "Determines how much the parent GuiObject can be seen through along the length of the gradient.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGradient#Transparency", "code_sample": "" }, "@roblox/globaltype/AlignOrientation": { "documentation": "Constraint which applies torque to align two attachments, or to align one attachment with a goal orientation.", "keys": { "AlignType": "@roblox/globaltype/AlignOrientation.AlignType", "CFrame": "@roblox/globaltype/AlignOrientation.CFrame", "LookAtPosition": "@roblox/globaltype/AlignOrientation.LookAtPosition", "MaxAngularVelocity": "@roblox/globaltype/AlignOrientation.MaxAngularVelocity", "MaxTorque": "@roblox/globaltype/AlignOrientation.MaxTorque", "Mode": "@roblox/globaltype/AlignOrientation.Mode", "PrimaryAxis": "@roblox/globaltype/AlignOrientation.PrimaryAxis", "PrimaryAxisOnly": "@roblox/globaltype/AlignOrientation.PrimaryAxisOnly", "ReactionTorqueEnabled": "@roblox/globaltype/AlignOrientation.ReactionTorqueEnabled", "Responsiveness": "@roblox/globaltype/AlignOrientation.Responsiveness", "RigidityEnabled": "@roblox/globaltype/AlignOrientation.RigidityEnabled", "SecondaryAxis": "@roblox/globaltype/AlignOrientation.SecondaryAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.AlignType": { "documentation": "The constraint's axis alignment type.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#AlignType", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.CFrame": { "documentation": "The CFrame orientation with which the constraint will attempt to match the orientation of Attachment0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#CFrame", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.LookAtPosition": { "documentation": "A Vector3 world space location toward which the primary axis will attempt to align.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#LookAtPosition", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.MaxAngularVelocity": { "documentation": "Maximum angular velocity the constraint can use to reach its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#MaxAngularVelocity", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.MaxTorque": { "documentation": "Maximum torque the constraint can use to reach its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#MaxTorque", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.Mode": { "documentation": "Whether the constraint uses one or two attachments in calculating its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#Mode", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.PrimaryAxis": { "documentation": "The direction of the goal's X axis, represented as a unit Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#PrimaryAxis", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.PrimaryAxisOnly": { "documentation": "Determines how the constraint's axes are affected by torque.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#PrimaryAxisOnly", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.ReactionTorqueEnabled": { "documentation": "Whether the constraint applies torque only to Attachment0, or to both attachments in equal and opposite directions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#ReactionTorqueEnabled", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.Responsiveness": { "documentation": "Controls how quickly the constraint reaches its goal. Higher values cause the attachment(s) to align more rapidly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#Responsiveness", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.RigidityEnabled": { "documentation": "Whether torque is dependent on other properties, or if the physics solver reacts as quickly as possible to complete the alignment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#RigidityEnabled", "code_sample": "" }, "@roblox/globaltype/AlignOrientation.SecondaryAxis": { "documentation": "The direction of the goal's Y axis, represented as a unit Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignOrientation#SecondaryAxis", "code_sample": "" }, "@roblox/globaltype/JointsService": { "documentation": "Deprecated: This service has been deprecated in favor of constraints which should be used for surface connections instead
A service that stores joints created by surface connections.", "keys": { "ClearJoinAfterMoveJoints": "@roblox/globaltype/JointsService.ClearJoinAfterMoveJoints", "CreateJoinAfterMoveJoints": "@roblox/globaltype/JointsService.CreateJoinAfterMoveJoints", "SetJoinAfterMoveInstance": "@roblox/globaltype/JointsService.SetJoinAfterMoveInstance", "SetJoinAfterMoveTarget": "@roblox/globaltype/JointsService.SetJoinAfterMoveTarget", "ShowPermissibleJoints": "@roblox/globaltype/JointsService.ShowPermissibleJoints" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointsService", "code_sample": "" }, "@roblox/globaltype/JointsService.ClearJoinAfterMoveJoints/param/0": { "documentation": "Deprecated: This service has been deprecated in favor of constraints which should be used for surface connections instead
A service that stores joints created by surface connections." }, "@roblox/globaltype/JointsService.ClearJoinAfterMoveJoints": { "documentation": "Will remove any 'create joints' that were made visible via the JointsService:ShowPermissibleJoints() method.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/JointsService.ClearJoinAfterMoveJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointsService#ClearJoinAfterMoveJoints", "code_sample": "" }, "@roblox/globaltype/JointsService.CreateJoinAfterMoveJoints/param/0": { "documentation": "Deprecated: This service has been deprecated in favor of constraints which should be used for surface connections instead
A service that stores joints created by surface connections." }, "@roblox/globaltype/JointsService.CreateJoinAfterMoveJoints": { "documentation": "Updates all visible joints for the parts assigned by the JointsService:SetJoinAfterMoveTarget() and JointsService:SetJoinAfterMoveInstance() methods.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/JointsService.CreateJoinAfterMoveJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointsService#CreateJoinAfterMoveJoints", "code_sample": "" }, "@roblox/globaltype/JointsService.SetJoinAfterMoveInstance/param/0": { "documentation": "Deprecated: This service has been deprecated in favor of constraints which should be used for surface connections instead
A service that stores joints created by surface connections." }, "@roblox/globaltype/JointsService.SetJoinAfterMoveInstance/param/1": { "documentation": "" }, "@roblox/globaltype/JointsService.SetJoinAfterMoveInstance": { "documentation": "Sets the PVInstance that will be connected with the target PVInstance specified by JointsService:SetJoinAfterMoveTarget().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/JointsService.SetJoinAfterMoveInstance/param/0" }, { "name": "joinInstance", "documentation": "@roblox/globaltype/JointsService.SetJoinAfterMoveInstance/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointsService#SetJoinAfterMoveInstance", "code_sample": "" }, "@roblox/globaltype/JointsService.SetJoinAfterMoveTarget/param/0": { "documentation": "Deprecated: This service has been deprecated in favor of constraints which should be used for surface connections instead
A service that stores joints created by surface connections." }, "@roblox/globaltype/JointsService.SetJoinAfterMoveTarget/param/1": { "documentation": "" }, "@roblox/globaltype/JointsService.SetJoinAfterMoveTarget": { "documentation": "Sets the PVInstance that will be connected with the PVInstance specified by JointsService:SetJoinAfterMoveInstance().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/JointsService.SetJoinAfterMoveTarget/param/0" }, { "name": "joinTarget", "documentation": "@roblox/globaltype/JointsService.SetJoinAfterMoveTarget/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointsService#SetJoinAfterMoveTarget", "code_sample": "" }, "@roblox/globaltype/JointsService.ShowPermissibleJoints/param/0": { "documentation": "Deprecated: This service has been deprecated in favor of constraints which should be used for surface connections instead
A service that stores joints created by surface connections." }, "@roblox/globaltype/JointsService.ShowPermissibleJoints": { "documentation": "When used it will visibly display a potential surface connection between the two BasePart, which were set with JointsService:SetJoinAfterMoveTarget() and JointsService:SetJoinAfterMoveInstance().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/JointsService.ShowPermissibleJoints/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointsService#ShowPermissibleJoints", "code_sample": "" }, "@roblox/globaltype/Color3Value": { "documentation": "A container object for a single Color3 value.", "keys": { "Value": "@roblox/globaltype/Color3Value.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Color3Value", "code_sample": "" }, "@roblox/globaltype/Color3Value.Value": { "documentation": "The stored Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Color3Value#Value", "code_sample": "" }, "@roblox/globaltype/Color3Value.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Color3Value.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Color3Value.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Color3Value.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Color3Value.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Color3Value.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Color3Value.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Color3Value.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Color3Value.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Color3Value.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Color3Value.Changed": { "documentation": "Fired whenever the Color3Value.Value is changed.", "keys": { "Connect": "@roblox/globaltype/Color3Value.Changed.Connect", "ConnectParallel": "@roblox/globaltype/Color3Value.Changed.ConnectParallel", "Once": "@roblox/globaltype/Color3Value.Changed.Once", "Wait": "@roblox/globaltype/Color3Value.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Color3Value#Changed", "code_sample": "local value = Instance.new(\"Color3Value\")\nvalue.Parent = workspace\n\nvalue.Changed:Connect(function(NewValue)\n\tprint(NewValue)\nend)\n\nvalue.Value = Color3.fromRGB(50, 50, 50)" }, "@roblox/globaltype/Color3Value.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Color3Value.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Color3Value.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Color3Value.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Color3Value.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Color3Value.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Color3Value.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Color3Value.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Color3Value.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Color3Value.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Color3Value.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Color3Value.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Color3Value.changed": { "documentation": "Deprecated: This deprecated event is a variant of Color3Value.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/Color3Value.changed.Connect", "ConnectParallel": "@roblox/globaltype/Color3Value.changed.ConnectParallel", "Once": "@roblox/globaltype/Color3Value.changed.Once", "Wait": "@roblox/globaltype/Color3Value.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Color3Value#changed", "code_sample": "" }, "@roblox/globaltype/ChorusSoundEffect": { "documentation": "Makes audio more voluminous by simulating multiple voices playing the same part.", "keys": { "Depth": "@roblox/globaltype/ChorusSoundEffect.Depth", "Mix": "@roblox/globaltype/ChorusSoundEffect.Mix", "Rate": "@roblox/globaltype/ChorusSoundEffect.Rate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChorusSoundEffect", "code_sample": "" }, "@roblox/globaltype/ChorusSoundEffect.Depth": { "documentation": "Controls how intense the effect is.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChorusSoundEffect#Depth", "code_sample": "" }, "@roblox/globaltype/ChorusSoundEffect.Mix": { "documentation": "Percentage of the original sound that will be applied to the filter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChorusSoundEffect#Mix", "code_sample": "" }, "@roblox/globaltype/ChorusSoundEffect.Rate": { "documentation": "How frequently the pitch variation changes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChorusSoundEffect#Rate", "code_sample": "" }, "@roblox/globaltype/Attachment": { "documentation": "Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment.", "keys": { "Axis": "@roblox/globaltype/Attachment.Axis", "CFrame": "@roblox/globaltype/Attachment.CFrame", "Orientation": "@roblox/globaltype/Attachment.Orientation", "Position": "@roblox/globaltype/Attachment.Position", "Rotation": "@roblox/globaltype/Attachment.Rotation", "SecondaryAxis": "@roblox/globaltype/Attachment.SecondaryAxis", "Visible": "@roblox/globaltype/Attachment.Visible", "WorldAxis": "@roblox/globaltype/Attachment.WorldAxis", "WorldCFrame": "@roblox/globaltype/Attachment.WorldCFrame", "WorldOrientation": "@roblox/globaltype/Attachment.WorldOrientation", "WorldPosition": "@roblox/globaltype/Attachment.WorldPosition", "WorldRotation": "@roblox/globaltype/Attachment.WorldRotation", "WorldSecondaryAxis": "@roblox/globaltype/Attachment.WorldSecondaryAxis", "GetAxis": "@roblox/globaltype/Attachment.GetAxis", "GetConstraints": "@roblox/globaltype/Attachment.GetConstraints", "GetSecondaryAxis": "@roblox/globaltype/Attachment.GetSecondaryAxis", "SetAxis": "@roblox/globaltype/Attachment.SetAxis", "SetSecondaryAxis": "@roblox/globaltype/Attachment.SetSecondaryAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment", "code_sample": "" }, "@roblox/globaltype/Attachment.Axis": { "documentation": "Direction of the X axis of the attachment, represented as a unit Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#Axis", "code_sample": "" }, "@roblox/globaltype/Attachment.CFrame": { "documentation": "CFrame offset of the attachment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#CFrame", "code_sample": "" }, "@roblox/globaltype/Attachment.Orientation": { "documentation": "Orientation of the attachment relative to the orientation of its parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#Orientation", "code_sample": "" }, "@roblox/globaltype/Attachment.Position": { "documentation": "Positional offset of the attachment, relative to the position and orientation of its parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#Position", "code_sample": "" }, "@roblox/globaltype/Attachment.Rotation": { "documentation": "Deprecated: This property is deprecated and should not be used in new work. See Orientation instead.
Rotation of the attachment relative to the rotation of its parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#Rotation", "code_sample": "" }, "@roblox/globaltype/Attachment.SecondaryAxis": { "documentation": "Direction of the Y axis of the attachment, represented as a unit Vector3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#SecondaryAxis", "code_sample": "" }, "@roblox/globaltype/Attachment.Visible": { "documentation": "Toggles the in-experience visibility of the attachment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#Visible", "code_sample": "" }, "@roblox/globaltype/Attachment.WorldAxis": { "documentation": "Direction of the X axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldAxis", "code_sample": "" }, "@roblox/globaltype/Attachment.WorldCFrame": { "documentation": "The exact CFrame of the attachment in world space coordinates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldCFrame", "code_sample": "" }, "@roblox/globaltype/Attachment.WorldOrientation": { "documentation": "Orientation of the attachment relative to the world rather than its own parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldOrientation", "code_sample": "" }, "@roblox/globaltype/Attachment.WorldPosition": { "documentation": "Position of the attachment relative to the world rather than its own parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldPosition", "code_sample": "" }, "@roblox/globaltype/Attachment.WorldRotation": { "documentation": "Deprecated: This item has been superseded by WorldOrientation which should be used in new work.
Rotation of the attachment relative to the world rather than its own parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldRotation", "code_sample": "" }, "@roblox/globaltype/Attachment.WorldSecondaryAxis": { "documentation": "Direction of the Y axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#WorldSecondaryAxis", "code_sample": "" }, "@roblox/globaltype/Attachment.GetAxis/param/0": { "documentation": "Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment." }, "@roblox/globaltype/Attachment.GetAxis/return/0": { "documentation": "" }, "@roblox/globaltype/Attachment.GetAxis": { "documentation": "Deprecated: This method is deprecated and should not be used in new work.
Returns the value of the attachment's Axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Attachment.GetAxis/param/0" } ], "returns": [ "@roblox/globaltype/Attachment.GetAxis/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#GetAxis", "code_sample": "" }, "@roblox/globaltype/Attachment.GetConstraints/param/0": { "documentation": "Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment." }, "@roblox/globaltype/Attachment.GetConstraints/return/0": { "documentation": "" }, "@roblox/globaltype/Attachment.GetConstraints": { "documentation": "Returns a list of Constraints connected to the attachment.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Attachment.GetConstraints/param/0" } ], "returns": [ "@roblox/globaltype/Attachment.GetConstraints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#GetConstraints", "code_sample": "" }, "@roblox/globaltype/Attachment.GetSecondaryAxis/param/0": { "documentation": "Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment." }, "@roblox/globaltype/Attachment.GetSecondaryAxis/return/0": { "documentation": "" }, "@roblox/globaltype/Attachment.GetSecondaryAxis": { "documentation": "Deprecated: This method is deprecated and should not be used in new work.
Returns the value of the attachment's SecondaryAxis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Attachment.GetSecondaryAxis/param/0" } ], "returns": [ "@roblox/globaltype/Attachment.GetSecondaryAxis/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#GetSecondaryAxis", "code_sample": "" }, "@roblox/globaltype/Attachment.SetAxis/param/0": { "documentation": "Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment." }, "@roblox/globaltype/Attachment.SetAxis/param/1": { "documentation": "" }, "@roblox/globaltype/Attachment.SetAxis": { "documentation": "Deprecated: This method is deprecated and should not be used in new work.
Sets the value of the attachment's Axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Attachment.SetAxis/param/0" }, { "name": "axis", "documentation": "@roblox/globaltype/Attachment.SetAxis/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#SetAxis", "code_sample": "" }, "@roblox/globaltype/Attachment.SetSecondaryAxis/param/0": { "documentation": "Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment." }, "@roblox/globaltype/Attachment.SetSecondaryAxis/param/1": { "documentation": "" }, "@roblox/globaltype/Attachment.SetSecondaryAxis": { "documentation": "Deprecated: This method is deprecated and should not be used in new work.
Sets the value of the attachment's SecondaryAxis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Attachment.SetSecondaryAxis/param/0" }, { "name": "axis", "documentation": "@roblox/globaltype/Attachment.SetSecondaryAxis/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Attachment#SetSecondaryAxis", "code_sample": "" }, "@roblox/globaltype/IntConstrainedValue": { "documentation": "Deprecated: The IntConstrainedValue object has been deprecated as developers can now use the math.clamp() function to constrain values.
An IntConstrainedValue is used to store a value which can never be less than MinValue and can never be more than MaxValue.", "keys": { "ConstrainedValue": "@roblox/globaltype/IntConstrainedValue.ConstrainedValue", "MaxValue": "@roblox/globaltype/IntConstrainedValue.MaxValue", "MinValue": "@roblox/globaltype/IntConstrainedValue.MinValue", "Value": "@roblox/globaltype/IntConstrainedValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue", "code_sample": "" }, "@roblox/globaltype/IntConstrainedValue.ConstrainedValue": { "documentation": "Hold an Integer value between IntConstrainedValue.MinValue and IntConstrainedValue.MaxValue. Replaced by IntConstrainedValue.Value, but still functional.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue#ConstrainedValue", "code_sample": "" }, "@roblox/globaltype/IntConstrainedValue.MaxValue": { "documentation": "The highest number that the IntConstrainedValue.Value property can be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue#MaxValue", "code_sample": "" }, "@roblox/globaltype/IntConstrainedValue.MinValue": { "documentation": "The lowest number that the IntConstrainedValue.Value property can be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue#MinValue", "code_sample": "" }, "@roblox/globaltype/IntConstrainedValue.Value": { "documentation": "Used to hold an integer value between IntConstrainedValue.MinValue and IntConstrainedValue.MaxValue.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue#Value", "code_sample": "" }, "@roblox/globaltype/IntConstrainedValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/IntConstrainedValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/IntConstrainedValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/IntConstrainedValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.Changed": { "documentation": "Fired whenever the Value of the IntConstrainedValue is changed.", "keys": { "Connect": "@roblox/globaltype/IntConstrainedValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/IntConstrainedValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/IntConstrainedValue.Changed.Once", "Wait": "@roblox/globaltype/IntConstrainedValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue#Changed", "code_sample": "local function valueChanged(newValue)\n\tprint(newValue)\nend\n\nworkspace.IntConstrainedValue.Changed:Connect(valueChanged)\n\nworkspace.IntConstrainedValue.Value = 2" }, "@roblox/globaltype/IntConstrainedValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/IntConstrainedValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/IntConstrainedValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/IntConstrainedValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/IntConstrainedValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IntConstrainedValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/IntConstrainedValue.changed": { "documentation": "Deprecated: This deprecated event is a variant of IntConstrainedValue.Changed which has also been deprecated. Neither event should be used in new work.", "keys": { "Connect": "@roblox/globaltype/IntConstrainedValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/IntConstrainedValue.changed.ConnectParallel", "Once": "@roblox/globaltype/IntConstrainedValue.changed.Once", "Wait": "@roblox/globaltype/IntConstrainedValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntConstrainedValue#changed", "code_sample": "" }, "@roblox/globaltype/VisualizationMode": { "documentation": "", "keys": { "Enabled": "@roblox/globaltype/VisualizationMode.Enabled", "Title": "@roblox/globaltype/VisualizationMode.Title", "ToolTip": "@roblox/globaltype/VisualizationMode.ToolTip" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationMode", "code_sample": "" }, "@roblox/globaltype/VisualizationMode.Enabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationMode#Enabled", "code_sample": "" }, "@roblox/globaltype/VisualizationMode.Title": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationMode#Title", "code_sample": "" }, "@roblox/globaltype/VisualizationMode.ToolTip": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationMode#ToolTip", "code_sample": "" }, "@roblox/globaltype/HttpRbxApiService": { "documentation": "An internal service whose functionality is not available to developers.", "keys": { "RequestLimitedAsync": "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpRbxApiService", "code_sample": "" }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/0": { "documentation": "An internal service whose functionality is not available to developers." }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/1": { "documentation": "" }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/2": { "documentation": "" }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/3": { "documentation": "" }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/4": { "documentation": "" }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/return/0": { "documentation": "" }, "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/0" }, { "name": "requestOptions", "documentation": "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/1" }, { "name": "priority", "documentation": "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/2" }, { "name": "content_type", "documentation": "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/3" }, { "name": "httpRequestType", "documentation": "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/param/4" } ], "returns": [ "@roblox/globaltype/HttpRbxApiService.RequestLimitedAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HttpRbxApiService#RequestLimitedAsync", "code_sample": "" }, "@roblox/globaltype/UIConstraint": { "documentation": "The base class for UI constraint classes.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIConstraint", "code_sample": "" }, "@roblox/globaltype/TerrainDetail": { "documentation": "Determines appearance of a certain terrain face direction.", "keys": { "ColorMap": "@roblox/globaltype/TerrainDetail.ColorMap", "ColorMapContent": "@roblox/globaltype/TerrainDetail.ColorMapContent", "EmissiveMaskContent": "@roblox/globaltype/TerrainDetail.EmissiveMaskContent", "EmissiveStrength": "@roblox/globaltype/TerrainDetail.EmissiveStrength", "EmissiveTint": "@roblox/globaltype/TerrainDetail.EmissiveTint", "Face": "@roblox/globaltype/TerrainDetail.Face", "MaterialPattern": "@roblox/globaltype/TerrainDetail.MaterialPattern", "MetalnessMap": "@roblox/globaltype/TerrainDetail.MetalnessMap", "MetalnessMapContent": "@roblox/globaltype/TerrainDetail.MetalnessMapContent", "NormalMap": "@roblox/globaltype/TerrainDetail.NormalMap", "NormalMapContent": "@roblox/globaltype/TerrainDetail.NormalMapContent", "RoughnessMap": "@roblox/globaltype/TerrainDetail.RoughnessMap", "RoughnessMapContent": "@roblox/globaltype/TerrainDetail.RoughnessMapContent", "StudsPerTile": "@roblox/globaltype/TerrainDetail.StudsPerTile" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.ColorMap": { "documentation": "Determines the color of the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#ColorMap", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.ColorMapContent": { "documentation": "Determines the color of the surface. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#ColorMapContent", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.EmissiveMaskContent": { "documentation": "Determines the emissivity across the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#EmissiveMaskContent", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.EmissiveStrength": { "documentation": "Determines the strength of emissive contribution.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#EmissiveStrength", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.EmissiveTint": { "documentation": "Determines the tinting color for emissive contribution.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#EmissiveTint", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.Face": { "documentation": "The face this TerrainDetail overrides.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#Face", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.MaterialPattern": { "documentation": "Determines texture tiling method.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#MaterialPattern", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.MetalnessMap": { "documentation": "Determines which parts of the surface are metal and are non-metal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#MetalnessMap", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.MetalnessMapContent": { "documentation": "Determines which parts of the surface are metal and are non-metal. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#MetalnessMapContent", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.NormalMap": { "documentation": "Modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#NormalMap", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.NormalMapContent": { "documentation": "Modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#NormalMapContent", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.RoughnessMap": { "documentation": "Determines the apparent roughness across the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#RoughnessMap", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.RoughnessMapContent": { "documentation": "Determines the apparent roughness across the surface. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#RoughnessMapContent", "code_sample": "" }, "@roblox/globaltype/TerrainDetail.StudsPerTile": { "documentation": "Determines the scale of textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainDetail#StudsPerTile", "code_sample": "" }, "@roblox/globaltype/PatchMapping": { "documentation": "", "keys": { "FlattenTree": "@roblox/globaltype/PatchMapping.FlattenTree", "PatchId": "@roblox/globaltype/PatchMapping.PatchId", "TargetPath": "@roblox/globaltype/PatchMapping.TargetPath" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PatchMapping", "code_sample": "" }, "@roblox/globaltype/PatchMapping.FlattenTree": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PatchMapping#FlattenTree", "code_sample": "" }, "@roblox/globaltype/PatchMapping.PatchId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PatchMapping#PatchId", "code_sample": "" }, "@roblox/globaltype/PatchMapping.TargetPath": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PatchMapping#TargetPath", "code_sample": "" }, "@roblox/globaltype/Player": { "documentation": "An object that represents a presently connected client to the experience.", "keys": { "AccountAge": "@roblox/globaltype/Player.AccountAge", "AutoJumpEnabled": "@roblox/globaltype/Player.AutoJumpEnabled", "CameraMaxZoomDistance": "@roblox/globaltype/Player.CameraMaxZoomDistance", "CameraMinZoomDistance": "@roblox/globaltype/Player.CameraMinZoomDistance", "CameraMode": "@roblox/globaltype/Player.CameraMode", "CanLoadCharacterAppearance": "@roblox/globaltype/Player.CanLoadCharacterAppearance", "Character": "@roblox/globaltype/Player.Character", "CharacterAppearance": "@roblox/globaltype/Player.CharacterAppearance", "CharacterAppearanceId": "@roblox/globaltype/Player.CharacterAppearanceId", "DataComplexity": "@roblox/globaltype/Player.DataComplexity", "DataReady": "@roblox/globaltype/Player.DataReady", "DevCameraOcclusionMode": "@roblox/globaltype/Player.DevCameraOcclusionMode", "DevComputerCameraMode": "@roblox/globaltype/Player.DevComputerCameraMode", "DevComputerMovementMode": "@roblox/globaltype/Player.DevComputerMovementMode", "DevEnableMouseLock": "@roblox/globaltype/Player.DevEnableMouseLock", "DevTouchCameraMode": "@roblox/globaltype/Player.DevTouchCameraMode", "DevTouchMovementMode": "@roblox/globaltype/Player.DevTouchMovementMode", "DisplayName": "@roblox/globaltype/Player.DisplayName", "FollowUserId": "@roblox/globaltype/Player.FollowUserId", "GameplayPaused": "@roblox/globaltype/Player.GameplayPaused", "HasVerifiedBadge": "@roblox/globaltype/Player.HasVerifiedBadge", "HealthDisplayDistance": "@roblox/globaltype/Player.HealthDisplayDistance", "LocaleId": "@roblox/globaltype/Player.LocaleId", "MembershipType": "@roblox/globaltype/Player.MembershipType", "NameDisplayDistance": "@roblox/globaltype/Player.NameDisplayDistance", "Neutral": "@roblox/globaltype/Player.Neutral", "PartyId": "@roblox/globaltype/Player.PartyId", "ReplicationFocus": "@roblox/globaltype/Player.ReplicationFocus", "RespawnLocation": "@roblox/globaltype/Player.RespawnLocation", "StepIdOffset": "@roblox/globaltype/Player.StepIdOffset", "Team": "@roblox/globaltype/Player.Team", "TeamColor": "@roblox/globaltype/Player.TeamColor", "ThirdPartyTextChatRestrictionStatus": "@roblox/globaltype/Player.ThirdPartyTextChatRestrictionStatus", "UserId": "@roblox/globaltype/Player.UserId", "userId": "@roblox/globaltype/Player.userId", "AddReplicationFocus": "@roblox/globaltype/Player.AddReplicationFocus", "ClearCharacterAppearance": "@roblox/globaltype/Player.ClearCharacterAppearance", "DistanceFromCharacter": "@roblox/globaltype/Player.DistanceFromCharacter", "GetFriendsOnlineAsync": "@roblox/globaltype/Player.GetFriendsOnlineAsync", "GetFriendsOnline": "@roblox/globaltype/Player.GetFriendsOnline", "GetJoinData": "@roblox/globaltype/Player.GetJoinData", "GetMouse": "@roblox/globaltype/Player.GetMouse", "GetNetworkPing": "@roblox/globaltype/Player.GetNetworkPing", "GetRankInGroupAsync": "@roblox/globaltype/Player.GetRankInGroupAsync", "GetRankInGroup": "@roblox/globaltype/Player.GetRankInGroup", "GetRoleInGroupAsync": "@roblox/globaltype/Player.GetRoleInGroupAsync", "GetRoleInGroup": "@roblox/globaltype/Player.GetRoleInGroup", "HasAppearanceLoaded": "@roblox/globaltype/Player.HasAppearanceLoaded", "IsBestFriendsWith": "@roblox/globaltype/Player.IsBestFriendsWith", "IsFriendsWithAsync": "@roblox/globaltype/Player.IsFriendsWithAsync", "IsFriendsWith": "@roblox/globaltype/Player.IsFriendsWith", "isFriendsWith": "@roblox/globaltype/Player.isFriendsWith", "IsInGroupAsync": "@roblox/globaltype/Player.IsInGroupAsync", "IsInGroup": "@roblox/globaltype/Player.IsInGroup", "IsVerified": "@roblox/globaltype/Player.IsVerified", "Kick": "@roblox/globaltype/Player.Kick", "LoadBoolean": "@roblox/globaltype/Player.LoadBoolean", "loadBoolean": "@roblox/globaltype/Player.loadBoolean", "LoadCharacterAsync": "@roblox/globaltype/Player.LoadCharacterAsync", "LoadCharacter": "@roblox/globaltype/Player.LoadCharacter", "LoadCharacterAppearance": "@roblox/globaltype/Player.LoadCharacterAppearance", "LoadCharacterWithHumanoidDescriptionAsync": "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescriptionAsync", "LoadCharacterWithHumanoidDescription": "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescription", "LoadInstance": "@roblox/globaltype/Player.LoadInstance", "loadInstance": "@roblox/globaltype/Player.loadInstance", "LoadNumber": "@roblox/globaltype/Player.LoadNumber", "loadNumber": "@roblox/globaltype/Player.loadNumber", "LoadString": "@roblox/globaltype/Player.LoadString", "loadString": "@roblox/globaltype/Player.loadString", "Move": "@roblox/globaltype/Player.Move", "RemoveReplicationFocus": "@roblox/globaltype/Player.RemoveReplicationFocus", "RequestStreamAroundAsync": "@roblox/globaltype/Player.RequestStreamAroundAsync", "SaveBoolean": "@roblox/globaltype/Player.SaveBoolean", "saveBoolean": "@roblox/globaltype/Player.saveBoolean", "SaveInstance": "@roblox/globaltype/Player.SaveInstance", "saveInstance": "@roblox/globaltype/Player.saveInstance", "SaveNumber": "@roblox/globaltype/Player.SaveNumber", "saveNumber": "@roblox/globaltype/Player.saveNumber", "SaveString": "@roblox/globaltype/Player.SaveString", "saveString": "@roblox/globaltype/Player.saveString", "SetAccountAge": "@roblox/globaltype/Player.SetAccountAge", "SetSuperSafeChat": "@roblox/globaltype/Player.SetSuperSafeChat", "WaitForDataReady": "@roblox/globaltype/Player.WaitForDataReady", "waitForDataReady": "@roblox/globaltype/Player.waitForDataReady" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player", "code_sample": "" }, "@roblox/globaltype/Player.AccountAge": { "documentation": "Describes the player's account age in days.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#AccountAge", "code_sample": "" }, "@roblox/globaltype/Player.AutoJumpEnabled": { "documentation": "Determines whether the character of a player using a mobile device will automatically jump upon hitting an obstacle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#AutoJumpEnabled", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal button = script.Parent\n\nlocal function update()\n\t-- Update button text\n\tif player.AutoJumpEnabled then\n\t\tbutton.Text = \"Auto-Jump is ON\"\n\telse\n\t\tbutton.Text = \"Auto-Jump is OFF\"\n\tend\n\t-- Reflect the property in the player's character, if they have one\n\tif player.Character then\n\t\tlocal human = player.Character:FindFirstChild(\"Humanoid\")\n\t\tif human then\n\t\t\thuman.AutoJumpEnabled = player.AutoJumpEnabled\n\t\tend\n\tend\nend\n\nlocal function onActivated()\n\t-- Toggle auto-jump\n\tplayer.AutoJumpEnabled = not player.AutoJumpEnabled\n\t-- Update everything else\n\tupdate()\nend\n\nbutton.Activated:Connect(onActivated)\nupdate()" }, "@roblox/globaltype/Player.CameraMaxZoomDistance": { "documentation": "The maximum distance the player's camera is allowed to zoom out.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CameraMaxZoomDistance", "code_sample": "" }, "@roblox/globaltype/Player.CameraMinZoomDistance": { "documentation": "The minimum distance the player's camera is allowed to zoom in.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CameraMinZoomDistance", "code_sample": "" }, "@roblox/globaltype/Player.CameraMode": { "documentation": "Changes the camera's mode to either first or third person.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CameraMode", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.CameraMode = Enum.CameraMode.LockFirstPerson" }, "@roblox/globaltype/Player.CanLoadCharacterAppearance": { "documentation": "Determines whether the character's appearance will be loaded when the player spawns. If false, the player will spawn with a default appearance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CanLoadCharacterAppearance", "code_sample": "" }, "@roblox/globaltype/Player.Character": { "documentation": "A Model controlled by the player that contains a Humanoid, body parts, scripts, and other objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Character", "code_sample": "" }, "@roblox/globaltype/Player.CharacterAppearance": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.
The URL of the asset containing the character's appearance, clothing, and gear.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearance", "code_sample": "" }, "@roblox/globaltype/Player.CharacterAppearanceId": { "documentation": "Determines the user ID of the account whose character appearance is used for a player's Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearanceId", "code_sample": "" }, "@roblox/globaltype/Player.DataComplexity": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
The total amount of data currently being stored in the player's cache on the current place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DataComplexity", "code_sample": "" }, "@roblox/globaltype/Player.DataReady": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Indicates when the player's data is available to load.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DataReady", "code_sample": "" }, "@roblox/globaltype/Player.DevCameraOcclusionMode": { "documentation": "Sets how the default camera handles objects between the camera and the player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DevCameraOcclusionMode", "code_sample": "" }, "@roblox/globaltype/Player.DevComputerCameraMode": { "documentation": "Determines player's camera movement mode when using a device with a mouse and keyboard.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DevComputerCameraMode", "code_sample": "" }, "@roblox/globaltype/Player.DevComputerMovementMode": { "documentation": "Determines player's character movement mode when using a device with a mouse and keyboard.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DevComputerMovementMode", "code_sample": "" }, "@roblox/globaltype/Player.DevEnableMouseLock": { "documentation": "Determines if the player can toggle mouse lock.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DevEnableMouseLock", "code_sample": "" }, "@roblox/globaltype/Player.DevTouchCameraMode": { "documentation": "Determines player's camera movement mode when using a touch-enabled device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DevTouchCameraMode", "code_sample": "" }, "@roblox/globaltype/Player.DevTouchMovementMode": { "documentation": "Determines player's character movement mode when using a touch-enabled device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DevTouchMovementMode", "code_sample": "" }, "@roblox/globaltype/Player.DisplayName": { "documentation": "The display name of the authenticated user associated with the Player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DisplayName", "code_sample": "" }, "@roblox/globaltype/Player.FollowUserId": { "documentation": "Describes the user ID of the player who was followed into an experience by a player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#FollowUserId", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal screenGui = Instance.new(\"ScreenGui\")\nscreenGui.Parent = player:WaitForChild(\"PlayerGui\")\n\nlocal function onPlayerAdded(newPlayer)\n\tif newPlayer.FollowUserId == player.UserId then\n\t\tlocal textLabel = Instance.new(\"TextLabel\")\n\t\ttextLabel.Parent = screenGui\n\t\ttextLabel.Text = \"You were followed to this game by \" .. newPlayer.Name .. \"!\"\n\t\ttask.delay(3, function()\n\t\t\tif textLabel then\n\t\t\t\ttextLabel:Destroy()\n\t\t\tend\n\t\tend)\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.GameplayPaused": { "documentation": "Whether player client-side gameplay is currently paused.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GameplayPaused", "code_sample": "" }, "@roblox/globaltype/Player.HasVerifiedBadge": { "documentation": "Indicates if a player has a Verified badge.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#HasVerifiedBadge", "code_sample": "" }, "@roblox/globaltype/Player.HealthDisplayDistance": { "documentation": "Sets the distance at which this player will see other players' health bars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#HealthDisplayDistance", "code_sample": "" }, "@roblox/globaltype/Player.LocaleId": { "documentation": "This property shows the locale ID that the local player has set for their Roblox account.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LocaleId", "code_sample": "" }, "@roblox/globaltype/Player.MembershipType": { "documentation": "Describes the account's membership type.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#MembershipType", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nif player.MembershipType == Enum.MembershipType.Premium then\n\t-- Take some action specifically for Premium members\nend" }, "@roblox/globaltype/Player.NameDisplayDistance": { "documentation": "Sets the distance at which this player will see other players' names.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#NameDisplayDistance", "code_sample": "" }, "@roblox/globaltype/Player.Neutral": { "documentation": "Determines whether the player is on a specific team.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Neutral", "code_sample": "" }, "@roblox/globaltype/Player.PartyId": { "documentation": "A unique identifier of the party a Player belongs to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#PartyId", "code_sample": "local Players = game:GetService(\"Players\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\tlocal partyId = player.PartyId\n\n\tif partyId ~= \"\" then\n\t\tprint(\"Player is in a party with ID: \" .. partyId)\n\telse\n\t\tprint(\"Player is not in a party\")\n\tend\n\n\tplayer:GetPropertyChangedSignal(\"PartyId\"):Connect(function()\n\t\tif player.PartyId ~= \"\" then\n\t\t\tprint(\"Player joined party with ID: \" .. player.PartyId)\n\t\telse\n\t\t\tprint(\"Player left party\")\n\t\tend\n\tend)\nend)" }, "@roblox/globaltype/Player.ReplicationFocus": { "documentation": "Sets the part to focus replication around.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#ReplicationFocus", "code_sample": "" }, "@roblox/globaltype/Player.RespawnLocation": { "documentation": "If set, the player will respawn at the given SpawnLocation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#RespawnLocation", "code_sample": "" }, "@roblox/globaltype/Player.StepIdOffset": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#StepIdOffset", "code_sample": "" }, "@roblox/globaltype/Player.Team": { "documentation": "Determines the Team with which the player is associated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Team", "code_sample": "" }, "@roblox/globaltype/Player.TeamColor": { "documentation": "Determines the Team with which the player is associated with according to that team's Team.TeamColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#TeamColor", "code_sample": "" }, "@roblox/globaltype/Player.ThirdPartyTextChatRestrictionStatus": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#ThirdPartyTextChatRestrictionStatus", "code_sample": "" }, "@roblox/globaltype/Player.UserId": { "documentation": "A unique identifying integer assigned to all user accounts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#UserId", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tprint(player.UserId)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.userId": { "documentation": "Deprecated: This property is a deprecated variant of Player.UserId which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#userId", "code_sample": "" }, "@roblox/globaltype/Player.AddReplicationFocus/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.AddReplicationFocus/param/1": { "documentation": "The BasePart to use as a new replication focus." }, "@roblox/globaltype/Player.AddReplicationFocus": { "documentation": "Adds an additional replication focus for the player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.AddReplicationFocus/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/Player.AddReplicationFocus/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#AddReplicationFocus", "code_sample": "" }, "@roblox/globaltype/Player.ClearCharacterAppearance/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.ClearCharacterAppearance": { "documentation": "Removes all accessories and other character appearance objects from a player's Character.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.ClearCharacterAppearance/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#ClearCharacterAppearance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal character = player.Character or player.CharacterAdded:Wait()\n\nlocal function onChildRemoved(child)\n\tprint(child.ClassName, \"removed from character\")\nend\n\ncharacter.ChildRemoved:Connect(onChildRemoved)\n\nplayer:ClearCharacterAppearance()\n--> BodyColors removed from character\n--> ShirtGraphic removed from character\n--> Shirt removed from character\n--> Pants removed from character\n--> CharacterMesh removed from character\n--> Hat removed from character\n--> Shirt removed from character" }, "@roblox/globaltype/Player.DistanceFromCharacter/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.DistanceFromCharacter/param/1": { "documentation": "The location from which player's distance to is being measured." }, "@roblox/globaltype/Player.DistanceFromCharacter/return/0": { "documentation": "The distance in studs between the player and the location." }, "@roblox/globaltype/Player.DistanceFromCharacter": { "documentation": "Returns the distance between the character's head and the given Vector3, or 0 if the player has no character.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.DistanceFromCharacter/param/0" }, { "name": "point", "documentation": "@roblox/globaltype/Player.DistanceFromCharacter/param/1" } ], "returns": [ "@roblox/globaltype/Player.DistanceFromCharacter/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#DistanceFromCharacter", "code_sample": "local Players = game:GetService(\"Players\")\n\nfor _, player in pairs(Players:GetPlayers()) do\n\tprint(player:DistanceFromCharacter(Vector3.new(0, 0, 0)))\nend" }, "@roblox/globaltype/Player.GetFriendsOnlineAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetFriendsOnlineAsync/param/1": { "documentation": "The maximum number of online connections to return." }, "@roblox/globaltype/Player.GetFriendsOnlineAsync/return/0": { "documentation": "A dictionary of online connections (see the table above)." }, "@roblox/globaltype/Player.GetFriendsOnlineAsync": { "documentation": "Returns a dictionary of online connections.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetFriendsOnlineAsync/param/0" }, { "name": "maxFriends", "documentation": "@roblox/globaltype/Player.GetFriendsOnlineAsync/param/1" } ], "returns": [ "@roblox/globaltype/Player.GetFriendsOnlineAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnlineAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal success, result = pcall(player.GetFriendsOnlineAsync, player, 10)\n\nif success then\n\tfor _, friend in pairs(result) do\n\t\tprint(friend.UserName)\n\tend\nelse\n\twarn(\"Failed to get online players: \" .. result)\nend" }, "@roblox/globaltype/Player.GetFriendsOnline/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetFriendsOnline/param/1": { "documentation": "The maximum number of online connections to return." }, "@roblox/globaltype/Player.GetFriendsOnline/return/0": { "documentation": "A dictionary of online connections (see the table above)." }, "@roblox/globaltype/Player.GetFriendsOnline": { "documentation": "Deprecated: This method has been superseded by GetFriendsOnline().
Returns a dictionary of online connections. Returns the product information of an asset using its asset ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetFriendsOnline/param/0" }, { "name": "maxFriends", "documentation": "@roblox/globaltype/Player.GetFriendsOnline/param/1" } ], "returns": [ "@roblox/globaltype/Player.GetFriendsOnline/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal success, result = pcall(player.GetFriendsOnlineAsync, player, 10)\n\nif success then\n\tfor _, friend in pairs(result) do\n\t\tprint(friend.UserName)\n\tend\nelse\n\twarn(\"Failed to get online players: \" .. result)\nend" }, "@roblox/globaltype/Player.GetJoinData/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetJoinData/return/0": { "documentation": "A dictionary containing PlaceId and UserId values (see table in description)." }, "@roblox/globaltype/Player.GetJoinData": { "documentation": "Returns a dictionary containing information describing how the player joins the experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetJoinData/param/0" } ], "returns": [ "@roblox/globaltype/Player.GetJoinData/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetJoinData", "code_sample": "" }, "@roblox/globaltype/Player.GetMouse/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetMouse/return/0": { "documentation": "" }, "@roblox/globaltype/Player.GetMouse": { "documentation": "Returns the mouse being used by the client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetMouse/param/0" } ], "returns": [ "@roblox/globaltype/Player.GetMouse/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetMouse", "code_sample": "" }, "@roblox/globaltype/Player.GetNetworkPing/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetNetworkPing/return/0": { "documentation": "" }, "@roblox/globaltype/Player.GetNetworkPing": { "documentation": "Returns the round-trip, isolated network latency in seconds.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetNetworkPing/param/0" } ], "returns": [ "@roblox/globaltype/Player.GetNetworkPing/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetNetworkPing", "code_sample": "" }, "@roblox/globaltype/Player.GetRankInGroupAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetRankInGroupAsync/param/1": { "documentation": "The groupId of the specified group." }, "@roblox/globaltype/Player.GetRankInGroupAsync/return/0": { "documentation": "The player's rank in the group." }, "@roblox/globaltype/Player.GetRankInGroupAsync": { "documentation": "Returns the player's rank in the group as an integer.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetRankInGroupAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/Player.GetRankInGroupAsync/param/1" } ], "returns": [ "@roblox/globaltype/Player.GetRankInGroupAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroupAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tif player:GetRankInGroupAsync(2) == 255 then\n\t\tprint(\"Player is the owner of the group, 'LOL'!\")\n\telse\n\t\tprint(\"Player is NOT the owner of the group, 'LOL'!\")\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.GetRankInGroup/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetRankInGroup/param/1": { "documentation": "The groupId of the specified group." }, "@roblox/globaltype/Player.GetRankInGroup/return/0": { "documentation": "The player's rank in the group." }, "@roblox/globaltype/Player.GetRankInGroup": { "documentation": "Deprecated:
Returns the player's rank in the group as an integer.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetRankInGroup/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/Player.GetRankInGroup/param/1" } ], "returns": [ "@roblox/globaltype/Player.GetRankInGroup/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroup", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tif player:GetRankInGroupAsync(2) == 255 then\n\t\tprint(\"Player is the owner of the group, 'LOL'!\")\n\telse\n\t\tprint(\"Player is NOT the owner of the group, 'LOL'!\")\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.GetRoleInGroupAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetRoleInGroupAsync/param/1": { "documentation": "The group ID of the specified group." }, "@roblox/globaltype/Player.GetRoleInGroupAsync/return/0": { "documentation": "The player's role in the specified group, or Guest if the player is not a member." }, "@roblox/globaltype/Player.GetRoleInGroupAsync": { "documentation": "Returns the player's role in the group as a string, or Guest if the player isn't part of the group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetRoleInGroupAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/Player.GetRoleInGroupAsync/param/1" } ], "returns": [ "@roblox/globaltype/Player.GetRoleInGroupAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroupAsync", "code_sample": "" }, "@roblox/globaltype/Player.GetRoleInGroup/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.GetRoleInGroup/param/1": { "documentation": "The group ID of the specified group." }, "@roblox/globaltype/Player.GetRoleInGroup/return/0": { "documentation": "The player's role in the specified group, or Guest if the player is not a member." }, "@roblox/globaltype/Player.GetRoleInGroup": { "documentation": "Deprecated: This method has been superseded by GetRoleInGroup().
Returns the player's role in the group as a string, or Guest if the player isn't part of the group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.GetRoleInGroup/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/Player.GetRoleInGroup/param/1" } ], "returns": [ "@roblox/globaltype/Player.GetRoleInGroup/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroup", "code_sample": "" }, "@roblox/globaltype/Player.HasAppearanceLoaded/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.HasAppearanceLoaded/return/0": { "documentation": "A boolean indicating whether or not the appearance of the player's character has loaded." }, "@roblox/globaltype/Player.HasAppearanceLoaded": { "documentation": "Returns whether or not the appearance of the player's character has loaded.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.HasAppearanceLoaded/param/0" } ], "returns": [ "@roblox/globaltype/Player.HasAppearanceLoaded/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#HasAppearanceLoaded", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tlocal loaded = player:HasAppearanceLoaded()\n\tprint(loaded)\n\n\twhile not loaded do\n\t\tloaded = player:HasAppearanceLoaded()\n\t\tprint(loaded)\n\t\ttask.wait()\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.IsBestFriendsWith/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.IsBestFriendsWith/param/1": { "documentation": "" }, "@roblox/globaltype/Player.IsBestFriendsWith/return/0": { "documentation": "" }, "@roblox/globaltype/Player.IsBestFriendsWith": { "documentation": "Deprecated: This function is obsolete because the \"best friends\" feature was removed. Use Player:IsFriendsWithAsync() instead.
Returns whether a player is connections with the specified user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.IsBestFriendsWith/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Player.IsBestFriendsWith/param/1" } ], "returns": [ "@roblox/globaltype/Player.IsBestFriendsWith/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#IsBestFriendsWith", "code_sample": "" }, "@roblox/globaltype/Player.IsFriendsWithAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.IsFriendsWithAsync/param/1": { "documentation": "The Player.UserId of the specified player." }, "@roblox/globaltype/Player.IsFriendsWithAsync/return/0": { "documentation": "A boolean indicating whether a player is a connection of the specified user." }, "@roblox/globaltype/Player.IsFriendsWithAsync": { "documentation": "Checks whether a player is a connection of the user with the given Player.UserId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.IsFriendsWithAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Player.IsFriendsWithAsync/param/1" } ], "returns": [ "@roblox/globaltype/Player.IsFriendsWithAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWithAsync", "code_sample": "" }, "@roblox/globaltype/Player.IsFriendsWith/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.IsFriendsWith/param/1": { "documentation": "The Player.UserId of the specified player." }, "@roblox/globaltype/Player.IsFriendsWith/return/0": { "documentation": "A boolean indicating whether a player is a connection of the specified user." }, "@roblox/globaltype/Player.IsFriendsWith": { "documentation": "Deprecated: This method has been superseded by the Player:IsFriendsWithAsync() method which should be used for new work.
Checks whether a player is a connection of the user with the given Player.UserId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.IsFriendsWith/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Player.IsFriendsWith/param/1" } ], "returns": [ "@roblox/globaltype/Player.IsFriendsWith/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith", "code_sample": "" }, "@roblox/globaltype/Player.isFriendsWith/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.isFriendsWith/param/1": { "documentation": "" }, "@roblox/globaltype/Player.isFriendsWith/return/0": { "documentation": "" }, "@roblox/globaltype/Player.isFriendsWith": { "documentation": "Deprecated: This method has been superseded by the Player:IsFriendsWithAsync() method which should be used for new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.isFriendsWith/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Player.isFriendsWith/param/1" } ], "returns": [ "@roblox/globaltype/Player.isFriendsWith/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#isFriendsWith", "code_sample": "" }, "@roblox/globaltype/Player.IsInGroupAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.IsInGroupAsync/param/1": { "documentation": "The group ID of the specified group." }, "@roblox/globaltype/Player.IsInGroupAsync/return/0": { "documentation": "A boolean indicating whether the player is in the specified group." }, "@roblox/globaltype/Player.IsInGroupAsync": { "documentation": "Checks whether a player is a member of a group with the given ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.IsInGroupAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/Player.IsInGroupAsync/param/1" } ], "returns": [ "@roblox/globaltype/Player.IsInGroupAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroupAsync", "code_sample": "" }, "@roblox/globaltype/Player.IsInGroup/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.IsInGroup/param/1": { "documentation": "The group ID of the specified group." }, "@roblox/globaltype/Player.IsInGroup/return/0": { "documentation": "A boolean indicating whether the player is in the specified group." }, "@roblox/globaltype/Player.IsInGroup": { "documentation": "Deprecated: This method has been superseded by IsInGroupAsync().
Checks whether a player is a member of a group with the given ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.IsInGroup/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/Player.IsInGroup/param/1" } ], "returns": [ "@roblox/globaltype/Player.IsInGroup/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroup", "code_sample": "" }, "@roblox/globaltype/Player.IsVerified/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.IsVerified/return/0": { "documentation": "A boolean indicating whether the player is verified." }, "@roblox/globaltype/Player.IsVerified": { "documentation": "Returns whether the player is verified with concrete, real-world signals.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.IsVerified/param/0" } ], "returns": [ "@roblox/globaltype/Player.IsVerified/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#IsVerified", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tprint(player:IsVerified())\nend\n\nfor _, player in pairs(Players:GetPlayers()) do\n\tonPlayerAdded(player)\nend\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.Kick/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.Kick/param/1": { "documentation": "The message to show the user upon kicking." }, "@roblox/globaltype/Player.Kick": { "documentation": "Forcibly disconnect a player from the experience, optionally providing a message.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Kick/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/Player.Kick/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Kick", "code_sample": "" }, "@roblox/globaltype/Player.LoadBoolean/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadBoolean/param/1": { "documentation": "" }, "@roblox/globaltype/Player.LoadBoolean/return/0": { "documentation": "" }, "@roblox/globaltype/Player.LoadBoolean": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Returns a boolean value that was previously saved to the player with Player:SaveBoolean() with the same key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadBoolean/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.LoadBoolean/param/1" } ], "returns": [ "@roblox/globaltype/Player.LoadBoolean/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadBoolean", "code_sample": "" }, "@roblox/globaltype/Player.loadBoolean/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.loadBoolean/param/1": { "documentation": "" }, "@roblox/globaltype/Player.loadBoolean/return/0": { "documentation": "" }, "@roblox/globaltype/Player.loadBoolean": { "documentation": "Deprecated: This deprecated function is a variant of Player:LoadBoolean() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.loadBoolean/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.loadBoolean/param/1" } ], "returns": [ "@roblox/globaltype/Player.loadBoolean/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#loadBoolean", "code_sample": "" }, "@roblox/globaltype/Player.LoadCharacterAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadCharacterAsync": { "documentation": "Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadCharacterAsync/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal RESPAWN_DELAY = 5\n\nPlayers.CharacterAutoLoads = false\n\nlocal function onPlayerAdded(player)\n\tlocal function onCharacterAdded(character)\n\t\tlocal humanoid = character:WaitForChild(\"Humanoid\")\n\n\t\tlocal function onDied()\n\t\t\ttask.wait(RESPAWN_DELAY)\n\t\t\tplayer:LoadCharacterAsync()\n\t\tend\n\n\t\thumanoid.Died:Connect(onDied)\n\tend\n\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\n\n\tplayer:LoadCharacterAsync()\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.LoadCharacter/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadCharacter": { "documentation": "Deprecated: This method has been superseded by LoadCharacterAsync().
Creates a new character for the player, removing the old one. Also clears the player's Backpack and PlayerGui.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadCharacter/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal RESPAWN_DELAY = 5\n\nPlayers.CharacterAutoLoads = false\n\nlocal function onPlayerAdded(player)\n\tlocal function onCharacterAdded(character)\n\t\tlocal humanoid = character:WaitForChild(\"Humanoid\")\n\n\t\tlocal function onDied()\n\t\t\ttask.wait(RESPAWN_DELAY)\n\t\t\tplayer:LoadCharacterAsync()\n\t\tend\n\n\t\thumanoid.Died:Connect(onDied)\n\tend\n\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\n\n\tplayer:LoadCharacterAsync()\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.LoadCharacterAppearance/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadCharacterAppearance/param/1": { "documentation": "An instance of the asset being loaded, which can be obtained using the InsertService:LoadAsset() function." }, "@roblox/globaltype/Player.LoadCharacterAppearance": { "documentation": "Deprecated:
Places the given instance either in the player's character, head, or StarterGear based on the instance's class.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadCharacterAppearance/param/0" }, { "name": "assetInstance", "documentation": "@roblox/globaltype/Player.LoadCharacterAppearance/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAppearance", "code_sample": "local Players = game:GetService(\"Players\")\nlocal InsertService = game:GetService(\"InsertService\")\n\nlocal function onPlayerAdded(player)\n\tlocal function onChatted(message)\n\t\tlocal assetId = message:match(\"id=(%d+)\")\n\t\tif assetId then\n\t\t\tlocal model = InsertService:LoadAsset(assetId)\n\t\t\tfor _, child in pairs(model:GetChildren()) do\n\t\t\t\tplayer:LoadCharacterAppearance(child)\n\t\t\tend\n\t\tend\n\tend\n\n\tplayer.Chatted:Connect(onChatted)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescriptionAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescriptionAsync/param/1": { "documentation": "A HumanoidDescription containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character." }, "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescriptionAsync": { "documentation": "Spawns a player character with everything equipped in the passed in HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescriptionAsync/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescriptionAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescriptionAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\nPlayers.CharacterAutoLoads = false\n\nlocal function onPlayerAdded(player)\n\tlocal humanoidDescription = Instance.new(\"HumanoidDescription\")\n\thumanoidDescription.HatAccessory = \"2551510151,2535600138\"\n\thumanoidDescription.BodyTypeScale = 0.1\n\thumanoidDescription.ClimbAnimation = 619521311\n\thumanoidDescription.Face = 86487700\n\thumanoidDescription.GraphicTShirt = 1711661\n\thumanoidDescription.HeadColor = Color3.new(0, 1, 0)\n\tplayer:LoadCharacterWithHumanoidDescriptionAsync(humanoidDescription)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescription/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescription/param/1": { "documentation": "A HumanoidDescription containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character." }, "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescription": { "documentation": "Deprecated: This method has been superseded by LoadCharacterWithHumanoidDescriptionAsync().
Spawns a player character with everything equipped in the passed in HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescription/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/Player.LoadCharacterWithHumanoidDescription/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescription", "code_sample": "local Players = game:GetService(\"Players\")\n\nPlayers.CharacterAutoLoads = false\n\nlocal function onPlayerAdded(player)\n\tlocal humanoidDescription = Instance.new(\"HumanoidDescription\")\n\thumanoidDescription.HatAccessory = \"2551510151,2535600138\"\n\thumanoidDescription.BodyTypeScale = 0.1\n\thumanoidDescription.ClimbAnimation = 619521311\n\thumanoidDescription.Face = 86487700\n\thumanoidDescription.GraphicTShirt = 1711661\n\thumanoidDescription.HeadColor = Color3.new(0, 1, 0)\n\tplayer:LoadCharacterWithHumanoidDescriptionAsync(humanoidDescription)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.LoadInstance/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadInstance/param/1": { "documentation": "" }, "@roblox/globaltype/Player.LoadInstance/return/0": { "documentation": "" }, "@roblox/globaltype/Player.LoadInstance": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Returns an instance that was previously saved to the player with Player:SaveInstance() with the same key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadInstance/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.LoadInstance/param/1" } ], "returns": [ "@roblox/globaltype/Player.LoadInstance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadInstance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tif player:WaitForDataReady() then\n\t\tlocal model = player:LoadInstance(\"Model\")\n\t\tmodel.Parent = workspace\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.loadInstance/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.loadInstance/param/1": { "documentation": "" }, "@roblox/globaltype/Player.loadInstance/return/0": { "documentation": "" }, "@roblox/globaltype/Player.loadInstance": { "documentation": "Deprecated: This deprecated function is a variant of Player:LoadInstance() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.loadInstance/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.loadInstance/param/1" } ], "returns": [ "@roblox/globaltype/Player.loadInstance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#loadInstance", "code_sample": "" }, "@roblox/globaltype/Player.LoadNumber/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadNumber/param/1": { "documentation": "" }, "@roblox/globaltype/Player.LoadNumber/return/0": { "documentation": "" }, "@roblox/globaltype/Player.LoadNumber": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Returns a number value that was previously saved to the player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadNumber/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.LoadNumber/param/1" } ], "returns": [ "@roblox/globaltype/Player.LoadNumber/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadNumber", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tif player:WaitForDataReady() then\n\t\tprint(player:LoadNumber(\"TotalPlays\"))\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.loadNumber/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.loadNumber/param/1": { "documentation": "" }, "@roblox/globaltype/Player.loadNumber/return/0": { "documentation": "" }, "@roblox/globaltype/Player.loadNumber": { "documentation": "Deprecated: This deprecated function is a variant of Player:LoadNumber() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.loadNumber/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.loadNumber/param/1" } ], "returns": [ "@roblox/globaltype/Player.loadNumber/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#loadNumber", "code_sample": "" }, "@roblox/globaltype/Player.LoadString/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.LoadString/param/1": { "documentation": "" }, "@roblox/globaltype/Player.LoadString/return/0": { "documentation": "" }, "@roblox/globaltype/Player.LoadString": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Returns a string value that was previously saved to the player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.LoadString/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.LoadString/param/1" } ], "returns": [ "@roblox/globaltype/Player.LoadString/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#LoadString", "code_sample": "game.Players.PlayerAdded:Connect(function(Player)\n\tif Player:WaitForDataReady() then\n\t\tprint(Player:LoadString(\"TheirName\"))\n\tend\nend)" }, "@roblox/globaltype/Player.loadString/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.loadString/param/1": { "documentation": "" }, "@roblox/globaltype/Player.loadString/return/0": { "documentation": "" }, "@roblox/globaltype/Player.loadString": { "documentation": "Deprecated: This function is a deprecated variant of Player:LoadString() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.loadString/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.loadString/param/1" } ], "returns": [ "@roblox/globaltype/Player.loadString/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#loadString", "code_sample": "" }, "@roblox/globaltype/Player.Move/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.Move/param/1": { "documentation": "The Vector3 direction that the player should move." }, "@roblox/globaltype/Player.Move/param/2": { "documentation": "A boolean indicating whether the player should move relative to the player's camera." }, "@roblox/globaltype/Player.Move": { "documentation": "Causes the player's character to walk in the given direction until stopped, or interrupted by the player (by using their controls).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Move/param/0" }, { "name": "walkDirection", "documentation": "@roblox/globaltype/Player.Move/param/1" }, { "name": "relativeToCamera", "documentation": "@roblox/globaltype/Player.Move/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Move", "code_sample": "" }, "@roblox/globaltype/Player.RemoveReplicationFocus/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.RemoveReplicationFocus/param/1": { "documentation": "The BasePart to remove as a replication focus." }, "@roblox/globaltype/Player.RemoveReplicationFocus": { "documentation": "Removes a previously added replication focus.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.RemoveReplicationFocus/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/Player.RemoveReplicationFocus/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#RemoveReplicationFocus", "code_sample": "" }, "@roblox/globaltype/Player.RequestStreamAroundAsync/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.RequestStreamAroundAsync/param/1": { "documentation": "World location where streaming is requested." }, "@roblox/globaltype/Player.RequestStreamAroundAsync/param/2": { "documentation": "Optional timeout for the request, the maximum duration that the engine attempts to stream regions around the position parameter before abandoning the request. If you don't specify a value, the timeout is effectively infinite. However, if the client is low on memory, the engine abandons all streaming requests, even those that are still within the timeout duration." }, "@roblox/globaltype/Player.RequestStreamAroundAsync": { "documentation": "Requests that the server stream to the player around the specified location.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.RequestStreamAroundAsync/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/Player.RequestStreamAroundAsync/param/1" }, { "name": "timeOut", "documentation": "@roblox/globaltype/Player.RequestStreamAroundAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#RequestStreamAroundAsync", "code_sample": "" }, "@roblox/globaltype/Player.SaveBoolean/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.SaveBoolean/param/1": { "documentation": "" }, "@roblox/globaltype/Player.SaveBoolean/param/2": { "documentation": "" }, "@roblox/globaltype/Player.SaveBoolean": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Used to save a boolean value that can be loaded again at a later time using Player:LoadBoolean().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.SaveBoolean/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.SaveBoolean/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.SaveBoolean/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#SaveBoolean", "code_sample": "game.Players.PlayerAdded:Connect(function(Player)\n\tif Player:WaitForDataReady() then\n\t\tPlayer:SaveBoolean(\"HasPlayed\", true)\n\tend\nend)" }, "@roblox/globaltype/Player.saveBoolean/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.saveBoolean/param/1": { "documentation": "" }, "@roblox/globaltype/Player.saveBoolean/param/2": { "documentation": "" }, "@roblox/globaltype/Player.saveBoolean": { "documentation": "Deprecated: This function is a deprecated variant of Player:SaveBoolean() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.saveBoolean/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.saveBoolean/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.saveBoolean/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#saveBoolean", "code_sample": "" }, "@roblox/globaltype/Player.SaveInstance/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.SaveInstance/param/1": { "documentation": "" }, "@roblox/globaltype/Player.SaveInstance/param/2": { "documentation": "" }, "@roblox/globaltype/Player.SaveInstance": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Saves an instance which can be loaded again at a later time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.SaveInstance/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.SaveInstance/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.SaveInstance/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#SaveInstance", "code_sample": "game.Players.PlayerAdded:Connect(function(Player)\n\tPlayer:WaitForDataReady()\n\tPlayer:SaveInstance(\"Model\", game.Workspace.Model)\nend)" }, "@roblox/globaltype/Player.saveInstance/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.saveInstance/param/1": { "documentation": "" }, "@roblox/globaltype/Player.saveInstance/param/2": { "documentation": "" }, "@roblox/globaltype/Player.saveInstance": { "documentation": "Deprecated: This function is a deprecated variant of Player:SaveInstance() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.saveInstance/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.saveInstance/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.saveInstance/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#saveInstance", "code_sample": "" }, "@roblox/globaltype/Player.SaveNumber/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.SaveNumber/param/1": { "documentation": "" }, "@roblox/globaltype/Player.SaveNumber/param/2": { "documentation": "" }, "@roblox/globaltype/Player.SaveNumber": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Saves a number value that can be loaded again at a later time using.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.SaveNumber/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.SaveNumber/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.SaveNumber/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#SaveNumber", "code_sample": "game.Players.PlayerAdded:Connect(function(Player)\n\tif Player:WaitForDataReady() then\n\t\tlocal OldValue = Player:SaveNumber(\"TotalPlays\")\n\t\tPlayer:SaveNumber(\"TotalPlays\", OldValue + 1)\n\tend\nend)" }, "@roblox/globaltype/Player.saveNumber/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.saveNumber/param/1": { "documentation": "" }, "@roblox/globaltype/Player.saveNumber/param/2": { "documentation": "" }, "@roblox/globaltype/Player.saveNumber": { "documentation": "Deprecated: This function is a deprecated variant of Player:SaveNumber() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.saveNumber/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.saveNumber/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.saveNumber/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#saveNumber", "code_sample": "" }, "@roblox/globaltype/Player.SaveString/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.SaveString/param/1": { "documentation": "" }, "@roblox/globaltype/Player.SaveString/param/2": { "documentation": "" }, "@roblox/globaltype/Player.SaveString": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Saves a string value that can be loaded again at a later time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.SaveString/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.SaveString/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.SaveString/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#SaveString", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tif player:WaitForDataReady() then\n\t\tplayer:SaveString(\"TheirName\", player.Name)\n\tend\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.saveString/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.saveString/param/1": { "documentation": "" }, "@roblox/globaltype/Player.saveString/param/2": { "documentation": "" }, "@roblox/globaltype/Player.saveString": { "documentation": "Deprecated: This function is a deprecated variant of Player:SaveString() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.saveString/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/Player.saveString/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Player.saveString/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#saveString", "code_sample": "" }, "@roblox/globaltype/Player.SetAccountAge/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.SetAccountAge/param/1": { "documentation": "The age of the account in days." }, "@roblox/globaltype/Player.SetAccountAge": { "documentation": "Sets the AccountAge of the player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.SetAccountAge/param/0" }, { "name": "accountAge", "documentation": "@roblox/globaltype/Player.SetAccountAge/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#SetAccountAge", "code_sample": "" }, "@roblox/globaltype/Player.SetSuperSafeChat/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.SetSuperSafeChat/param/1": { "documentation": "A boolean indicating whether or not the player sees filtered chat." }, "@roblox/globaltype/Player.SetSuperSafeChat": { "documentation": "Sets whether or not the player sees filtered chats, rather than normal chats.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.SetSuperSafeChat/param/0" }, { "name": "value", "documentation": "@roblox/globaltype/Player.SetSuperSafeChat/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#SetSuperSafeChat", "code_sample": "" }, "@roblox/globaltype/Player.WaitForDataReady/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.WaitForDataReady/return/0": { "documentation": "" }, "@roblox/globaltype/Player.WaitForDataReady": { "documentation": "Deprecated: This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using DataStoreService for new work.
Used to pause the script until the player's data is available to manipulate, or until a certain amount of time has elapsed without fetching the player's data.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.WaitForDataReady/param/0" } ], "returns": [ "@roblox/globaltype/Player.WaitForDataReady/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#WaitForDataReady", "code_sample": "" }, "@roblox/globaltype/Player.waitForDataReady/param/0": { "documentation": "An object that represents a presently connected client to the experience." }, "@roblox/globaltype/Player.waitForDataReady/return/0": { "documentation": "" }, "@roblox/globaltype/Player.waitForDataReady": { "documentation": "Deprecated: This function is a deprecated variant of Player:WaitForDataReady() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.waitForDataReady/param/0" } ], "returns": [ "@roblox/globaltype/Player.waitForDataReady/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#waitForDataReady", "code_sample": "" }, "@roblox/globaltype/Player.CharacterAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAdded": { "documentation": "Fires when a player's character spawns or respawns.", "keys": { "Connect": "@roblox/globaltype/Player.CharacterAdded.Connect", "ConnectParallel": "@roblox/globaltype/Player.CharacterAdded.ConnectParallel", "Once": "@roblox/globaltype/Player.CharacterAdded.Once", "Wait": "@roblox/globaltype/Player.CharacterAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAdded", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterAdded(character)\n\tprint(character.Name .. \" has spawned\")\nend\n\nlocal function onCharacterRemoving(character)\n\tprint(character.Name .. \" is despawning\")\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\n\tplayer.CharacterRemoving:Connect(onCharacterRemoving)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterAppearanceLoaded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterAppearanceLoaded": { "documentation": "Fires when the full appearance of a Character has been inserted.", "keys": { "Connect": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Connect", "ConnectParallel": "@roblox/globaltype/Player.CharacterAppearanceLoaded.ConnectParallel", "Once": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Once", "Wait": "@roblox/globaltype/Player.CharacterAppearanceLoaded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CharacterAppearanceLoaded", "code_sample": "" }, "@roblox/globaltype/Player.CharacterRemoving.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterRemoving.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterRemoving.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterRemoving.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterRemoving.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterRemoving.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterRemoving.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterRemoving.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterRemoving.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterRemoving.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterRemoving.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterRemoving.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Player.CharacterRemoving.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterRemoving.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.CharacterRemoving.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterRemoving.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.CharacterRemoving.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.CharacterRemoving.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Player.CharacterRemoving": { "documentation": "Fires right before a player's character is removed.", "keys": { "Connect": "@roblox/globaltype/Player.CharacterRemoving.Connect", "ConnectParallel": "@roblox/globaltype/Player.CharacterRemoving.ConnectParallel", "Once": "@roblox/globaltype/Player.CharacterRemoving.Once", "Wait": "@roblox/globaltype/Player.CharacterRemoving.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#CharacterRemoving", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterAdded(character)\n\tprint(character.Name .. \" has spawned\")\nend\n\nlocal function onCharacterRemoving(character)\n\tprint(character.Name .. \" is despawning\")\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\n\tplayer.CharacterRemoving:Connect(onCharacterRemoving)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Player.Chatted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Chatted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Player.Chatted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Chatted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.Chatted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.Chatted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Chatted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Player.Chatted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Chatted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.Chatted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.Chatted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Chatted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Player.Chatted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Chatted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.Chatted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.Chatted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Chatted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Chatted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Player.Chatted": { "documentation": "Fires when a player chats in experience using Roblox's provided chat bar.", "keys": { "Connect": "@roblox/globaltype/Player.Chatted.Connect", "ConnectParallel": "@roblox/globaltype/Player.Chatted.ConnectParallel", "Once": "@roblox/globaltype/Player.Chatted.Once", "Wait": "@roblox/globaltype/Player.Chatted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Chatted", "code_sample": "" }, "@roblox/globaltype/Player.Idled.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Idled.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Player.Idled.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Idled.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.Idled.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.Idled.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Idled.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Player.Idled.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Idled.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.Idled.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.Idled.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Idled.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Player.Idled.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Idled.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.Idled.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.Idled.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.Idled.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.Idled.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Player.Idled": { "documentation": "This event fires approximately two minutes after the engine classifies the player as idle. Time is the number of seconds that have elapsed since that point.", "keys": { "Connect": "@roblox/globaltype/Player.Idled.Connect", "ConnectParallel": "@roblox/globaltype/Player.Idled.ConnectParallel", "Once": "@roblox/globaltype/Player.Idled.Once", "Wait": "@roblox/globaltype/Player.Idled.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#Idled", "code_sample": "" }, "@roblox/globaltype/Player.OnTeleport.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.OnTeleport.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Player.OnTeleport.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.OnTeleport.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.OnTeleport.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.OnTeleport.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.OnTeleport.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Player.OnTeleport.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.OnTeleport.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.OnTeleport.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.OnTeleport.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.OnTeleport.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Player.OnTeleport.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.OnTeleport.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Player.OnTeleport.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Player.OnTeleport.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Player.OnTeleport.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Player.OnTeleport.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Player.OnTeleport": { "documentation": "Fires when the teleport state of a player changes.", "keys": { "Connect": "@roblox/globaltype/Player.OnTeleport.Connect", "ConnectParallel": "@roblox/globaltype/Player.OnTeleport.ConnectParallel", "Once": "@roblox/globaltype/Player.OnTeleport.Once", "Wait": "@roblox/globaltype/Player.OnTeleport.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Player#OnTeleport", "code_sample": "local Players = game:GetService(\"Players\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\tlocal playerOnTeleport = player\n\tplayer.OnTeleport:Connect(function(teleportState, _placeId, _spawnName)\n\t\tif teleportState == Enum.TeleportState.Started then\n\t\t\tprint(\"Teleport started (\" .. playerOnTeleport.Name .. \")\")\n\t\telseif teleportState == Enum.TeleportState.WaitingForServer then\n\t\t\tprint(\"Teleport waiting for server (\" .. playerOnTeleport.Name .. \")\")\n\t\telseif teleportState == Enum.TeleportState.InProgress then\n\t\t\tprint(\"Teleport in progress (\" .. playerOnTeleport.Name .. \")\")\n\t\telseif teleportState == Enum.TeleportState.Failed then\n\t\t\tprint(\"Teleport failed! (\" .. playerOnTeleport.Name .. \")\")\n\t\tend\n\tend)\nend)" }, "@roblox/globaltype/StyleSheet": { "documentation": "Aggregates StyleRules and can be linked to DataModel trees to apply style properties to instances.", "keys": { "GetDerives": "@roblox/globaltype/StyleSheet.GetDerives", "SetDerives": "@roblox/globaltype/StyleSheet.SetDerives" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleSheet", "code_sample": "" }, "@roblox/globaltype/StyleSheet.GetDerives/param/0": { "documentation": "Aggregates StyleRules and can be linked to DataModel trees to apply style properties to instances." }, "@roblox/globaltype/StyleSheet.GetDerives/return/0": { "documentation": "Array of other StyleSheets." }, "@roblox/globaltype/StyleSheet.GetDerives": { "documentation": "Returns an array of other StyleSheets from which the StyleSheet is deriving StyleRules and token definitions.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleSheet.GetDerives/param/0" } ], "returns": [ "@roblox/globaltype/StyleSheet.GetDerives/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleSheet#GetDerives", "code_sample": "" }, "@roblox/globaltype/StyleSheet.SetDerives/param/0": { "documentation": "Aggregates StyleRules and can be linked to DataModel trees to apply style properties to instances." }, "@roblox/globaltype/StyleSheet.SetDerives/param/1": { "documentation": "Array of other StyleSheets to derive StyleRules and token definitions from." }, "@roblox/globaltype/StyleSheet.SetDerives": { "documentation": "Sets the StyleSheet to derive StyleRules and token definitions from one or more other StyleSheets.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleSheet.SetDerives/param/0" }, { "name": "derives", "documentation": "@roblox/globaltype/StyleSheet.SetDerives/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleSheet#SetDerives", "code_sample": "" }, "@roblox/globaltype/BindableFunction": { "documentation": "An object which allows for synchronous two-way communication between scripts on the same side of the client-server boundary. Scripts invoking a BindableFunction yield until the corresponding callback is found.", "keys": { "Invoke": "@roblox/globaltype/BindableFunction.Invoke", "OnInvoke": "@roblox/globaltype/BindableFunction.OnInvoke" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BindableFunction", "code_sample": "" }, "@roblox/globaltype/BindableFunction.Invoke/param/0": { "documentation": "An object which allows for synchronous two-way communication between scripts on the same side of the client-server boundary. Scripts invoking a BindableFunction yield until the corresponding callback is found." }, "@roblox/globaltype/BindableFunction.Invoke/param/1": { "documentation": "Values to pass to the OnInvoke callback." }, "@roblox/globaltype/BindableFunction.Invoke/return/0": { "documentation": "Values returned from the OnInvoke callback." }, "@roblox/globaltype/BindableFunction.Invoke": { "documentation": "Invokes the BindableFunction which in turn calls the OnInvoke callback, returning any values returned by the callback.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BindableFunction.Invoke/param/0" }, { "name": "arguments", "documentation": "@roblox/globaltype/BindableFunction.Invoke/param/1" } ], "returns": [ "@roblox/globaltype/BindableFunction.Invoke/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BindableFunction#Invoke", "code_sample": "" }, "@roblox/globaltype/BindableFunction.OnInvoke/param/0": { "documentation": "The parameters sent through Invoke()." }, "@roblox/globaltype/BindableFunction.OnInvoke/return/0": { "documentation": "Values returned by the callback function." }, "@roblox/globaltype/BindableFunction.OnInvoke": { "documentation": "Callback for when the BindableFunction is invoked with Invoke().", "params": [ { "name": "arguments", "documentation": "@roblox/globaltype/BindableFunction.OnInvoke/param/0" } ], "returns": [ "@roblox/globaltype/BindableFunction.OnInvoke/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BindableFunction#OnInvoke", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService": { "documentation": "Allows developers to interact with ProximityPrompt objects in a global way.", "keys": { "Enabled": "@roblox/globaltype/ProximityPromptService.Enabled", "MaxIndicatorsVisible": "@roblox/globaltype/ProximityPromptService.MaxIndicatorsVisible", "MaxPromptsVisible": "@roblox/globaltype/ProximityPromptService.MaxPromptsVisible" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.Enabled": { "documentation": "Whether ProximityPrompts are enabled, and therefore shown, in-experience.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#Enabled", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.MaxIndicatorsVisible": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#MaxIndicatorsVisible", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.MaxPromptsVisible": { "documentation": "Maximum number of ProximityPrompts that will be shown to the player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#MaxPromptsVisible", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorHidden": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Once", "Wait": "@roblox/globaltype/ProximityPromptService.IndicatorHidden.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#IndicatorHidden", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.IndicatorShown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.IndicatorShown": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.IndicatorShown.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Once", "Wait": "@roblox/globaltype/ProximityPromptService.IndicatorShown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#IndicatorShown", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan": { "documentation": "Triggers when the player begins holding down the KeyboardKeyCode key/button on a prompt with a non-zero HoldDuration.", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Once", "Wait": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldBegan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#PromptButtonHoldBegan", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded": { "documentation": "Triggers when the player stops holding down the KeyboardKeyCode key/button on a prompt with a non-zero HoldDuration.", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Once", "Wait": "@roblox/globaltype/ProximityPromptService.PromptButtonHoldEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#PromptButtonHoldEnded", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptHidden.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptHidden.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptHidden.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptHidden.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptHidden.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptHidden": { "documentation": "Triggers client-side when a prompt becomes hidden.", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.PromptHidden.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.PromptHidden.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.PromptHidden.Once", "Wait": "@roblox/globaltype/ProximityPromptService.PromptHidden.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#PromptHidden", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.PromptShown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptShown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptShown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptShown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptShown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptShown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptShown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptShown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptShown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptShown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptShown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptShown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptShown": { "documentation": "Triggers client-side when a prompt becomes visible.", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.PromptShown.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.PromptShown.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.PromptShown.Once", "Wait": "@roblox/globaltype/ProximityPromptService.PromptShown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#PromptShown", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggered.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggered": { "documentation": "Triggers when the user interacts with this prompt.", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.PromptTriggered.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Once", "Wait": "@roblox/globaltype/ProximityPromptService.PromptTriggered.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#PromptTriggered", "code_sample": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded": { "documentation": "Triggers when the player stops holding down the KeyboardKeyCode key/button while triggering a prompt.", "keys": { "Connect": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Connect", "ConnectParallel": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.ConnectParallel", "Once": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Once", "Wait": "@roblox/globaltype/ProximityPromptService.PromptTriggerEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProximityPromptService#PromptTriggerEnded", "code_sample": "" }, "@roblox/globaltype/HingeConstraint": { "documentation": "Constrains its attachments to rotate about a single axis.", "keys": { "ActuatorType": "@roblox/globaltype/HingeConstraint.ActuatorType", "AngularResponsiveness": "@roblox/globaltype/HingeConstraint.AngularResponsiveness", "AngularSpeed": "@roblox/globaltype/HingeConstraint.AngularSpeed", "AngularVelocity": "@roblox/globaltype/HingeConstraint.AngularVelocity", "CurrentAngle": "@roblox/globaltype/HingeConstraint.CurrentAngle", "LimitsEnabled": "@roblox/globaltype/HingeConstraint.LimitsEnabled", "LowerAngle": "@roblox/globaltype/HingeConstraint.LowerAngle", "MotorMaxAcceleration": "@roblox/globaltype/HingeConstraint.MotorMaxAcceleration", "MotorMaxTorque": "@roblox/globaltype/HingeConstraint.MotorMaxTorque", "Radius": "@roblox/globaltype/HingeConstraint.Radius", "Restitution": "@roblox/globaltype/HingeConstraint.Restitution", "ServoMaxTorque": "@roblox/globaltype/HingeConstraint.ServoMaxTorque", "SoftlockServoUponReachingTarget": "@roblox/globaltype/HingeConstraint.SoftlockServoUponReachingTarget", "TargetAngle": "@roblox/globaltype/HingeConstraint.TargetAngle", "UpperAngle": "@roblox/globaltype/HingeConstraint.UpperAngle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.ActuatorType": { "documentation": "Sets whether the rotation of the HingeConstraint is actuated and, if so, what kind of actuation it uses.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#ActuatorType", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.AngularResponsiveness": { "documentation": "Specifies the sharpness of the servo motor in reaching the TargetAngle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#AngularResponsiveness", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.AngularSpeed": { "documentation": "The desired angular speed a HingeConstraint with ActuatorType set to Servo will attempt to maintain while rotating towards its TargetAngle. Measured in radians/second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#AngularSpeed", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.AngularVelocity": { "documentation": "The angular velocity a HingeConstraint with ActuatorType set to Motor will attempt to achieve. Measured in radians/second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#AngularVelocity", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.CurrentAngle": { "documentation": "The current angle of the HingeConstraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#CurrentAngle", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.LimitsEnabled": { "documentation": "Sets whether the HingeConstraint will limit the range of rotation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.LowerAngle": { "documentation": "The minimum rotation angle the HingeConstraint will allow if LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#LowerAngle", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.MotorMaxAcceleration": { "documentation": "The maximum angular acceleration a HingeConstraint with ActuatorType set to Motor can apply to achieve its AngularVelocity. Measured in radians/second².", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#MotorMaxAcceleration", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.MotorMaxTorque": { "documentation": "The maximum torque a HingeConstraint with ActuatorType set to Motor can apply when trying to reach its desired AngularVelocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#MotorMaxTorque", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.Radius": { "documentation": "The visualized radius of the HingeConstraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#Radius", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.Restitution": { "documentation": "How elastic Attachment connected by a HingeConstraint will be when they reach the end of the range when LimitsEnabled is true. Constrained between 0 and 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#Restitution", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.ServoMaxTorque": { "documentation": "The maximum torque a HingeConstraint with ActuatorType set to Servo can apply when trying to reach its desired TargetAngle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#ServoMaxTorque", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.SoftlockServoUponReachingTarget": { "documentation": "Deprecated: This property should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#SoftlockServoUponReachingTarget", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.TargetAngle": { "documentation": "The target angle a HingeConstraint will attempt to rotate to if its ActuatorType is set to Servo. Measured in degrees.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#TargetAngle", "code_sample": "" }, "@roblox/globaltype/HingeConstraint.UpperAngle": { "documentation": "The maximum rotation angle the HingeConstraint will allow if LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HingeConstraint#UpperAngle", "code_sample": "" }, "@roblox/globaltype/CatalogPages": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CatalogPages", "code_sample": "" }, "@roblox/globaltype/PyramidHandleAdornment": { "documentation": "A pyramid-shaped handle that can be adorned to a BasePart.", "keys": { "Height": "@roblox/globaltype/PyramidHandleAdornment.Height", "Shading": "@roblox/globaltype/PyramidHandleAdornment.Shading", "Sides": "@roblox/globaltype/PyramidHandleAdornment.Sides", "Size": "@roblox/globaltype/PyramidHandleAdornment.Size" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment", "code_sample": "" }, "@roblox/globaltype/PyramidHandleAdornment.Height": { "documentation": "Height of the pyramid adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Height", "code_sample": "" }, "@roblox/globaltype/PyramidHandleAdornment.Shading": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Shading", "code_sample": "" }, "@roblox/globaltype/PyramidHandleAdornment.Sides": { "documentation": "Number of sides for the pyramid adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Sides", "code_sample": "" }, "@roblox/globaltype/PyramidHandleAdornment.Size": { "documentation": "Size of the pyramid adornment's base.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PyramidHandleAdornment#Size", "code_sample": "" }, "@roblox/globaltype/Hint": { "documentation": "Deprecated: With the introduction of Roblox's GUI features hints have been deprecated and TextLabels should be used instead for new work. The TextLabel object offers a wide range of features for displaying and customizing text that hints do not.
A Hint is an object that creates a small black bar at the very top of the screen with text.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Hint", "code_sample": "" }, "@roblox/globaltype/HandRigDescription": { "documentation": "", "keys": { "Index1": "@roblox/globaltype/HandRigDescription.Index1", "Index1TposeAdjustment": "@roblox/globaltype/HandRigDescription.Index1TposeAdjustment", "Index2": "@roblox/globaltype/HandRigDescription.Index2", "Index2TposeAdjustment": "@roblox/globaltype/HandRigDescription.Index2TposeAdjustment", "Index3": "@roblox/globaltype/HandRigDescription.Index3", "Index3TposeAdjustment": "@roblox/globaltype/HandRigDescription.Index3TposeAdjustment", "IndexRange": "@roblox/globaltype/HandRigDescription.IndexRange", "IndexSize": "@roblox/globaltype/HandRigDescription.IndexSize", "Middle1": "@roblox/globaltype/HandRigDescription.Middle1", "Middle1TposeAdjustment": "@roblox/globaltype/HandRigDescription.Middle1TposeAdjustment", "Middle2": "@roblox/globaltype/HandRigDescription.Middle2", "Middle2TposeAdjustment": "@roblox/globaltype/HandRigDescription.Middle2TposeAdjustment", "Middle3": "@roblox/globaltype/HandRigDescription.Middle3", "Middle3TposeAdjustment": "@roblox/globaltype/HandRigDescription.Middle3TposeAdjustment", "MiddleRange": "@roblox/globaltype/HandRigDescription.MiddleRange", "MiddleSize": "@roblox/globaltype/HandRigDescription.MiddleSize", "Pinky1": "@roblox/globaltype/HandRigDescription.Pinky1", "Pinky1TposeAdjustment": "@roblox/globaltype/HandRigDescription.Pinky1TposeAdjustment", "Pinky2": "@roblox/globaltype/HandRigDescription.Pinky2", "Pinky2TposeAdjustment": "@roblox/globaltype/HandRigDescription.Pinky2TposeAdjustment", "Pinky3": "@roblox/globaltype/HandRigDescription.Pinky3", "Pinky3TposeAdjustment": "@roblox/globaltype/HandRigDescription.Pinky3TposeAdjustment", "PinkyRange": "@roblox/globaltype/HandRigDescription.PinkyRange", "PinkySize": "@roblox/globaltype/HandRigDescription.PinkySize", "Ring1": "@roblox/globaltype/HandRigDescription.Ring1", "Ring1TposeAdjustment": "@roblox/globaltype/HandRigDescription.Ring1TposeAdjustment", "Ring2": "@roblox/globaltype/HandRigDescription.Ring2", "Ring2TposeAdjustment": "@roblox/globaltype/HandRigDescription.Ring2TposeAdjustment", "Ring3": "@roblox/globaltype/HandRigDescription.Ring3", "Ring3TposeAdjustment": "@roblox/globaltype/HandRigDescription.Ring3TposeAdjustment", "RingRange": "@roblox/globaltype/HandRigDescription.RingRange", "RingSize": "@roblox/globaltype/HandRigDescription.RingSize", "Side": "@roblox/globaltype/HandRigDescription.Side", "Thumb1": "@roblox/globaltype/HandRigDescription.Thumb1", "Thumb1TposeAdjustment": "@roblox/globaltype/HandRigDescription.Thumb1TposeAdjustment", "Thumb2": "@roblox/globaltype/HandRigDescription.Thumb2", "Thumb2TposeAdjustment": "@roblox/globaltype/HandRigDescription.Thumb2TposeAdjustment", "Thumb3": "@roblox/globaltype/HandRigDescription.Thumb3", "Thumb3TposeAdjustment": "@roblox/globaltype/HandRigDescription.Thumb3TposeAdjustment", "ThumbRange": "@roblox/globaltype/HandRigDescription.ThumbRange", "ThumbSize": "@roblox/globaltype/HandRigDescription.ThumbSize", "GetFingerControl": "@roblox/globaltype/HandRigDescription.GetFingerControl", "GetFingerTip": "@roblox/globaltype/HandRigDescription.GetFingerTip", "SetFingerControl": "@roblox/globaltype/HandRigDescription.SetFingerControl", "SetFingerTip": "@roblox/globaltype/HandRigDescription.SetFingerTip" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Index1": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Index1", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Index1TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Index1TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Index2": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Index2", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Index2TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Index2TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Index3": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Index3", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Index3TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Index3TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.IndexRange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#IndexRange", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.IndexSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#IndexSize", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Middle1": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Middle1", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Middle1TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Middle1TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Middle2": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Middle2", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Middle2TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Middle2TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Middle3": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Middle3", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Middle3TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Middle3TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.MiddleRange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#MiddleRange", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.MiddleSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#MiddleSize", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Pinky1": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Pinky1", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Pinky1TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Pinky1TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Pinky2": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Pinky2", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Pinky2TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Pinky2TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Pinky3": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Pinky3", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Pinky3TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Pinky3TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.PinkyRange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#PinkyRange", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.PinkySize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#PinkySize", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Ring1": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Ring1", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Ring1TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Ring1TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Ring2": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Ring2", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Ring2TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Ring2TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Ring3": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Ring3", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Ring3TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Ring3TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.RingRange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#RingRange", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.RingSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#RingSize", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Side": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Side", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Thumb1": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Thumb1", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Thumb1TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Thumb1TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Thumb2": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Thumb2", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Thumb2TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Thumb2TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Thumb3": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Thumb3", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.Thumb3TposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#Thumb3TposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.ThumbRange": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#ThumbRange", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.ThumbSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#ThumbSize", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.GetFingerControl/param/0": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.GetFingerControl/param/1": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.GetFingerControl/return/0": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.GetFingerControl": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandRigDescription.GetFingerControl/param/0" }, { "name": "fingerIndex", "documentation": "@roblox/globaltype/HandRigDescription.GetFingerControl/param/1" } ], "returns": [ "@roblox/globaltype/HandRigDescription.GetFingerControl/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#GetFingerControl", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.GetFingerTip/param/0": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.GetFingerTip/param/1": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.GetFingerTip/return/0": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.GetFingerTip": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandRigDescription.GetFingerTip/param/0" }, { "name": "fingerIndex", "documentation": "@roblox/globaltype/HandRigDescription.GetFingerTip/param/1" } ], "returns": [ "@roblox/globaltype/HandRigDescription.GetFingerTip/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#GetFingerTip", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.SetFingerControl/param/0": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.SetFingerControl/param/1": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.SetFingerControl/param/2": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.SetFingerControl": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandRigDescription.SetFingerControl/param/0" }, { "name": "fingerIndex", "documentation": "@roblox/globaltype/HandRigDescription.SetFingerControl/param/1" }, { "name": "control", "documentation": "@roblox/globaltype/HandRigDescription.SetFingerControl/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#SetFingerControl", "code_sample": "" }, "@roblox/globaltype/HandRigDescription.SetFingerTip/param/0": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.SetFingerTip/param/1": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.SetFingerTip/param/2": { "documentation": "" }, "@roblox/globaltype/HandRigDescription.SetFingerTip": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HandRigDescription.SetFingerTip/param/0" }, { "name": "fingerIndex", "documentation": "@roblox/globaltype/HandRigDescription.SetFingerTip/param/1" }, { "name": "point", "documentation": "@roblox/globaltype/HandRigDescription.SetFingerTip/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HandRigDescription#SetFingerTip", "code_sample": "" }, "@roblox/globaltype/PlayerMouse": { "documentation": "The PlayerMouse behaves identically to the Mouse object that is obtained using Tool.Equipped. Both PlayerMouse and Mouse are legacy APIs, superseded by UserInputService.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerMouse", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal mouse = player:GetMouse()\n\nlocal function onMouseMove()\n\tprint(\"mouse screen position: \", mouse.X, mouse.Y)\nend\n\nmouse.Move:Connect(onMouseMove)" }, "@roblox/globaltype/Actor": { "documentation": "An Actor is a container for code that can be safely split into its own thread.", "keys": { "BindToMessage": "@roblox/globaltype/Actor.BindToMessage", "BindToMessageParallel": "@roblox/globaltype/Actor.BindToMessageParallel", "SendMessage": "@roblox/globaltype/Actor.SendMessage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Actor", "code_sample": "" }, "@roblox/globaltype/Actor.BindToMessage/param/0": { "documentation": "An Actor is a container for code that can be safely split into its own thread." }, "@roblox/globaltype/Actor.BindToMessage/param/1": { "documentation": "The topic used to identify the type of message." }, "@roblox/globaltype/Actor.BindToMessage/param/2": { "documentation": "" }, "@roblox/globaltype/Actor.BindToMessage/return/0": { "documentation": "This connection object may be used to disconnect the Luau callback from receiving messages." }, "@roblox/globaltype/Actor.BindToMessage": { "documentation": "Binds a Luau callback to a message with the specified topic.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Actor.BindToMessage/param/0" }, { "name": "topic", "documentation": "@roblox/globaltype/Actor.BindToMessage/param/1" }, { "name": "function", "documentation": "@roblox/globaltype/Actor.BindToMessage/param/2" } ], "returns": [ "@roblox/globaltype/Actor.BindToMessage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Actor#BindToMessage", "code_sample": "" }, "@roblox/globaltype/Actor.BindToMessageParallel/param/0": { "documentation": "An Actor is a container for code that can be safely split into its own thread." }, "@roblox/globaltype/Actor.BindToMessageParallel/param/1": { "documentation": "The topic used to identify the type of message." }, "@roblox/globaltype/Actor.BindToMessageParallel/param/2": { "documentation": "" }, "@roblox/globaltype/Actor.BindToMessageParallel/return/0": { "documentation": "This connection object may be used to disconnect the Luau callback from receiving messages." }, "@roblox/globaltype/Actor.BindToMessageParallel": { "documentation": "Binds a Luau callback to a message with the specified topic.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Actor.BindToMessageParallel/param/0" }, { "name": "topic", "documentation": "@roblox/globaltype/Actor.BindToMessageParallel/param/1" }, { "name": "function", "documentation": "@roblox/globaltype/Actor.BindToMessageParallel/param/2" } ], "returns": [ "@roblox/globaltype/Actor.BindToMessageParallel/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Actor#BindToMessageParallel", "code_sample": "" }, "@roblox/globaltype/Actor.SendMessage/param/0": { "documentation": "An Actor is a container for code that can be safely split into its own thread." }, "@roblox/globaltype/Actor.SendMessage/param/1": { "documentation": "The topic used to identify the message being sent." }, "@roblox/globaltype/Actor.SendMessage/param/2": { "documentation": "The contents of the message to send to the Actor." }, "@roblox/globaltype/Actor.SendMessage": { "documentation": "Sends a message to an Actor.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Actor.SendMessage/param/0" }, { "name": "topic", "documentation": "@roblox/globaltype/Actor.SendMessage/param/1" }, { "name": "message", "documentation": "@roblox/globaltype/Actor.SendMessage/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Actor#SendMessage", "code_sample": "" }, "@roblox/globaltype/RenderSettings": { "documentation": "", "keys": { "AutoFRMLevel": "@roblox/globaltype/RenderSettings.AutoFRMLevel", "EagerBulkExecution": "@roblox/globaltype/RenderSettings.EagerBulkExecution", "EditQualityLevel": "@roblox/globaltype/RenderSettings.EditQualityLevel", "Enable VR Mode": "@roblox/globaltype/RenderSettings.Enable VR Mode", "EnableFRM": "@roblox/globaltype/RenderSettings.EnableFRM", "ExportMergeByMaterial": "@roblox/globaltype/RenderSettings.ExportMergeByMaterial", "FrameRateManager": "@roblox/globaltype/RenderSettings.FrameRateManager", "GraphicsMode": "@roblox/globaltype/RenderSettings.GraphicsMode", "MeshCacheSize": "@roblox/globaltype/RenderSettings.MeshCacheSize", "MeshPartDetailLevel": "@roblox/globaltype/RenderSettings.MeshPartDetailLevel", "QualityLevel": "@roblox/globaltype/RenderSettings.QualityLevel", "ReloadAssets": "@roblox/globaltype/RenderSettings.ReloadAssets", "RenderCSGTrianglesDebug": "@roblox/globaltype/RenderSettings.RenderCSGTrianglesDebug", "ShowBoundingBoxes": "@roblox/globaltype/RenderSettings.ShowBoundingBoxes", "ViewMode": "@roblox/globaltype/RenderSettings.ViewMode", "GetMaxQualityLevel": "@roblox/globaltype/RenderSettings.GetMaxQualityLevel" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings", "code_sample": "" }, "@roblox/globaltype/RenderSettings.AutoFRMLevel": { "documentation": "Sets the starting quality level of the framerate manager.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#AutoFRMLevel", "code_sample": "" }, "@roblox/globaltype/RenderSettings.EagerBulkExecution": { "documentation": "Whether all scene updates will be given an unlimited budget, regardless of how computationally expensive it may be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#EagerBulkExecution", "code_sample": "" }, "@roblox/globaltype/RenderSettings.EditQualityLevel": { "documentation": "Sets the graphics quality level in Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#EditQualityLevel", "code_sample": "" }, "@roblox/globaltype/RenderSettings.Enable VR Mode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#Enable VR Mode", "code_sample": "" }, "@roblox/globaltype/RenderSettings.EnableFRM": { "documentation": "Toggles the enabled state of the framerate manager.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#EnableFRM", "code_sample": "" }, "@roblox/globaltype/RenderSettings.ExportMergeByMaterial": { "documentation": "Sets whether materials should be generated per part, or per unique appearance in Roblox's exporter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#ExportMergeByMaterial", "code_sample": "" }, "@roblox/globaltype/RenderSettings.FrameRateManager": { "documentation": "Specifies the behavior of the framerate manager.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#FrameRateManager", "code_sample": "" }, "@roblox/globaltype/RenderSettings.GraphicsMode": { "documentation": "The graphics API that Roblox will use on startup.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#GraphicsMode", "code_sample": "" }, "@roblox/globaltype/RenderSettings.MeshCacheSize": { "documentation": "The size in bytes of the mesh cache.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#MeshCacheSize", "code_sample": "" }, "@roblox/globaltype/RenderSettings.MeshPartDetailLevel": { "documentation": "Studio only. Used to visually verify the quality of MeshParts at lower level of detail at close range.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#MeshPartDetailLevel", "code_sample": "" }, "@roblox/globaltype/RenderSettings.QualityLevel": { "documentation": "Controls the quality level in Roblox Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#QualityLevel", "code_sample": "" }, "@roblox/globaltype/RenderSettings.ReloadAssets": { "documentation": "Whether Roblox Studio will automatically reload changes that are made to files in Roblox's content folder.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#ReloadAssets", "code_sample": "" }, "@roblox/globaltype/RenderSettings.RenderCSGTrianglesDebug": { "documentation": "Whether a wireframe of polygons will be shown on all PartOperation objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#RenderCSGTrianglesDebug", "code_sample": "" }, "@roblox/globaltype/RenderSettings.ShowBoundingBoxes": { "documentation": "Whether bounding boxes are rendered around each individual rendered entity in the scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#ShowBoundingBoxes", "code_sample": "" }, "@roblox/globaltype/RenderSettings.ViewMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#ViewMode", "code_sample": "" }, "@roblox/globaltype/RenderSettings.GetMaxQualityLevel/param/0": { "documentation": "" }, "@roblox/globaltype/RenderSettings.GetMaxQualityLevel/return/0": { "documentation": "" }, "@roblox/globaltype/RenderSettings.GetMaxQualityLevel": { "documentation": "Returns the maximum quality level.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RenderSettings.GetMaxQualityLevel/param/0" } ], "returns": [ "@roblox/globaltype/RenderSettings.GetMaxQualityLevel/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderSettings#GetMaxQualityLevel", "code_sample": "" }, "@roblox/globaltype/UIBase": { "documentation": "UIBase is the base class for UI layout and constraint classes.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIBase", "code_sample": "" }, "@roblox/globaltype/LinearVelocity": { "documentation": "Applies force on an assembly to maintain a constant linear velocity.", "keys": { "ForceLimitMode": "@roblox/globaltype/LinearVelocity.ForceLimitMode", "ForceLimitsEnabled": "@roblox/globaltype/LinearVelocity.ForceLimitsEnabled", "LineDirection": "@roblox/globaltype/LinearVelocity.LineDirection", "LineVelocity": "@roblox/globaltype/LinearVelocity.LineVelocity", "MaxAxesForce": "@roblox/globaltype/LinearVelocity.MaxAxesForce", "MaxForce": "@roblox/globaltype/LinearVelocity.MaxForce", "MaxPlanarAxesForce": "@roblox/globaltype/LinearVelocity.MaxPlanarAxesForce", "PlaneVelocity": "@roblox/globaltype/LinearVelocity.PlaneVelocity", "PrimaryTangentAxis": "@roblox/globaltype/LinearVelocity.PrimaryTangentAxis", "ReactionForceEnabled": "@roblox/globaltype/LinearVelocity.ReactionForceEnabled", "RelativeTo": "@roblox/globaltype/LinearVelocity.RelativeTo", "SecondaryTangentAxis": "@roblox/globaltype/LinearVelocity.SecondaryTangentAxis", "VectorVelocity": "@roblox/globaltype/LinearVelocity.VectorVelocity", "VelocityConstraintMode": "@roblox/globaltype/LinearVelocity.VelocityConstraintMode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.ForceLimitMode": { "documentation": "Determines how the constraint force will be limited.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#ForceLimitMode", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.ForceLimitsEnabled": { "documentation": "Determines if the constraint force will be limited or if the physics solver can apply an unlimited force to achieve the target velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#ForceLimitsEnabled", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.LineDirection": { "documentation": "The normalized Vector3 direction for constraining the velocity along a line.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#LineDirection", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.LineVelocity": { "documentation": "Float value of the velocity when VelocityConstraintMode is set to Line.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#LineVelocity", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.MaxAxesForce": { "documentation": "Maximum force along each axis that the constraint can apply to achieve the vector velocity. Only used if ForceLimitsEnabled is true, ForceLimitMode is PerAxis, and VelocityConstraintMode is Vector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#MaxAxesForce", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.MaxForce": { "documentation": "Maximum magnitude of the force vector the constraint can apply.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#MaxForce", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.MaxPlanarAxesForce": { "documentation": "Maximum force along each axis that the constraint can apply to achieve the plane velocity. Only used if ForceLimitsEnabled is true, ForceLimitMode is PerAxis, and VelocityConstraintMode is Plane.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#MaxPlanarAxesForce", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.PlaneVelocity": { "documentation": "Vector2 value of the velocity in each tangent direction of the plane.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#PlaneVelocity", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.PrimaryTangentAxis": { "documentation": "The primary axis in the plane, when VelocityConstraintMode is set to Plane.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#PrimaryTangentAxis", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.ReactionForceEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#ReactionForceEnabled", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.RelativeTo": { "documentation": "Sets the ActuatorRelativeTo property for the constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#RelativeTo", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.SecondaryTangentAxis": { "documentation": "The secondary axis in the plane, when VelocityConstraintMode is set to Plane.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#SecondaryTangentAxis", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.VectorVelocity": { "documentation": "Vector3 velocity value when VelocityConstraintMode is set to Vector.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#VectorVelocity", "code_sample": "" }, "@roblox/globaltype/LinearVelocity.VelocityConstraintMode": { "documentation": "The mode of the constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LinearVelocity#VelocityConstraintMode", "code_sample": "" }, "@roblox/globaltype/ScriptContext": { "documentation": "", "keys": { "SetTimeout": "@roblox/globaltype/ScriptContext.SetTimeout" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptContext", "code_sample": "" }, "@roblox/globaltype/ScriptContext.SetTimeout/param/0": { "documentation": "" }, "@roblox/globaltype/ScriptContext.SetTimeout/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptContext.SetTimeout": { "documentation": "Limits how long a script is allowed to run without yielding.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptContext.SetTimeout/param/0" }, { "name": "seconds", "documentation": "@roblox/globaltype/ScriptContext.SetTimeout/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptContext#SetTimeout", "code_sample": "" }, "@roblox/globaltype/ScriptContext.Error.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptContext.Error.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptContext.Error.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptContext.Error.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptContext.Error.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptContext.Error.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptContext.Error.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptContext.Error.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptContext.Error.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptContext.Error.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptContext.Error.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptContext.Error.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptContext.Error.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptContext.Error.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptContext.Error.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptContext.Error.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptContext.Error.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptContext.Error.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptContext.Error": { "documentation": "Fired when an error occurs.", "keys": { "Connect": "@roblox/globaltype/ScriptContext.Error.Connect", "ConnectParallel": "@roblox/globaltype/ScriptContext.Error.ConnectParallel", "Once": "@roblox/globaltype/ScriptContext.Error.Once", "Wait": "@roblox/globaltype/ScriptContext.Error.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptContext#Error", "code_sample": "local ScriptContext = game:GetService(\"ScriptContext\")\n\nlocal function onError(message, trace, script)\n\tprint(script:GetFullName(), \"errored!\")\n\tprint(\"Reason:\", message)\n\tprint(\"Trace:\", trace)\nend\n\nScriptContext.Error:Connect(onError)\n\n-- Somewhere, in another script\n\nerror(\"Error occurred!\")" }, "@roblox/globaltype/File": { "documentation": "An asset loaded from a file on disk.", "keys": { "Size": "@roblox/globaltype/File.Size", "GetBinaryContents": "@roblox/globaltype/File.GetBinaryContents", "GetTemporaryId": "@roblox/globaltype/File.GetTemporaryId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/File", "code_sample": "" }, "@roblox/globaltype/File.Size": { "documentation": "The size of the file on disk, in bytes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/File#Size", "code_sample": "" }, "@roblox/globaltype/File.GetBinaryContents/param/0": { "documentation": "An asset loaded from a file on disk." }, "@roblox/globaltype/File.GetBinaryContents/return/0": { "documentation": "A raw binary string representation of the File contents." }, "@roblox/globaltype/File.GetBinaryContents": { "documentation": "Reads the contents of the File as a string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/File.GetBinaryContents/param/0" } ], "returns": [ "@roblox/globaltype/File.GetBinaryContents/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/File#GetBinaryContents", "code_sample": "" }, "@roblox/globaltype/File.GetTemporaryId/param/0": { "documentation": "An asset loaded from a file on disk." }, "@roblox/globaltype/File.GetTemporaryId/return/0": { "documentation": "The temporary asset ID." }, "@roblox/globaltype/File.GetTemporaryId": { "documentation": "Gets a rbxtemp:// asset ID for this File.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/File.GetTemporaryId/param/0" } ], "returns": [ "@roblox/globaltype/File.GetTemporaryId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/File#GetTemporaryId", "code_sample": "" }, "@roblox/globaltype/PermissionsService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PermissionsService", "code_sample": "" }, "@roblox/globaltype/HumanoidController": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidController", "code_sample": "" }, "@roblox/globaltype/SharedTableRegistry": { "documentation": "Provides a global registry of named SharedTable objects.", "keys": { "GetSharedTable": "@roblox/globaltype/SharedTableRegistry.GetSharedTable", "SetSharedTable": "@roblox/globaltype/SharedTableRegistry.SetSharedTable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SharedTableRegistry", "code_sample": "" }, "@roblox/globaltype/SharedTableRegistry.GetSharedTable/param/0": { "documentation": "Provides a global registry of named SharedTable objects." }, "@roblox/globaltype/SharedTableRegistry.GetSharedTable/param/1": { "documentation": "The name of the registered SharedTable." }, "@roblox/globaltype/SharedTableRegistry.GetSharedTable/return/0": { "documentation": "" }, "@roblox/globaltype/SharedTableRegistry.GetSharedTable": { "documentation": "Gets the registered SharedTable with the specified name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SharedTableRegistry.GetSharedTable/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/SharedTableRegistry.GetSharedTable/param/1" } ], "returns": [ "@roblox/globaltype/SharedTableRegistry.GetSharedTable/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SharedTableRegistry#GetSharedTable", "code_sample": "" }, "@roblox/globaltype/SharedTableRegistry.SetSharedTable/param/0": { "documentation": "Provides a global registry of named SharedTable objects." }, "@roblox/globaltype/SharedTableRegistry.SetSharedTable/param/1": { "documentation": "The name of the registered SharedTable." }, "@roblox/globaltype/SharedTableRegistry.SetSharedTable/param/2": { "documentation": "The SharedTable object to register, or nil to unregister any previously registered SharedTable object." }, "@roblox/globaltype/SharedTableRegistry.SetSharedTable": { "documentation": "Registers the provided SharedTable with the specified name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SharedTableRegistry.SetSharedTable/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/SharedTableRegistry.SetSharedTable/param/1" }, { "name": "st", "documentation": "@roblox/globaltype/SharedTableRegistry.SetSharedTable/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SharedTableRegistry#SetSharedTable", "code_sample": "" }, "@roblox/globaltype/TextChannel": { "documentation": "Represents a text chat channel.", "keys": { "DirectChatRequester": "@roblox/globaltype/TextChannel.DirectChatRequester", "AddUserAsync": "@roblox/globaltype/TextChannel.AddUserAsync", "DisplaySystemMessage": "@roblox/globaltype/TextChannel.DisplaySystemMessage", "SendAsync": "@roblox/globaltype/TextChannel.SendAsync", "SetDirectChatRequester": "@roblox/globaltype/TextChannel.SetDirectChatRequester", "OnIncomingMessage": "@roblox/globaltype/TextChannel.OnIncomingMessage", "ShouldDeliverCallback": "@roblox/globaltype/TextChannel.ShouldDeliverCallback" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel", "code_sample": "" }, "@roblox/globaltype/TextChannel.DirectChatRequester": { "documentation": "The TextChannel will only deliver messages to users that can send direct messages to the DirectChatRequester.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#DirectChatRequester", "code_sample": "" }, "@roblox/globaltype/TextChannel.AddUserAsync/param/0": { "documentation": "Represents a text chat channel." }, "@roblox/globaltype/TextChannel.AddUserAsync/param/1": { "documentation": "The userId of the Player." }, "@roblox/globaltype/TextChannel.AddUserAsync/return/0": { "documentation": "Returns TextSource and true if a new TextSource is created for the user, TextSource and false if there is an existing TextSource, or nil and false if the user has chat off or is not in this server." }, "@roblox/globaltype/TextChannel.AddUserAsync": { "documentation": "Adds a TextSource to the TextChannel given userId of a Player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.AddUserAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/TextChannel.AddUserAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextChannel.AddUserAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#AddUserAsync", "code_sample": "" }, "@roblox/globaltype/TextChannel.DisplaySystemMessage/param/0": { "documentation": "Represents a text chat channel." }, "@roblox/globaltype/TextChannel.DisplaySystemMessage/param/1": { "documentation": "The system message sent to the TextChannel." }, "@roblox/globaltype/TextChannel.DisplaySystemMessage/param/2": { "documentation": "Use to identify system message types, such as the default system messages." }, "@roblox/globaltype/TextChannel.DisplaySystemMessage/return/0": { "documentation": "A TextChatMessage with TextChatMessage.Status property that indicates the condition of the message." }, "@roblox/globaltype/TextChannel.DisplaySystemMessage": { "documentation": "Displays a system message to the user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.DisplaySystemMessage/param/0" }, { "name": "systemMessage", "documentation": "@roblox/globaltype/TextChannel.DisplaySystemMessage/param/1" }, { "name": "metadata", "documentation": "@roblox/globaltype/TextChannel.DisplaySystemMessage/param/2" } ], "returns": [ "@roblox/globaltype/TextChannel.DisplaySystemMessage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#DisplaySystemMessage", "code_sample": "" }, "@roblox/globaltype/TextChannel.SendAsync/param/0": { "documentation": "Represents a text chat channel." }, "@roblox/globaltype/TextChannel.SendAsync/param/1": { "documentation": "The message to send to the TextChannel." }, "@roblox/globaltype/TextChannel.SendAsync/param/2": { "documentation": "Custom metadata to attach to the message." }, "@roblox/globaltype/TextChannel.SendAsync/return/0": { "documentation": "A TextChatMessage with TextChatMessage.Status property that indicates the condition of the message." }, "@roblox/globaltype/TextChannel.SendAsync": { "documentation": "Sends a TextChatMessage to the server.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.SendAsync/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/TextChannel.SendAsync/param/1" }, { "name": "metadata", "documentation": "@roblox/globaltype/TextChannel.SendAsync/param/2" } ], "returns": [ "@roblox/globaltype/TextChannel.SendAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#SendAsync", "code_sample": "" }, "@roblox/globaltype/TextChannel.SetDirectChatRequester/param/0": { "documentation": "Represents a text chat channel." }, "@roblox/globaltype/TextChannel.SetDirectChatRequester/param/1": { "documentation": "" }, "@roblox/globaltype/TextChannel.SetDirectChatRequester": { "documentation": "Sets the DirectChatRequester for the TextChannel. The TextChannel will only deliver messages to users that can send direct messages to the DirectChatRequester.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.SetDirectChatRequester/param/0" }, { "name": "requester", "documentation": "@roblox/globaltype/TextChannel.SetDirectChatRequester/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#SetDirectChatRequester", "code_sample": "" }, "@roblox/globaltype/TextChannel.OnIncomingMessage/param/0": { "documentation": "The incoming TextChatMessage." }, "@roblox/globaltype/TextChannel.OnIncomingMessage/return/0": { "documentation": "If a TextChatMessageProperties is returned, those properties are merged with the TextChatMessage parameter to create a new TextChatMessage with those properties." }, "@roblox/globaltype/TextChannel.OnIncomingMessage": { "documentation": "Called when TextChannel is receiving an incoming message.", "params": [ { "name": "message", "documentation": "@roblox/globaltype/TextChannel.OnIncomingMessage/param/0" } ], "returns": [ "@roblox/globaltype/TextChannel.OnIncomingMessage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#OnIncomingMessage", "code_sample": "" }, "@roblox/globaltype/TextChannel.ShouldDeliverCallback/param/0": { "documentation": "The message being sent, which also contains the sender of the message." }, "@roblox/globaltype/TextChannel.ShouldDeliverCallback/param/1": { "documentation": "The TextSource of the user who will be receiving the message." }, "@roblox/globaltype/TextChannel.ShouldDeliverCallback/return/0": { "documentation": "" }, "@roblox/globaltype/TextChannel.ShouldDeliverCallback": { "documentation": "Called for each client when TextChannel is receiving an incoming message to determine whether or not it should be delivered to that client.", "params": [ { "name": "message", "documentation": "@roblox/globaltype/TextChannel.ShouldDeliverCallback/param/0" }, { "name": "textSource", "documentation": "@roblox/globaltype/TextChannel.ShouldDeliverCallback/param/1" } ], "returns": [ "@roblox/globaltype/TextChannel.ShouldDeliverCallback/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#ShouldDeliverCallback", "code_sample": "" }, "@roblox/globaltype/TextChannel.MessageReceived.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChannel.MessageReceived.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextChannel.MessageReceived.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChannel.MessageReceived.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChannel.MessageReceived.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextChannel.MessageReceived.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChannel.MessageReceived.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChannel.MessageReceived.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextChannel.MessageReceived.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChannel.MessageReceived.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChannel.MessageReceived.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChannel.MessageReceived.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextChannel.MessageReceived": { "documentation": "Fires when TextChannel:DisplaySystemMessage() is invoked on the client, or when the client receives a valid TextChannel:SendAsync() response from the server.", "keys": { "Connect": "@roblox/globaltype/TextChannel.MessageReceived.Connect", "ConnectParallel": "@roblox/globaltype/TextChannel.MessageReceived.ConnectParallel", "Once": "@roblox/globaltype/TextChannel.MessageReceived.Once", "Wait": "@roblox/globaltype/TextChannel.MessageReceived.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChannel#MessageReceived", "code_sample": "" }, "@roblox/globaltype/ServiceProvider": { "documentation": "A ServiceProvider is an abstract class, which stores, and provides certain singleton classes, depending on what inherited class you are using its members with.", "keys": { "FindService": "@roblox/globaltype/ServiceProvider.FindService", "GetService": "@roblox/globaltype/ServiceProvider.GetService", "getService": "@roblox/globaltype/ServiceProvider.getService", "service": "@roblox/globaltype/ServiceProvider.service" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider", "code_sample": "" }, "@roblox/globaltype/ServiceProvider.FindService/param/0": { "documentation": "A ServiceProvider is an abstract class, which stores, and provides certain singleton classes, depending on what inherited class you are using its members with." }, "@roblox/globaltype/ServiceProvider.FindService/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.FindService/return/0": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.FindService": { "documentation": "Returns the service specified by the given className if it's already created, errors for an invalid name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.FindService/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/ServiceProvider.FindService/param/1" } ], "returns": [ "@roblox/globaltype/ServiceProvider.FindService/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#FindService", "code_sample": "print(game:FindService(\"Part\"))\n--> nil\n\nprint(game:FindService(\"Workspace\"))\n--> Workspace" }, "@roblox/globaltype/ServiceProvider.GetService/param/0": { "documentation": "A ServiceProvider is an abstract class, which stores, and provides certain singleton classes, depending on what inherited class you are using its members with." }, "@roblox/globaltype/ServiceProvider.GetService/param/1": { "documentation": "The class name of the requested service." }, "@roblox/globaltype/ServiceProvider.GetService/return/0": { "documentation": "An instance of the requested service." }, "@roblox/globaltype/ServiceProvider.GetService": { "documentation": "Returns the service with the requested class name, creating it if it does not exist.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.GetService/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/ServiceProvider.GetService/param/1" } ], "returns": [ "@roblox/globaltype/ServiceProvider.GetService/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#GetService", "code_sample": "local BadgeService = game:GetService(\"BadgeService\")\nlocal GameSettings = UserSettings():GetService(\"UserGameSettings\")\n\nprint(BadgeService)\nprint(GameSettings)" }, "@roblox/globaltype/ServiceProvider.getService/param/0": { "documentation": "A ServiceProvider is an abstract class, which stores, and provides certain singleton classes, depending on what inherited class you are using its members with." }, "@roblox/globaltype/ServiceProvider.getService/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.getService/return/0": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.getService": { "documentation": "Deprecated: This deprecated function is a variant of ServiceProvider:GetService() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.getService/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/ServiceProvider.getService/param/1" } ], "returns": [ "@roblox/globaltype/ServiceProvider.getService/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#getService", "code_sample": "" }, "@roblox/globaltype/ServiceProvider.service/param/0": { "documentation": "A ServiceProvider is an abstract class, which stores, and provides certain singleton classes, depending on what inherited class you are using its members with." }, "@roblox/globaltype/ServiceProvider.service/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.service/return/0": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.service": { "documentation": "Deprecated: This item has been superseded by ServiceProvider:GetService() which should be used in all new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.service/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/ServiceProvider.service/param/1" } ], "returns": [ "@roblox/globaltype/ServiceProvider.service/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#service", "code_sample": "" }, "@roblox/globaltype/ServiceProvider.Close.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.Close.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.Close.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.Close.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.Close.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.Close.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.Close.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.Close.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.Close.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.Close.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.Close.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.Close.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.Close.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.Close.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.Close.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.Close.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.Close.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.Close.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.Close": { "documentation": "Fires when the current place is exited.", "keys": { "Connect": "@roblox/globaltype/ServiceProvider.Close.Connect", "ConnectParallel": "@roblox/globaltype/ServiceProvider.Close.ConnectParallel", "Once": "@roblox/globaltype/ServiceProvider.Close.Once", "Wait": "@roblox/globaltype/ServiceProvider.Close.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#Close", "code_sample": "local function onClose()\n\tprint(\"The place is closing\")\nend\n\ngame.Close:Connect(onClose)" }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.ServiceAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceAdded": { "documentation": "Fired when a service is created.", "keys": { "Connect": "@roblox/globaltype/ServiceProvider.ServiceAdded.Connect", "ConnectParallel": "@roblox/globaltype/ServiceProvider.ServiceAdded.ConnectParallel", "Once": "@roblox/globaltype/ServiceProvider.ServiceAdded.Once", "Wait": "@roblox/globaltype/ServiceProvider.ServiceAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#ServiceAdded", "code_sample": "" }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ServiceProvider.ServiceRemoving.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ServiceProvider.ServiceRemoving": { "documentation": "Fired when a service is about to be removed.", "keys": { "Connect": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Connect", "ConnectParallel": "@roblox/globaltype/ServiceProvider.ServiceRemoving.ConnectParallel", "Once": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Once", "Wait": "@roblox/globaltype/ServiceProvider.ServiceRemoving.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServiceProvider#ServiceRemoving", "code_sample": "" }, "@roblox/globaltype/NetworkPeer": { "documentation": "The NetworkPeer object is the most basic class of the network objects.", "keys": { "SetOutgoingKBPSLimit": "@roblox/globaltype/NetworkPeer.SetOutgoingKBPSLimit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkPeer", "code_sample": "" }, "@roblox/globaltype/NetworkPeer.SetOutgoingKBPSLimit/param/0": { "documentation": "The NetworkPeer object is the most basic class of the network objects." }, "@roblox/globaltype/NetworkPeer.SetOutgoingKBPSLimit/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkPeer.SetOutgoingKBPSLimit": { "documentation": "Sets the maximum outgoing bandwidth that Roblox can use.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkPeer.SetOutgoingKBPSLimit/param/0" }, { "name": "limit", "documentation": "@roblox/globaltype/NetworkPeer.SetOutgoingKBPSLimit/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkPeer#SetOutgoingKBPSLimit", "code_sample": "local NetworkClient = game:GetService(\"NetworkClient\")\n\nNetworkClient:SetOutgoingKBPSLimit(1)" }, "@roblox/globaltype/MLSession": { "documentation": "", "keys": { "ForwardAsync": "@roblox/globaltype/MLSession.ForwardAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MLSession", "code_sample": "" }, "@roblox/globaltype/MLSession.ForwardAsync/param/0": { "documentation": "" }, "@roblox/globaltype/MLSession.ForwardAsync/param/1": { "documentation": "" }, "@roblox/globaltype/MLSession.ForwardAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MLSession.ForwardAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MLSession.ForwardAsync/param/0" }, { "name": "data", "documentation": "@roblox/globaltype/MLSession.ForwardAsync/param/1" } ], "returns": [ "@roblox/globaltype/MLSession.ForwardAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MLSession#ForwardAsync", "code_sample": "" }, "@roblox/globaltype/WebStreamClient": { "documentation": "Maintains a streaming connection.", "keys": { "ConnectionState": "@roblox/globaltype/WebStreamClient.ConnectionState", "Close": "@roblox/globaltype/WebStreamClient.Close", "Send": "@roblox/globaltype/WebStreamClient.Send" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.ConnectionState": { "documentation": "The current WebStreamClientState of the client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#ConnectionState", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.Close/param/0": { "documentation": "Maintains a streaming connection." }, "@roblox/globaltype/WebStreamClient.Close": { "documentation": "Closes the client, aborting the ongoing request.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Close/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Close", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.Send/param/0": { "documentation": "Maintains a streaming connection." }, "@roblox/globaltype/WebStreamClient.Send/param/1": { "documentation": "Text string to send to the server." }, "@roblox/globaltype/WebStreamClient.Send": { "documentation": "Enqueues data to be transmitted to the server over the streaming connection.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Send/param/0" }, { "name": "data", "documentation": "@roblox/globaltype/WebStreamClient.Send/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Send", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.Closed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Closed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Closed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Closed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Closed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Closed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Closed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Closed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Closed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Closed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Closed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Closed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Closed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Closed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Closed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Closed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Closed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Closed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Closed": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/WebStreamClient.Closed.Connect", "ConnectParallel": "@roblox/globaltype/WebStreamClient.Closed.ConnectParallel", "Once": "@roblox/globaltype/WebStreamClient.Closed.Once", "Wait": "@roblox/globaltype/WebStreamClient.Closed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Closed", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.Error.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Error.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Error.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Error.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Error.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Error.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Error.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Error.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Error.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Error.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Error.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Error.Once/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Error.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Error.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Error.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Error.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Error.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Error.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Error": { "documentation": "Fires if an error is received while establishing the connection or during the connection lifetime.", "keys": { "Connect": "@roblox/globaltype/WebStreamClient.Error.Connect", "ConnectParallel": "@roblox/globaltype/WebStreamClient.Error.ConnectParallel", "Once": "@roblox/globaltype/WebStreamClient.Error.Once", "Wait": "@roblox/globaltype/WebStreamClient.Error.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Error", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.MessageReceived.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.MessageReceived.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.MessageReceived.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.MessageReceived.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.MessageReceived.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.MessageReceived.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.MessageReceived.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.MessageReceived.Once/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.MessageReceived.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.MessageReceived.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.MessageReceived.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.MessageReceived.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.MessageReceived": { "documentation": "Fires each time a message is received from the server.", "keys": { "Connect": "@roblox/globaltype/WebStreamClient.MessageReceived.Connect", "ConnectParallel": "@roblox/globaltype/WebStreamClient.MessageReceived.ConnectParallel", "Once": "@roblox/globaltype/WebStreamClient.MessageReceived.Once", "Wait": "@roblox/globaltype/WebStreamClient.MessageReceived.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#MessageReceived", "code_sample": "" }, "@roblox/globaltype/WebStreamClient.Opened.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Opened.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Opened.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Opened.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Opened.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Opened.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Opened.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Opened.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Opened.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Opened.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Opened.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Opened.Once/param/1": { "documentation": "" }, "@roblox/globaltype/WebStreamClient.Opened.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Opened.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/WebStreamClient.Opened.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Opened.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/WebStreamClient.Opened.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WebStreamClient.Opened.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/WebStreamClient.Opened": { "documentation": "Fires when the a connection is successfully established between the client and server, allowing for events to begin streaming.", "keys": { "Connect": "@roblox/globaltype/WebStreamClient.Opened.Connect", "ConnectParallel": "@roblox/globaltype/WebStreamClient.Opened.ConnectParallel", "Once": "@roblox/globaltype/WebStreamClient.Opened.Once", "Wait": "@roblox/globaltype/WebStreamClient.Opened.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WebStreamClient#Opened", "code_sample": "" }, "@roblox/globaltype/RotateP": { "documentation": "Deprecated: This class works alongside the deprecated SurfaceType and should not be used for future work; use HingeConstraint instead.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RotateP", "code_sample": "" }, "@roblox/globaltype/Atmosphere": { "documentation": "The Atmosphere object pushes Roblox closer toward realistic environments where sunlight scatters in different ways depending on density and other air particle properties.", "keys": { "Color": "@roblox/globaltype/Atmosphere.Color", "Decay": "@roblox/globaltype/Atmosphere.Decay", "Density": "@roblox/globaltype/Atmosphere.Density", "Glare": "@roblox/globaltype/Atmosphere.Glare", "Haze": "@roblox/globaltype/Atmosphere.Haze", "Offset": "@roblox/globaltype/Atmosphere.Offset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere", "code_sample": "" }, "@roblox/globaltype/Atmosphere.Color": { "documentation": "Changes the Atmosphere hue for subtle environmental moods.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere#Color", "code_sample": "" }, "@roblox/globaltype/Atmosphere.Decay": { "documentation": "When used with increased Atmosphere.Haze and Atmosphere.Glare, defines the hue of the Atmosphere away from the sun, gradually falling off from Atmosphere.Color towards this value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere#Decay", "code_sample": "" }, "@roblox/globaltype/Atmosphere.Density": { "documentation": "Defines the amount of particles in the Atmosphere and essentially controls how much in-game objects/terrain will be obscured by them.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere#Density", "code_sample": "" }, "@roblox/globaltype/Atmosphere.Glare": { "documentation": "When used with increased Atmosphere.Haze, specifies the glow/glare of the Atmosphere around the sun. More glare results in an increased effect of sunlight cast onto the sky and world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere#Glare", "code_sample": "" }, "@roblox/globaltype/Atmosphere.Haze": { "documentation": "Defines the haziness of the Atmosphere with a visible effect both above the horizon and into the distance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere#Haze", "code_sample": "" }, "@roblox/globaltype/Atmosphere.Offset": { "documentation": "Controls how light transmits between the camera and the sky background.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Atmosphere#Offset", "code_sample": "" }, "@roblox/globaltype/AnimationTrack": { "documentation": "Controls the playback of an animation on an Animator.", "keys": { "Animation": "@roblox/globaltype/AnimationTrack.Animation", "IsPlaying": "@roblox/globaltype/AnimationTrack.IsPlaying", "Length": "@roblox/globaltype/AnimationTrack.Length", "Looped": "@roblox/globaltype/AnimationTrack.Looped", "Priority": "@roblox/globaltype/AnimationTrack.Priority", "Speed": "@roblox/globaltype/AnimationTrack.Speed", "TimePosition": "@roblox/globaltype/AnimationTrack.TimePosition", "WeightCurrent": "@roblox/globaltype/AnimationTrack.WeightCurrent", "WeightTarget": "@roblox/globaltype/AnimationTrack.WeightTarget", "AdjustSpeed": "@roblox/globaltype/AnimationTrack.AdjustSpeed", "AdjustWeight": "@roblox/globaltype/AnimationTrack.AdjustWeight", "GetMarkerReachedSignal": "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal", "GetParameter": "@roblox/globaltype/AnimationTrack.GetParameter", "GetParameterDefaults": "@roblox/globaltype/AnimationTrack.GetParameterDefaults", "GetTargetInstance": "@roblox/globaltype/AnimationTrack.GetTargetInstance", "GetTargetNames": "@roblox/globaltype/AnimationTrack.GetTargetNames", "GetTimeOfKeyframe": "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe", "Play": "@roblox/globaltype/AnimationTrack.Play", "SetParameter": "@roblox/globaltype/AnimationTrack.SetParameter", "SetTargetInstance": "@roblox/globaltype/AnimationTrack.SetTargetInstance", "Stop": "@roblox/globaltype/AnimationTrack.Stop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.Animation": { "documentation": "The Animation object that was used to create this AnimationTrack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Animation", "code_sample": "local humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\n\nanimator.AnimationPlayed:Connect(function(animationTrack)\n\tlocal animationName = animationTrack.Animation.Name\n\tprint(\"Animation playing \" .. animationName)\nend)" }, "@roblox/globaltype/AnimationTrack.IsPlaying": { "documentation": "A read-only property that returns true when the AnimationTrack is playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#IsPlaying", "code_sample": "local function playOrAdjust(animationTrack, fadeTime, weight, speed)\n\tif not animationTrack.IsPlaying then\n\t\tanimationTrack:Play(fadeTime, weight, speed)\n\telse\n\t\tanimationTrack:AdjustSpeed(speed)\n\t\tanimationTrack:AdjustWeight(weight, fadeTime)\n\tend\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765644\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\nlocal animationTrack = animator:LoadAnimation(animation)\n\nplayOrAdjust(animationTrack, 1, 0.6, 1)" }, "@roblox/globaltype/AnimationTrack.Length": { "documentation": "A read-only property that returns the length (in seconds) of an AnimationTrack. This will return 0 until the animation has fully loaded and thus may not be immediately available.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Length", "code_sample": "local function playAnimationForDuration(animationTrack, duration)\n\tlocal speed = animationTrack.Length / duration\n\tanimationTrack:Play()\n\tanimationTrack:AdjustSpeed(speed)\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765000\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\n\nlocal animationTrack = animator:LoadAnimation(animation)\n\nplayAnimationForDuration(animationTrack, 3)" }, "@roblox/globaltype/AnimationTrack.Looped": { "documentation": "Sets whether the animation will repeat after finishing. If it is changed while playing the result will take effect after the animation finishes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Looped", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal localPlayer = Players.LocalPlayer\n\nwhile not localPlayer.Character do\n\ttask.wait()\nend\n\nlocal character = localPlayer.Character\nlocal humanoid = character:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507770453\"\n\nlocal animationTrack = animator:LoadAnimation(animation)\nanimationTrack.Looped = false\ntask.wait(3)\nanimationTrack:Play()\ntask.wait(4)\nanimationTrack.Looped = true\nanimationTrack:Play()" }, "@roblox/globaltype/AnimationTrack.Priority": { "documentation": "Sets the priority of an AnimationTrack. Depending on what this is set to, playing multiple animations at once will look to this property to figure out which Keyframe Poses should be played over one another.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Priority", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.Speed": { "documentation": "Read-only property that gives the current playback speed of the AnimationTrack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Speed", "code_sample": "local ContentProvider = game:GetService(\"ContentProvider\")\nlocal Players = game:GetService(\"Players\")\n\nlocal localPlayer = Players.LocalPlayer\nwhile not localPlayer.Character do\n\ttask.wait()\nend\nlocal character = localPlayer.Character\nlocal humanoid = character:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507770453\"\n\nContentProvider:PreloadAsync({ animation })\n\nlocal animationTrack = animator:LoadAnimation(animation)\n\nlocal normalSpeedTime = animationTrack.Length / animationTrack.Speed\nanimationTrack:AdjustSpeed(3)\nlocal fastSpeedTime = animationTrack.Length / animationTrack.Speed\n\nprint(\"At normal speed the animation will play for\", normalSpeedTime, \"seconds\")\nprint(\"At 3x speed the animation will play for\", fastSpeedTime, \"seconds\")" }, "@roblox/globaltype/AnimationTrack.TimePosition": { "documentation": "Returns the position in time in seconds that an AnimationTrack is through playing its source animation. Can be set to make the track jump to a specific moment in the animation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#TimePosition", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.WeightCurrent": { "documentation": "Read-only property that gives the current weight of the AnimationTrack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#WeightCurrent", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.WeightTarget": { "documentation": "Read-only property that gives the current weight of the AnimationTrack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#WeightTarget", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.AdjustSpeed/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.AdjustSpeed/param/1": { "documentation": "The playback speed the animation is to be changed to." }, "@roblox/globaltype/AnimationTrack.AdjustSpeed": { "documentation": "Changes the AnimationTrack.Speed of an animation. A positive value for speed plays the animation forward, a negative one plays it backwards, and 0 pauses it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.AdjustSpeed/param/0" }, { "name": "speed", "documentation": "@roblox/globaltype/AnimationTrack.AdjustSpeed/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#AdjustSpeed", "code_sample": "local function playAnimationForDuration(animationTrack, duration)\n\tlocal speed = animationTrack.Length / duration\n\tanimationTrack:Play()\n\tanimationTrack:AdjustSpeed(speed)\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765000\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\n\nlocal animationTrack = animator:LoadAnimation(animation)\n\nplayAnimationForDuration(animationTrack, 3)" }, "@roblox/globaltype/AnimationTrack.AdjustWeight/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.AdjustWeight/param/1": { "documentation": "The weight the animation is to be changed to." }, "@roblox/globaltype/AnimationTrack.AdjustWeight/param/2": { "documentation": "The duration of time that the animation will fade between the old weight and the new weight for." }, "@roblox/globaltype/AnimationTrack.AdjustWeight": { "documentation": "Changes the weight of an animation, with the optional fadeTime parameter determining how long it takes for AnimationTrack.WeightCurrent to reach AnimationTrack.WeightTarget.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.AdjustWeight/param/0" }, { "name": "weight", "documentation": "@roblox/globaltype/AnimationTrack.AdjustWeight/param/1" }, { "name": "fadeTime", "documentation": "@roblox/globaltype/AnimationTrack.AdjustWeight/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#AdjustWeight", "code_sample": "local function changeWeight(animationTrack, weight, fadeTime)\n\tanimationTrack:AdjustWeight(weight, fadeTime)\n\tlocal startTime = tick()\n\twhile math.abs(animationTrack.WeightCurrent - weight) > 0.001 do\n\t\ttask.wait()\n\tend\n\tprint(\"Time taken to change weight \" .. tostring(tick() - startTime))\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765644\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\nlocal animationTrack = animator:LoadAnimation(animation)\n\nchangeWeight(animationTrack, 0.6, 1)" }, "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal/param/1": { "documentation": "The name of the KeyframeMarker the signal is being created for. Not to be confused with the name of the Keyframe." }, "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal/return/0": { "documentation": "The signal created and fired when the animation reaches the created KeyframeMarker." }, "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal": { "documentation": "Returns an RBXScriptSignal (event) that fires when a specified KeyframeMarker has been hit in an animation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal/param/1" } ], "returns": [ "@roblox/globaltype/AnimationTrack.GetMarkerReachedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetMarkerReachedSignal", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.GetParameter/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.GetParameter/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.GetParameter/return/0": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.GetParameter": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.GetParameter/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/AnimationTrack.GetParameter/param/1" } ], "returns": [ "@roblox/globaltype/AnimationTrack.GetParameter/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameter", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.GetParameterDefaults/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.GetParameterDefaults/return/0": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.GetParameterDefaults": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.GetParameterDefaults/param/0" } ], "returns": [ "@roblox/globaltype/AnimationTrack.GetParameterDefaults/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameterDefaults", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.GetTargetInstance/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.GetTargetInstance/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.GetTargetInstance/return/0": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.GetTargetInstance": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.GetTargetInstance/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/AnimationTrack.GetTargetInstance/param/1" } ], "returns": [ "@roblox/globaltype/AnimationTrack.GetTargetInstance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetInstance", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.GetTargetNames/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.GetTargetNames/return/0": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.GetTargetNames": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.GetTargetNames/param/0" } ], "returns": [ "@roblox/globaltype/AnimationTrack.GetTargetNames/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTargetNames", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe/param/1": { "documentation": "The name associated with the Keyframe to be found." }, "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe/return/0": { "documentation": "The time, in seconds, the Keyframe occurs at normal playback speed." }, "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe": { "documentation": "Returns the time position of the first Keyframe of the given name in an AnimationTrack.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe/param/0" }, { "name": "keyframeName", "documentation": "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe/param/1" } ], "returns": [ "@roblox/globaltype/AnimationTrack.GetTimeOfKeyframe/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetTimeOfKeyframe", "code_sample": "local function jumpToKeyframe(animationTrack, keyframeName)\n\tlocal timePosition = animationTrack:GetTimeOfKeyframe(keyframeName)\n\tif not animationTrack.IsPlaying then\n\t\tanimationTrack:Play()\n\tend\n\tanimationTrack.TimePosition = timePosition\nend\n\nlocal ANIMATION_ID = 0\nlocal KEYFRAME_NAME = \"Test\"\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://\" .. ANIMATION_ID\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\nlocal animationTrack = animator:LoadAnimation(animation)\n\njumpToKeyframe(animationTrack, KEYFRAME_NAME)" }, "@roblox/globaltype/AnimationTrack.Play/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.Play/param/1": { "documentation": "The duration of time that the animation's weight should be faded in for." }, "@roblox/globaltype/AnimationTrack.Play/param/2": { "documentation": "The weight the animation is to be played at." }, "@roblox/globaltype/AnimationTrack.Play/param/3": { "documentation": "The playback speed of the animation." }, "@roblox/globaltype/AnimationTrack.Play": { "documentation": "Plays the AnimationTrack. Once called an AnimationTrack will play with the specified fadeTime, weight and speed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Play/param/0" }, { "name": "fadeTime", "documentation": "@roblox/globaltype/AnimationTrack.Play/param/1" }, { "name": "weight", "documentation": "@roblox/globaltype/AnimationTrack.Play/param/2" }, { "name": "speed", "documentation": "@roblox/globaltype/AnimationTrack.Play/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Play", "code_sample": "local function playAnimationForDuration(animationTrack, duration)\n\tlocal speed = animationTrack.Length / duration\n\tanimationTrack:Play()\n\tanimationTrack:AdjustSpeed(speed)\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765000\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\n\nlocal animationTrack = animator:LoadAnimation(animation)\n\nplayAnimationForDuration(animationTrack, 3)" }, "@roblox/globaltype/AnimationTrack.SetParameter/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.SetParameter/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.SetParameter/param/2": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.SetParameter": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.SetParameter/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/AnimationTrack.SetParameter/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/AnimationTrack.SetParameter/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetParameter", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.SetTargetInstance/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.SetTargetInstance/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.SetTargetInstance/param/2": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.SetTargetInstance": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.SetTargetInstance/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/AnimationTrack.SetTargetInstance/param/1" }, { "name": "target", "documentation": "@roblox/globaltype/AnimationTrack.SetTargetInstance/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetTargetInstance", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.Stop/param/0": { "documentation": "Controls the playback of an animation on an Animator." }, "@roblox/globaltype/AnimationTrack.Stop/param/1": { "documentation": "The time, in seconds, for which animation weight is to be faded out over." }, "@roblox/globaltype/AnimationTrack.Stop": { "documentation": "Stops the AnimationTrack.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Stop/param/0" }, { "name": "fadeTime", "documentation": "@roblox/globaltype/AnimationTrack.Stop/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Stop", "code_sample": "local function fadeOut(animationTrack, fadeTime)\n\tanimationTrack:Stop(fadeTime)\n\tlocal startTime = tick()\n\twhile animationTrack.WeightCurrent > 0 do\n\t\ttask.wait()\n\tend\n\tlocal timeTaken = tick() - startTime\n\tprint(\"Time taken for weight to reset: \" .. tostring(timeTaken))\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765644\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\nlocal animationTrack = animator:LoadAnimation(animation)\n\nanimationTrack:Play()\n\nfadeOut(animationTrack, 1)" }, "@roblox/globaltype/AnimationTrack.DidLoop.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.DidLoop.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.DidLoop.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.DidLoop.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.DidLoop.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.DidLoop.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.DidLoop.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.DidLoop.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.DidLoop.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.DidLoop.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.DidLoop.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.DidLoop.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.DidLoop": { "documentation": "Fires when an AnimationTrack loops on the next update following the end of the previous animation loop.", "keys": { "Connect": "@roblox/globaltype/AnimationTrack.DidLoop.Connect", "ConnectParallel": "@roblox/globaltype/AnimationTrack.DidLoop.ConnectParallel", "Once": "@roblox/globaltype/AnimationTrack.DidLoop.Once", "Wait": "@roblox/globaltype/AnimationTrack.DidLoop.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#DidLoop", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.Ended.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Ended.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.Ended.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Ended.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.Ended.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Ended.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Ended.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.Ended.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Ended.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.Ended.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Ended.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Ended.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.Ended.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Ended.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.Ended.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Ended.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Ended.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Ended.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Ended": { "documentation": "Fires when the AnimationTrack is completely done moving anything in the world.", "keys": { "Connect": "@roblox/globaltype/AnimationTrack.Ended.Connect", "ConnectParallel": "@roblox/globaltype/AnimationTrack.Ended.ConnectParallel", "Once": "@roblox/globaltype/AnimationTrack.Ended.Once", "Wait": "@roblox/globaltype/AnimationTrack.Ended.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Ended", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.KeyframeReached.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.KeyframeReached.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.KeyframeReached.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.KeyframeReached.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.KeyframeReached.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.KeyframeReached": { "documentation": "Fires every time playback of an AnimationTrack reaches a Keyframe that does not have the default name of Keyframe.", "keys": { "Connect": "@roblox/globaltype/AnimationTrack.KeyframeReached.Connect", "ConnectParallel": "@roblox/globaltype/AnimationTrack.KeyframeReached.ConnectParallel", "Once": "@roblox/globaltype/AnimationTrack.KeyframeReached.Once", "Wait": "@roblox/globaltype/AnimationTrack.KeyframeReached.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#KeyframeReached", "code_sample": "" }, "@roblox/globaltype/AnimationTrack.Stopped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Stopped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.Stopped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Stopped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Stopped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.Stopped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Stopped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Stopped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationTrack.Stopped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Stopped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationTrack.Stopped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationTrack.Stopped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AnimationTrack.Stopped": { "documentation": "Fires when the AnimationTrack finishes playing. The AnimationTrack might still animate the subject while the animation \"fades out\". To catch when the AnimationTrack is completely done moving anything in the world, use the AnimationTrack.Ended event.", "keys": { "Connect": "@roblox/globaltype/AnimationTrack.Stopped.Connect", "ConnectParallel": "@roblox/globaltype/AnimationTrack.Stopped.ConnectParallel", "Once": "@roblox/globaltype/AnimationTrack.Stopped.Once", "Wait": "@roblox/globaltype/AnimationTrack.Stopped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Stopped", "code_sample": "local function yieldPlayAnimation(animationTrack, fadeTime, weight, speed)\n\tanimationTrack:Play(fadeTime, weight, speed)\n\tanimationTrack.Stopped:Wait()\n\tprint(\"Animation has stopped\")\nend\n\nlocal animation = Instance.new(\"Animation\")\nanimation.AnimationId = \"rbxassetid://507765644\"\n\nlocal humanoid = script.Parent:WaitForChild(\"Humanoid\")\nlocal animator = humanoid:WaitForChild(\"Animator\")\nlocal animationTrack = animator:LoadAnimation(animation)\n\nyieldPlayAnimation(animationTrack, 1, 0.6, 1)" }, "@roblox/globaltype/RunService": { "documentation": "Service responsible for all runtime activity and progression of time.", "keys": { "ClientGitHash": "@roblox/globaltype/RunService.ClientGitHash", "RunState": "@roblox/globaltype/RunService.RunState", "BindToRenderStep": "@roblox/globaltype/RunService.BindToRenderStep", "BindToSimulation": "@roblox/globaltype/RunService.BindToSimulation", "GetPredictionStatus": "@roblox/globaltype/RunService.GetPredictionStatus", "IsClient": "@roblox/globaltype/RunService.IsClient", "IsEdit": "@roblox/globaltype/RunService.IsEdit", "IsRunMode": "@roblox/globaltype/RunService.IsRunMode", "IsRunning": "@roblox/globaltype/RunService.IsRunning", "IsServer": "@roblox/globaltype/RunService.IsServer", "IsStudio": "@roblox/globaltype/RunService.IsStudio", "Pause": "@roblox/globaltype/RunService.Pause", "Reset": "@roblox/globaltype/RunService.Reset", "Run": "@roblox/globaltype/RunService.Run", "SetPredictionMode": "@roblox/globaltype/RunService.SetPredictionMode", "Stop": "@roblox/globaltype/RunService.Stop", "UnbindFromRenderStep": "@roblox/globaltype/RunService.UnbindFromRenderStep" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService", "code_sample": "" }, "@roblox/globaltype/RunService.ClientGitHash": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#ClientGitHash", "code_sample": "" }, "@roblox/globaltype/RunService.RunState": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#RunState", "code_sample": "" }, "@roblox/globaltype/RunService.BindToRenderStep/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.BindToRenderStep/param/1": { "documentation": "Label for the binding which can be used with Unbind if the binding is no longer needed." }, "@roblox/globaltype/RunService.BindToRenderStep/param/2": { "documentation": "Priority of the binding as an integer; it determines when during the render step to call the custom function. The lower this number, the sooner the custom function will be called. If two bindings have the same priority, the engine will randomly pick one to run first." }, "@roblox/globaltype/RunService.BindToRenderStep/param/3": { "documentation": "The custom function being bound." }, "@roblox/globaltype/RunService.BindToRenderStep": { "documentation": "Given a string name of a function and a priority, this method binds the function to RunService.PreRender.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.BindToRenderStep/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/RunService.BindToRenderStep/param/1" }, { "name": "priority", "documentation": "@roblox/globaltype/RunService.BindToRenderStep/param/2" }, { "name": "function", "documentation": "@roblox/globaltype/RunService.BindToRenderStep/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#BindToRenderStep", "code_sample": "" }, "@roblox/globaltype/RunService.BindToSimulation/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.BindToSimulation/param/1": { "documentation": "The function to call. This function will be passed one parameter called deltaTime which shows how much time passed between the beginning of the previous simulation step and the beginning of the current simulation step." }, "@roblox/globaltype/RunService.BindToSimulation/param/2": { "documentation": "Optional StepFrequency value indicating the frequency at which to call the bound function. If not provided, the default frequency will be used." }, "@roblox/globaltype/RunService.BindToSimulation/return/0": { "documentation": "" }, "@roblox/globaltype/RunService.BindToSimulation": { "documentation": "Binds a custom function to be called at a fixed frequency which is independent of the frame rate.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.BindToSimulation/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/RunService.BindToSimulation/param/1" }, { "name": "frequency", "documentation": "@roblox/globaltype/RunService.BindToSimulation/param/2" } ], "returns": [ "@roblox/globaltype/RunService.BindToSimulation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#BindToSimulation", "code_sample": "local RunService = game:GetService(\"RunService\")\nlocal Workspace = game:GetService(\"Workspace\")\n\nlocal somePart:BasePart = Workspace:WaitForChild(\"Part\")\n\nRunService:BindToSimulation(function(deltaTime: number)\n\tlocal syncdColor = Color3.fromHSV(math.fmod(time(), 1.0), 1.0, 1.0)\n\tsomePart:SetAttribute(\"SyncdColor\", syncdColor)\nend)\n\nRunService.RenderStepped:Connect(function(deltaTime: number) \n\tlocal syncdColor = somePart:GetAttribute(\"SyncdColor\")\n\tsomePart.Color = syncdColor\nend)" }, "@roblox/globaltype/RunService.GetPredictionStatus/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.GetPredictionStatus/param/1": { "documentation": "The Instance for which to check prediction status." }, "@roblox/globaltype/RunService.GetPredictionStatus/return/0": { "documentation": "" }, "@roblox/globaltype/RunService.GetPredictionStatus": { "documentation": "Checks the PredictionStatus of a specific context instance, useful for debugging scripts affecting multiple instances where some might be predicted and others might not.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.GetPredictionStatus/param/0" }, { "name": "context", "documentation": "@roblox/globaltype/RunService.GetPredictionStatus/param/1" } ], "returns": [ "@roblox/globaltype/RunService.GetPredictionStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#GetPredictionStatus", "code_sample": "" }, "@roblox/globaltype/RunService.IsClient/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.IsClient/return/0": { "documentation": "Whether the current environment is running the client." }, "@roblox/globaltype/RunService.IsClient": { "documentation": "Returns whether the current environment is running on the client.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.IsClient/param/0" } ], "returns": [ "@roblox/globaltype/RunService.IsClient/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#IsClient", "code_sample": "" }, "@roblox/globaltype/RunService.IsEdit/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.IsEdit/return/0": { "documentation": "Whether the current environment is in \"edit\" mode." }, "@roblox/globaltype/RunService.IsEdit": { "documentation": "Returns whether the current environment is in Edit mode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.IsEdit/param/0" } ], "returns": [ "@roblox/globaltype/RunService.IsEdit/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#IsEdit", "code_sample": "" }, "@roblox/globaltype/RunService.IsRunMode/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.IsRunMode/return/0": { "documentation": "Whether a Run playtest has been initiated in Studio." }, "@roblox/globaltype/RunService.IsRunMode": { "documentation": "Returns whether a Run playtest has been initiated in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.IsRunMode/param/0" } ], "returns": [ "@roblox/globaltype/RunService.IsRunMode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#IsRunMode", "code_sample": "" }, "@roblox/globaltype/RunService.IsRunning/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.IsRunning/return/0": { "documentation": "Whether the experience is currently running." }, "@roblox/globaltype/RunService.IsRunning": { "documentation": "Returns whether the experience is currently running.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.IsRunning/param/0" } ], "returns": [ "@roblox/globaltype/RunService.IsRunning/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#IsRunning", "code_sample": "" }, "@roblox/globaltype/RunService.IsServer/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.IsServer/return/0": { "documentation": "Whether the current environment is running on the server." }, "@roblox/globaltype/RunService.IsServer": { "documentation": "Returns whether the current environment is running on the server.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.IsServer/param/0" } ], "returns": [ "@roblox/globaltype/RunService.IsServer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#IsServer", "code_sample": "" }, "@roblox/globaltype/RunService.IsStudio/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.IsStudio/return/0": { "documentation": "Whether the current environment is running in Studio." }, "@roblox/globaltype/RunService.IsStudio": { "documentation": "Returns whether the current environment is running in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.IsStudio/param/0" } ], "returns": [ "@roblox/globaltype/RunService.IsStudio/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#IsStudio", "code_sample": "" }, "@roblox/globaltype/RunService.Pause/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.Pause": { "documentation": "Pauses the experience's simulation if it is running, suspending physics and scripts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#Pause", "code_sample": "" }, "@roblox/globaltype/RunService.Reset/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.Reset": { "documentation": "Deprecated: This item is deprecated and should not be used in new work.
Resets the current game to a waypoint set when RunService:Run() was called.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Reset/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#Reset", "code_sample": "" }, "@roblox/globaltype/RunService.Run/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.Run": { "documentation": "Runs the game's simulation, running physics and scripts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Run/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#Run", "code_sample": "" }, "@roblox/globaltype/RunService.SetPredictionMode/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.SetPredictionMode/param/1": { "documentation": "The Instance for which to set the prediction mode." }, "@roblox/globaltype/RunService.SetPredictionMode/param/2": { "documentation": "The PredictionMode to set for the context instance." }, "@roblox/globaltype/RunService.SetPredictionMode": { "documentation": "Sets the prediction mode for an Instance to an PredictionMode value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.SetPredictionMode/param/0" }, { "name": "context", "documentation": "@roblox/globaltype/RunService.SetPredictionMode/param/1" }, { "name": "mode", "documentation": "@roblox/globaltype/RunService.SetPredictionMode/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#SetPredictionMode", "code_sample": "" }, "@roblox/globaltype/RunService.Stop/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.Stop": { "documentation": "Stops the experience's simulation if it is running.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Stop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#Stop", "code_sample": "" }, "@roblox/globaltype/RunService.UnbindFromRenderStep/param/0": { "documentation": "Service responsible for all runtime activity and progression of time." }, "@roblox/globaltype/RunService.UnbindFromRenderStep/param/1": { "documentation": "The name of the function being unbound." }, "@roblox/globaltype/RunService.UnbindFromRenderStep": { "documentation": "Unbinds a function that was bound to the render loop using RunService:BindToRenderStep().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.UnbindFromRenderStep/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/RunService.UnbindFromRenderStep/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#UnbindFromRenderStep", "code_sample": "" }, "@roblox/globaltype/RunService.Heartbeat.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Heartbeat.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.Heartbeat.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Heartbeat.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.Heartbeat.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.Heartbeat.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Heartbeat.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.Heartbeat.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Heartbeat.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.Heartbeat.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.Heartbeat.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Heartbeat.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.Heartbeat.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Heartbeat.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.Heartbeat.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.Heartbeat.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Heartbeat.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Heartbeat.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.Heartbeat": { "documentation": "Fires every frame, after the physics simulation has completed.", "keys": { "Connect": "@roblox/globaltype/RunService.Heartbeat.Connect", "ConnectParallel": "@roblox/globaltype/RunService.Heartbeat.ConnectParallel", "Once": "@roblox/globaltype/RunService.Heartbeat.Once", "Wait": "@roblox/globaltype/RunService.Heartbeat.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#Heartbeat", "code_sample": "" }, "@roblox/globaltype/RunService.PostSimulation.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PostSimulation.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PostSimulation.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PostSimulation.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PostSimulation.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PostSimulation.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PostSimulation.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PostSimulation.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PostSimulation.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PostSimulation.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PostSimulation.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PostSimulation.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PostSimulation.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PostSimulation.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PostSimulation.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PostSimulation.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PostSimulation.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PostSimulation.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.PostSimulation": { "documentation": "Fires every frame, after the physics simulation has completed.", "keys": { "Connect": "@roblox/globaltype/RunService.PostSimulation.Connect", "ConnectParallel": "@roblox/globaltype/RunService.PostSimulation.ConnectParallel", "Once": "@roblox/globaltype/RunService.PostSimulation.Once", "Wait": "@roblox/globaltype/RunService.PostSimulation.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#PostSimulation", "code_sample": "" }, "@roblox/globaltype/RunService.PreAnimation.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreAnimation.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreAnimation.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreAnimation.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreAnimation.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreAnimation.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreAnimation.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreAnimation.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreAnimation.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreAnimation.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreAnimation.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreAnimation.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreAnimation.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreAnimation.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreAnimation.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreAnimation.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreAnimation.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreAnimation.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.PreAnimation": { "documentation": "Fires every frame, prior to the physics simulation but after rendering.", "keys": { "Connect": "@roblox/globaltype/RunService.PreAnimation.Connect", "ConnectParallel": "@roblox/globaltype/RunService.PreAnimation.ConnectParallel", "Once": "@roblox/globaltype/RunService.PreAnimation.Once", "Wait": "@roblox/globaltype/RunService.PreAnimation.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#PreAnimation", "code_sample": "" }, "@roblox/globaltype/RunService.PreRender.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreRender.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreRender.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreRender.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreRender.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreRender.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreRender.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreRender.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreRender.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreRender.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreRender.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreRender.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreRender.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreRender.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreRender.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreRender.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreRender.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreRender.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.PreRender": { "documentation": "Fires every frame, prior to the frame being rendered.", "keys": { "Connect": "@roblox/globaltype/RunService.PreRender.Connect", "ConnectParallel": "@roblox/globaltype/RunService.PreRender.ConnectParallel", "Once": "@roblox/globaltype/RunService.PreRender.Once", "Wait": "@roblox/globaltype/RunService.PreRender.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#PreRender", "code_sample": "" }, "@roblox/globaltype/RunService.PreSimulation.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreSimulation.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreSimulation.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreSimulation.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreSimulation.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreSimulation.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreSimulation.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreSimulation.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreSimulation.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreSimulation.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreSimulation.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreSimulation.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.PreSimulation.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreSimulation.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.PreSimulation.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.PreSimulation.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.PreSimulation.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.PreSimulation.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.PreSimulation": { "documentation": "Fires every frame, prior to the physics simulation.", "keys": { "Connect": "@roblox/globaltype/RunService.PreSimulation.Connect", "ConnectParallel": "@roblox/globaltype/RunService.PreSimulation.ConnectParallel", "Once": "@roblox/globaltype/RunService.PreSimulation.Once", "Wait": "@roblox/globaltype/RunService.PreSimulation.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#PreSimulation", "code_sample": "" }, "@roblox/globaltype/RunService.RenderStepped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.RenderStepped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.RenderStepped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.RenderStepped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.RenderStepped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.RenderStepped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.RenderStepped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.RenderStepped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.RenderStepped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.RenderStepped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.RenderStepped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.RenderStepped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.RenderStepped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.RenderStepped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.RenderStepped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.RenderStepped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.RenderStepped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.RenderStepped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.RenderStepped": { "documentation": "Fires every frame, prior to the frame being rendered.", "keys": { "Connect": "@roblox/globaltype/RunService.RenderStepped.Connect", "ConnectParallel": "@roblox/globaltype/RunService.RenderStepped.ConnectParallel", "Once": "@roblox/globaltype/RunService.RenderStepped.Once", "Wait": "@roblox/globaltype/RunService.RenderStepped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#RenderStepped", "code_sample": "" }, "@roblox/globaltype/RunService.Stepped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Stepped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.Stepped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Stepped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.Stepped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.Stepped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Stepped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.Stepped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Stepped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.Stepped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.Stepped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Stepped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RunService.Stepped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Stepped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RunService.Stepped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RunService.Stepped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RunService.Stepped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RunService.Stepped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RunService.Stepped": { "documentation": "Fires every frame, prior to the physics simulation.", "keys": { "Connect": "@roblox/globaltype/RunService.Stepped.Connect", "ConnectParallel": "@roblox/globaltype/RunService.Stepped.ConnectParallel", "Once": "@roblox/globaltype/RunService.Stepped.Once", "Wait": "@roblox/globaltype/RunService.Stepped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunService#Stepped", "code_sample": "" }, "@roblox/globaltype/ConfigService": { "documentation": "A game service that gives access to in-experience configuration with updates in real time.", "keys": { "ClearTestingValue": "@roblox/globaltype/ConfigService.ClearTestingValue", "GetConfigAsync": "@roblox/globaltype/ConfigService.GetConfigAsync", "GetConfigForPlayerAsync": "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync", "SetTestingValue": "@roblox/globaltype/ConfigService.SetTestingValue" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigService", "code_sample": "" }, "@roblox/globaltype/ConfigService.ClearTestingValue/param/0": { "documentation": "A game service that gives access to in-experience configuration with updates in real time." }, "@roblox/globaltype/ConfigService.ClearTestingValue/param/1": { "documentation": "Key of the configuration to clear testing value for." }, "@roblox/globaltype/ConfigService.ClearTestingValue": { "documentation": "Clears current testing value for the given key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigService.ClearTestingValue/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/ConfigService.ClearTestingValue/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigService#ClearTestingValue", "code_sample": "" }, "@roblox/globaltype/ConfigService.GetConfigAsync/param/0": { "documentation": "A game service that gives access to in-experience configuration with updates in real time." }, "@roblox/globaltype/ConfigService.GetConfigAsync/return/0": { "documentation": "A ConfigSnapshot instance with the latest configuration." }, "@roblox/globaltype/ConfigService.GetConfigAsync": { "documentation": "Retrieves a snapshot of the latest configuration.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigService.GetConfigAsync/param/0" } ], "returns": [ "@roblox/globaltype/ConfigService.GetConfigAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync", "code_sample": "" }, "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync/param/0": { "documentation": "A game service that gives access to in-experience configuration with updates in real time." }, "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync/param/1": { "documentation": "The player to get the configuration for." }, "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync/return/0": { "documentation": "A ConfigSnapshot instance with the latest configuration targeted to the player." }, "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync": { "documentation": "Retrieves a snapshot of the latest configuration for a specific player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync/param/1" } ], "returns": [ "@roblox/globaltype/ConfigService.GetConfigForPlayerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync", "code_sample": "" }, "@roblox/globaltype/ConfigService.SetTestingValue/param/0": { "documentation": "A game service that gives access to in-experience configuration with updates in real time." }, "@roblox/globaltype/ConfigService.SetTestingValue/param/1": { "documentation": "Key of the configuration to override with a testing value." }, "@roblox/globaltype/ConfigService.SetTestingValue/param/2": { "documentation": "Value to set as the testing override." }, "@roblox/globaltype/ConfigService.SetTestingValue": { "documentation": "Sets a testing override for the given key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ConfigService.SetTestingValue/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/ConfigService.SetTestingValue/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/ConfigService.SetTestingValue/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigService#SetTestingValue", "code_sample": "" }, "@roblox/globaltype/TouchTransmitter": { "documentation": "An internal object used by networking and replication code to transmit BasePart.Touched and BasePart.TouchEnded events.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TouchTransmitter", "code_sample": "" }, "@roblox/globaltype/FriendService": { "documentation": "An internal service which is used to send, cancel, accept and decline connection requests in-game.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FriendService", "code_sample": "" }, "@roblox/globaltype/ClientReplicator": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ClientReplicator", "code_sample": "" }, "@roblox/globaltype/PVInstance": { "documentation": "Abstract class for all objects that have a physical location in the world.", "keys": { "Origin": "@roblox/globaltype/PVInstance.Origin", "Pivot Offset": "@roblox/globaltype/PVInstance.Pivot Offset", "GetPivot": "@roblox/globaltype/PVInstance.GetPivot", "PivotTo": "@roblox/globaltype/PVInstance.PivotTo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVInstance", "code_sample": "" }, "@roblox/globaltype/PVInstance.Origin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVInstance#Origin", "code_sample": "" }, "@roblox/globaltype/PVInstance.Pivot Offset": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVInstance#Pivot Offset", "code_sample": "" }, "@roblox/globaltype/PVInstance.GetPivot/param/0": { "documentation": "Abstract class for all objects that have a physical location in the world." }, "@roblox/globaltype/PVInstance.GetPivot/return/0": { "documentation": "" }, "@roblox/globaltype/PVInstance.GetPivot": { "documentation": "Gets the pivot of a PVInstance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PVInstance.GetPivot/param/0" } ], "returns": [ "@roblox/globaltype/PVInstance.GetPivot/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVInstance#GetPivot", "code_sample": "" }, "@roblox/globaltype/PVInstance.PivotTo/param/0": { "documentation": "Abstract class for all objects that have a physical location in the world." }, "@roblox/globaltype/PVInstance.PivotTo/param/1": { "documentation": "The CFrame that the PVInstance pivot should equal after moving it." }, "@roblox/globaltype/PVInstance.PivotTo": { "documentation": "Transforms the PVInstance along with all of its descendant PVInstances such that the pivot is now located at the specified CFrame.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PVInstance.PivotTo/param/0" }, { "name": "targetCFrame", "documentation": "@roblox/globaltype/PVInstance.PivotTo/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PVInstance#PivotTo", "code_sample": "" }, "@roblox/globaltype/Instance": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.", "keys": { "Archivable": "@roblox/globaltype/Instance.Archivable", "archivable": "@roblox/globaltype/Instance.archivable", "Capabilities": "@roblox/globaltype/Instance.Capabilities", "Name": "@roblox/globaltype/Instance.Name", "Parent": "@roblox/globaltype/Instance.Parent", "PredictionMode": "@roblox/globaltype/Instance.PredictionMode", "RobloxLocked": "@roblox/globaltype/Instance.RobloxLocked", "Sandboxed": "@roblox/globaltype/Instance.Sandboxed", "UniqueId": "@roblox/globaltype/Instance.UniqueId", "AddTag": "@roblox/globaltype/Instance.AddTag", "children": "@roblox/globaltype/Instance.children", "ClearAllChildren": "@roblox/globaltype/Instance.ClearAllChildren", "Clone": "@roblox/globaltype/Instance.Clone", "clone": "@roblox/globaltype/Instance.clone", "Destroy": "@roblox/globaltype/Instance.Destroy", "destroy": "@roblox/globaltype/Instance.destroy", "FindFirstAncestor": "@roblox/globaltype/Instance.FindFirstAncestor", "FindFirstAncestorOfClass": "@roblox/globaltype/Instance.FindFirstAncestorOfClass", "FindFirstAncestorWhichIsA": "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA", "FindFirstChild": "@roblox/globaltype/Instance.FindFirstChild", "findFirstChild": "@roblox/globaltype/Instance.findFirstChild", "FindFirstChildOfClass": "@roblox/globaltype/Instance.FindFirstChildOfClass", "FindFirstChildWhichIsA": "@roblox/globaltype/Instance.FindFirstChildWhichIsA", "FindFirstDescendant": "@roblox/globaltype/Instance.FindFirstDescendant", "GetActor": "@roblox/globaltype/Instance.GetActor", "GetAttribute": "@roblox/globaltype/Instance.GetAttribute", "GetAttributeChangedSignal": "@roblox/globaltype/Instance.GetAttributeChangedSignal", "GetAttributes": "@roblox/globaltype/Instance.GetAttributes", "GetChildren": "@roblox/globaltype/Instance.GetChildren", "getChildren": "@roblox/globaltype/Instance.getChildren", "GetDebugId": "@roblox/globaltype/Instance.GetDebugId", "GetDescendants": "@roblox/globaltype/Instance.GetDescendants", "GetFullName": "@roblox/globaltype/Instance.GetFullName", "GetStyled": "@roblox/globaltype/Instance.GetStyled", "GetStyledPropertyChangedSignal": "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal", "GetTags": "@roblox/globaltype/Instance.GetTags", "HasTag": "@roblox/globaltype/Instance.HasTag", "IsAncestorOf": "@roblox/globaltype/Instance.IsAncestorOf", "IsDescendantOf": "@roblox/globaltype/Instance.IsDescendantOf", "isDescendantOf": "@roblox/globaltype/Instance.isDescendantOf", "IsPropertyModified": "@roblox/globaltype/Instance.IsPropertyModified", "QueryDescendants": "@roblox/globaltype/Instance.QueryDescendants", "Remove": "@roblox/globaltype/Instance.Remove", "remove": "@roblox/globaltype/Instance.remove", "RemoveTag": "@roblox/globaltype/Instance.RemoveTag", "ResetPropertyToDefault": "@roblox/globaltype/Instance.ResetPropertyToDefault", "SetAttribute": "@roblox/globaltype/Instance.SetAttribute", "WaitForChild": "@roblox/globaltype/Instance.WaitForChild" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance", "code_sample": "" }, "@roblox/globaltype/Instance.Archivable": { "documentation": "Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Archivable", "code_sample": "" }, "@roblox/globaltype/Instance.archivable": { "documentation": "Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#archivable", "code_sample": "" }, "@roblox/globaltype/Instance.Capabilities": { "documentation": "The set of capabilities allowed to be used for scripts inside this container.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Capabilities", "code_sample": "" }, "@roblox/globaltype/Instance.Name": { "documentation": "A non-unique identifier of the Instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Name", "code_sample": "" }, "@roblox/globaltype/Instance.Parent": { "documentation": "Determines the hierarchical parent of the Instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Parent", "code_sample": "" }, "@roblox/globaltype/Instance.PredictionMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#PredictionMode", "code_sample": "" }, "@roblox/globaltype/Instance.RobloxLocked": { "documentation": "A deprecated property that used to protect CoreGui objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#RobloxLocked", "code_sample": "" }, "@roblox/globaltype/Instance.Sandboxed": { "documentation": "Turns the instance to be a sandboxed container.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Sandboxed", "code_sample": "" }, "@roblox/globaltype/Instance.UniqueId": { "documentation": "A unique identifier for the instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#UniqueId", "code_sample": "" }, "@roblox/globaltype/Instance.AddTag/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.AddTag/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AddTag": { "documentation": "Applies a tag to the instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AddTag/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/Instance.AddTag/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#AddTag", "code_sample": "" }, "@roblox/globaltype/Instance.children/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.children/return/0": { "documentation": "Array of child objects/instances." }, "@roblox/globaltype/Instance.children": { "documentation": "Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.children/param/0" } ], "returns": [ "@roblox/globaltype/Instance.children/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#children", "code_sample": "" }, "@roblox/globaltype/Instance.ClearAllChildren/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.ClearAllChildren": { "documentation": "This method destroys all of an instance's children.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ClearAllChildren/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#ClearAllChildren", "code_sample": "" }, "@roblox/globaltype/Instance.Clone/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.Clone/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.Clone": { "documentation": "Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Clone/param/0" } ], "returns": [ "@roblox/globaltype/Instance.Clone/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Clone", "code_sample": "local Workspace = game:GetService(\"Workspace\")\n\n-- Get a reference to an existing object\nlocal model = script.Parent.Model\n\n-- Create a clone of the model\nlocal clone = model:Clone()\n\n-- Move the clone so it's not overlapping the original model\nclone:PivotTo(model.PrimaryPart.CFrame - (Vector3.xAxis * 10))\n\n-- Add the clone to the Workspace\nclone.Parent = Workspace" }, "@roblox/globaltype/Instance.clone/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.clone/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.clone": { "documentation": "Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.clone/param/0" } ], "returns": [ "@roblox/globaltype/Instance.clone/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#clone", "code_sample": "" }, "@roblox/globaltype/Instance.Destroy/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.Destroy": { "documentation": "Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Destroy/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Destroy", "code_sample": "local part = script.Parent.Part\n\npart:Destroy()" }, "@roblox/globaltype/Instance.destroy/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.destroy": { "documentation": "Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.destroy/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#destroy", "code_sample": "" }, "@roblox/globaltype/Instance.FindFirstAncestor/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstAncestor/param/1": { "documentation": "The Instance.Name to be looked for." }, "@roblox/globaltype/Instance.FindFirstAncestor/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstAncestor": { "documentation": "Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstAncestor/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/Instance.FindFirstAncestor/param/1" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstAncestor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstAncestor", "code_sample": "" }, "@roblox/globaltype/Instance.FindFirstAncestorOfClass/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstAncestorOfClass/param/1": { "documentation": "The Object.ClassName to be looked for." }, "@roblox/globaltype/Instance.FindFirstAncestorOfClass/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstAncestorOfClass": { "documentation": "Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstAncestorOfClass/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/Instance.FindFirstAncestorOfClass/param/1" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstAncestorOfClass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstAncestorOfClass", "code_sample": "" }, "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA/param/1": { "documentation": "The Object.ClassName to be looked for." }, "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA": { "documentation": "Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA/param/1" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstAncestorWhichIsA/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstAncestorWhichIsA", "code_sample": "" }, "@roblox/globaltype/Instance.FindFirstChild/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstChild/param/1": { "documentation": "The Instance.Name to be searched for." }, "@roblox/globaltype/Instance.FindFirstChild/param/2": { "documentation": "Whether or not the search should be conducted recursively." }, "@roblox/globaltype/Instance.FindFirstChild/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstChild": { "documentation": "Returns the first child of the Instance found with the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstChild/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/Instance.FindFirstChild/param/1" }, { "name": "recursive", "documentation": "@roblox/globaltype/Instance.FindFirstChild/param/2" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstChild/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstChild", "code_sample": "local found = workspace:FindFirstChild(\"Brick\")\n\nif found then\n\tfound.Name = \"Foo\"\nend" }, "@roblox/globaltype/Instance.findFirstChild/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.findFirstChild/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.findFirstChild/param/2": { "documentation": "" }, "@roblox/globaltype/Instance.findFirstChild/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.findFirstChild": { "documentation": "Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.findFirstChild/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/Instance.findFirstChild/param/1" }, { "name": "recursive", "documentation": "@roblox/globaltype/Instance.findFirstChild/param/2" } ], "returns": [ "@roblox/globaltype/Instance.findFirstChild/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#findFirstChild", "code_sample": "" }, "@roblox/globaltype/Instance.FindFirstChildOfClass/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstChildOfClass/param/1": { "documentation": "The Object.ClassName to be looked for." }, "@roblox/globaltype/Instance.FindFirstChildOfClass/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstChildOfClass": { "documentation": "Returns the first child of the Instance whose ClassName is equal to the given class name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstChildOfClass/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/Instance.FindFirstChildOfClass/param/1" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstChildOfClass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstChildOfClass", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\n\nlocal humanoid\n\nwhile not humanoid do\n\thumanoid = character:FindFirstChildOfClass(\"Humanoid\")\n\tif not humanoid then\n\t\tcharacter.ChildAdded:Wait()\n\tend\nend" }, "@roblox/globaltype/Instance.FindFirstChildWhichIsA/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstChildWhichIsA/param/1": { "documentation": "The Object.ClassName to be searched for." }, "@roblox/globaltype/Instance.FindFirstChildWhichIsA/param/2": { "documentation": "Whether or not the search should be conducted recursively." }, "@roblox/globaltype/Instance.FindFirstChildWhichIsA/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstChildWhichIsA": { "documentation": "Returns the first child of the Instance for whom Object:IsA() returns true for the given className.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstChildWhichIsA/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/Instance.FindFirstChildWhichIsA/param/1" }, { "name": "recursive", "documentation": "@roblox/globaltype/Instance.FindFirstChildWhichIsA/param/2" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstChildWhichIsA/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstChildWhichIsA", "code_sample": "" }, "@roblox/globaltype/Instance.FindFirstDescendant/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.FindFirstDescendant/param/1": { "documentation": "The Instance.Name to search for." }, "@roblox/globaltype/Instance.FindFirstDescendant/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.FindFirstDescendant": { "documentation": "Returns the first descendant found with the given Instance.Name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.FindFirstDescendant/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/Instance.FindFirstDescendant/param/1" } ], "returns": [ "@roblox/globaltype/Instance.FindFirstDescendant/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#FindFirstDescendant", "code_sample": "" }, "@roblox/globaltype/Instance.GetActor/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetActor/return/0": { "documentation": "The Actor found." }, "@roblox/globaltype/Instance.GetActor": { "documentation": "Returns the Actor associated with the Instance, if any.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetActor/param/0" } ], "returns": [ "@roblox/globaltype/Instance.GetActor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetActor", "code_sample": "" }, "@roblox/globaltype/Instance.GetAttribute/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetAttribute/param/1": { "documentation": "The name of the attribute being retrieved." }, "@roblox/globaltype/Instance.GetAttribute/return/0": { "documentation": "The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned." }, "@roblox/globaltype/Instance.GetAttribute": { "documentation": "Returns the value which has been assigned to the given attribute name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetAttribute/param/0" }, { "name": "attribute", "documentation": "@roblox/globaltype/Instance.GetAttribute/param/1" } ], "returns": [ "@roblox/globaltype/Instance.GetAttribute/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetAttribute", "code_sample": "" }, "@roblox/globaltype/Instance.GetAttributeChangedSignal/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetAttributeChangedSignal/param/1": { "documentation": "The name of the specified attribute for which the change signal is being returned." }, "@roblox/globaltype/Instance.GetAttributeChangedSignal/return/0": { "documentation": "An event that fires when the given attribute changes." }, "@roblox/globaltype/Instance.GetAttributeChangedSignal": { "documentation": "Returns an event that fires when the given attribute changes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetAttributeChangedSignal/param/0" }, { "name": "attribute", "documentation": "@roblox/globaltype/Instance.GetAttributeChangedSignal/param/1" } ], "returns": [ "@roblox/globaltype/Instance.GetAttributeChangedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetAttributeChangedSignal", "code_sample": "" }, "@roblox/globaltype/Instance.GetAttributes/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetAttributes/return/0": { "documentation": "A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value." }, "@roblox/globaltype/Instance.GetAttributes": { "documentation": "Returns a dictionary of the instance's attributes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetAttributes/param/0" } ], "returns": [ "@roblox/globaltype/Instance.GetAttributes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetAttributes", "code_sample": "" }, "@roblox/globaltype/Instance.GetChildren/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetChildren/return/0": { "documentation": "An array containing the instance's children." }, "@roblox/globaltype/Instance.GetChildren": { "documentation": "Returns an array containing all of the instance's children.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetChildren/param/0" } ], "returns": [ "@roblox/globaltype/Instance.GetChildren/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetChildren", "code_sample": "local children = workspace:GetChildren()\n\nfor i = 1, #children do\n\tprint(i, children[i].Name)\nend" }, "@roblox/globaltype/Instance.getChildren/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.getChildren/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.getChildren": { "documentation": "Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.getChildren/param/0" } ], "returns": [ "@roblox/globaltype/Instance.getChildren/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#getChildren", "code_sample": "" }, "@roblox/globaltype/Instance.GetDebugId/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetDebugId/param/1": { "documentation": "The scope length." }, "@roblox/globaltype/Instance.GetDebugId/return/0": { "documentation": "The Debug ID string." }, "@roblox/globaltype/Instance.GetDebugId": { "documentation": "Returns a coded string of the debug ID used internally by Roblox.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetDebugId/param/0" }, { "name": "scopeLength", "documentation": "@roblox/globaltype/Instance.GetDebugId/param/1" } ], "returns": [ "@roblox/globaltype/Instance.GetDebugId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetDebugId", "code_sample": "print(workspace:GetDebugId()) --> 39FA_12\nprint(workspace:GetDebugId(10)) --> 39FA2FEF4D_12\nprint(workspace:GetDebugId(math.huge)) --> 12" }, "@roblox/globaltype/Instance.GetDescendants/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetDescendants/return/0": { "documentation": "An array containing the instance's descendants." }, "@roblox/globaltype/Instance.GetDescendants": { "documentation": "Returns an array containing all of the descendants of the instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetDescendants/param/0" } ], "returns": [ "@roblox/globaltype/Instance.GetDescendants/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetDescendants", "code_sample": "local descendants = workspace:GetDescendants()\n\n-- Loop through all of the descendants of the Workspace. If a\n-- BasePart is found, the code changes that parts color to green\nfor _, descendant in pairs(descendants) do\n\tif descendant:IsA(\"BasePart\") then\n\t\tdescendant.BrickColor = BrickColor.Green()\n\tend\nend" }, "@roblox/globaltype/Instance.GetFullName/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetFullName/return/0": { "documentation": "The full name of the Instance." }, "@roblox/globaltype/Instance.GetFullName": { "documentation": "Returns a string describing the instance's ancestry.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetFullName/param/0" } ], "returns": [ "@roblox/globaltype/Instance.GetFullName/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetFullName", "code_sample": "-- Create a simple hierarchy\nlocal model = Instance.new(\"Model\")\nlocal part = Instance.new(\"Part\")\npart.Parent = model\nlocal fire = Instance.new(\"Fire\")\nfire.Parent = part\n\nprint(fire:GetFullName()) --> Model.Part.Fire\n\nmodel.Parent = workspace\n\nprint(fire:GetFullName()) --> Workspace.Model.Part.Fire\n\npart.Name = \"Hello, world\"\n\nprint(fire:GetFullName()) --> Workspace.Model.Hello, world.Fire" }, "@roblox/globaltype/Instance.GetStyled/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetStyled/param/1": { "documentation": "Name of the property to query." }, "@roblox/globaltype/Instance.GetStyled/param/2": { "documentation": "Optional selector for the pseudo instance you are targeting on the instance." }, "@roblox/globaltype/Instance.GetStyled/return/0": { "documentation": "The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified." }, "@roblox/globaltype/Instance.GetStyled": { "documentation": "Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetStyled/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/Instance.GetStyled/param/1" }, { "name": "selector", "documentation": "@roblox/globaltype/Instance.GetStyled/param/2" } ], "returns": [ "@roblox/globaltype/Instance.GetStyled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetStyled", "code_sample": "" }, "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal/param/1": { "documentation": "Name of the style property for which to listen for changes." }, "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal/return/0": { "documentation": "Event that fires when the given style property changes." }, "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal/param/0" }, { "name": "property", "documentation": "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal/param/1" } ], "returns": [ "@roblox/globaltype/Instance.GetStyledPropertyChangedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetStyledPropertyChangedSignal", "code_sample": "" }, "@roblox/globaltype/Instance.GetTags/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.GetTags/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.GetTags": { "documentation": "Gets an array of all tags applied to the instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.GetTags/param/0" } ], "returns": [ "@roblox/globaltype/Instance.GetTags/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#GetTags", "code_sample": "" }, "@roblox/globaltype/Instance.HasTag/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.HasTag/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.HasTag/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.HasTag": { "documentation": "Check whether the instance has a given tag.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.HasTag/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/Instance.HasTag/param/1" } ], "returns": [ "@roblox/globaltype/Instance.HasTag/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#HasTag", "code_sample": "" }, "@roblox/globaltype/Instance.IsAncestorOf/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.IsAncestorOf/param/1": { "documentation": "The descendant Instance." }, "@roblox/globaltype/Instance.IsAncestorOf/return/0": { "documentation": "True if the Instance is an ancestor of the given descendant." }, "@roblox/globaltype/Instance.IsAncestorOf": { "documentation": "Returns true if an Instance is an ancestor of the given descendant.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.IsAncestorOf/param/0" }, { "name": "descendant", "documentation": "@roblox/globaltype/Instance.IsAncestorOf/param/1" } ], "returns": [ "@roblox/globaltype/Instance.IsAncestorOf/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#IsAncestorOf", "code_sample": "local Workspace = game:GetService(\"Workspace\")\nlocal spawnLocation = Workspace.SpawnLocation\nlocal decal = spawnLocation.Decal\n\n-- These statements are true\nprint(Workspace:IsAncestorOf(spawnLocation))\nprint(Workspace:IsAncestorOf(decal))\nprint(spawnLocation:IsAncestorOf(decal))\n\n-- These statements are false\nprint(spawnLocation:IsAncestorOf(Workspace))\nprint(decal:IsAncestorOf(Workspace))\nprint(decal:IsAncestorOf(spawnLocation))" }, "@roblox/globaltype/Instance.IsDescendantOf/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.IsDescendantOf/param/1": { "documentation": "The ancestor Instance." }, "@roblox/globaltype/Instance.IsDescendantOf/return/0": { "documentation": "True if the Instance is a descendant of the given ancestor." }, "@roblox/globaltype/Instance.IsDescendantOf": { "documentation": "Returns true if an Instance is a descendant of the given ancestor.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.IsDescendantOf/param/0" }, { "name": "ancestor", "documentation": "@roblox/globaltype/Instance.IsDescendantOf/param/1" } ], "returns": [ "@roblox/globaltype/Instance.IsDescendantOf/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#IsDescendantOf", "code_sample": "local part = Instance.new(\"Part\")\nprint(part:IsDescendantOf(game))\n--> false\n\npart.Parent = workspace\nprint(part:IsDescendantOf(game))\n--> true\n\npart.Parent = game\nprint(part:IsDescendantOf(game))\n--> true" }, "@roblox/globaltype/Instance.isDescendantOf/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.isDescendantOf/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.isDescendantOf/return/0": { "documentation": "" }, "@roblox/globaltype/Instance.isDescendantOf": { "documentation": "Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.isDescendantOf/param/0" }, { "name": "ancestor", "documentation": "@roblox/globaltype/Instance.isDescendantOf/param/1" } ], "returns": [ "@roblox/globaltype/Instance.isDescendantOf/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#isDescendantOf", "code_sample": "" }, "@roblox/globaltype/Instance.IsPropertyModified/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.IsPropertyModified/param/1": { "documentation": "Name of the property to query." }, "@roblox/globaltype/Instance.IsPropertyModified/return/0": { "documentation": "Boolean indicating whether the property is modified from its code‑instantiated default." }, "@roblox/globaltype/Instance.IsPropertyModified": { "documentation": "Returns true if the value stored in the specified property is not equal to the code-instantiated default.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.IsPropertyModified/param/0" }, { "name": "property", "documentation": "@roblox/globaltype/Instance.IsPropertyModified/param/1" } ], "returns": [ "@roblox/globaltype/Instance.IsPropertyModified/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#IsPropertyModified", "code_sample": "" }, "@roblox/globaltype/Instance.QueryDescendants/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.QueryDescendants/param/1": { "documentation": "Selector string used to filter elements." }, "@roblox/globaltype/Instance.QueryDescendants/return/0": { "documentation": "An array of instances (empty if nothing matched the selector)." }, "@roblox/globaltype/Instance.QueryDescendants": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.QueryDescendants/param/0" }, { "name": "selector", "documentation": "@roblox/globaltype/Instance.QueryDescendants/param/1" } ], "returns": [ "@roblox/globaltype/Instance.QueryDescendants/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#QueryDescendants", "code_sample": "" }, "@roblox/globaltype/Instance.Remove/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.Remove": { "documentation": "Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Remove/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Remove", "code_sample": "local part = Instance.new(\"Part\")\npart.Parent = workspace\nprint(part.Parent) --> Workspace\n\npart:Remove()\n\nprint(part.Parent) --> nil\n\npart.Parent = workspace\n\nprint(part.Parent) --> Workspace" }, "@roblox/globaltype/Instance.remove/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.remove": { "documentation": "Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.remove/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#remove", "code_sample": "" }, "@roblox/globaltype/Instance.RemoveTag/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.RemoveTag/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.RemoveTag": { "documentation": "Removes a tag from the instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.RemoveTag/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/Instance.RemoveTag/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#RemoveTag", "code_sample": "" }, "@roblox/globaltype/Instance.ResetPropertyToDefault/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.ResetPropertyToDefault/param/1": { "documentation": "Name of the property to reset." }, "@roblox/globaltype/Instance.ResetPropertyToDefault": { "documentation": "Resets a property to its default value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ResetPropertyToDefault/param/0" }, { "name": "property", "documentation": "@roblox/globaltype/Instance.ResetPropertyToDefault/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#ResetPropertyToDefault", "code_sample": "" }, "@roblox/globaltype/Instance.SetAttribute/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.SetAttribute/param/1": { "documentation": "The name of the attribute being set." }, "@roblox/globaltype/Instance.SetAttribute/param/2": { "documentation": "The value to set the specified attribute to." }, "@roblox/globaltype/Instance.SetAttribute": { "documentation": "Sets the attribute with the given name to the given value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.SetAttribute/param/0" }, { "name": "attribute", "documentation": "@roblox/globaltype/Instance.SetAttribute/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/Instance.SetAttribute/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#SetAttribute", "code_sample": "" }, "@roblox/globaltype/Instance.WaitForChild/param/0": { "documentation": "Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree." }, "@roblox/globaltype/Instance.WaitForChild/param/1": { "documentation": "The Instance.Name to be looked for." }, "@roblox/globaltype/Instance.WaitForChild/param/2": { "documentation": "An optional time out parameter." }, "@roblox/globaltype/Instance.WaitForChild/return/0": { "documentation": "The Instance found." }, "@roblox/globaltype/Instance.WaitForChild": { "documentation": "Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.WaitForChild/param/0" }, { "name": "childName", "documentation": "@roblox/globaltype/Instance.WaitForChild/param/1" }, { "name": "timeOut", "documentation": "@roblox/globaltype/Instance.WaitForChild/param/2" } ], "returns": [ "@roblox/globaltype/Instance.WaitForChild/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#WaitForChild", "code_sample": "local part = workspace:WaitForChild(\"Part\")\nprint(part.Name .. \" has been added to the Workspace\")" }, "@roblox/globaltype/Instance.AncestryChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AncestryChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AncestryChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AncestryChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.AncestryChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.AncestryChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AncestryChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AncestryChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AncestryChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.AncestryChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.AncestryChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AncestryChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AncestryChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AncestryChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.AncestryChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.AncestryChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AncestryChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AncestryChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.AncestryChanged": { "documentation": "Fires when the Instance.Parent property of the object or one of its ancestors is changed.", "keys": { "Connect": "@roblox/globaltype/Instance.AncestryChanged.Connect", "ConnectParallel": "@roblox/globaltype/Instance.AncestryChanged.ConnectParallel", "Once": "@roblox/globaltype/Instance.AncestryChanged.Once", "Wait": "@roblox/globaltype/Instance.AncestryChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#AncestryChanged", "code_sample": "" }, "@roblox/globaltype/Instance.AttributeChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AttributeChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AttributeChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AttributeChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.AttributeChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.AttributeChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AttributeChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AttributeChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AttributeChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.AttributeChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.AttributeChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AttributeChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.AttributeChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AttributeChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.AttributeChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.AttributeChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.AttributeChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.AttributeChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.AttributeChanged": { "documentation": "Fires whenever an attribute is changed on the Instance.", "keys": { "Connect": "@roblox/globaltype/Instance.AttributeChanged.Connect", "ConnectParallel": "@roblox/globaltype/Instance.AttributeChanged.ConnectParallel", "Once": "@roblox/globaltype/Instance.AttributeChanged.Once", "Wait": "@roblox/globaltype/Instance.AttributeChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#AttributeChanged", "code_sample": "" }, "@roblox/globaltype/Instance.ChildAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.ChildAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.ChildAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.ChildAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.ChildAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.ChildAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.ChildAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildAdded": { "documentation": "Fires after an object is parented to this Instance.", "keys": { "Connect": "@roblox/globaltype/Instance.ChildAdded.Connect", "ConnectParallel": "@roblox/globaltype/Instance.ChildAdded.ConnectParallel", "Once": "@roblox/globaltype/Instance.ChildAdded.Once", "Wait": "@roblox/globaltype/Instance.ChildAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#ChildAdded", "code_sample": "local function onChildAdded(instance)\n\tprint(instance.Name .. \" added to the workspace\")\nend\n\nworkspace.ChildAdded:Connect(onChildAdded)\n\nlocal part = Instance.new(\"Part\")\npart.Parent = workspace --> Part added to the Workspace" }, "@roblox/globaltype/Instance.childAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.childAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.childAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.childAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.childAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.childAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.childAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.childAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.childAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.childAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.childAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.childAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.childAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.childAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.childAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.childAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.childAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.childAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.childAdded": { "documentation": "Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.", "keys": { "Connect": "@roblox/globaltype/Instance.childAdded.Connect", "ConnectParallel": "@roblox/globaltype/Instance.childAdded.ConnectParallel", "Once": "@roblox/globaltype/Instance.childAdded.Once", "Wait": "@roblox/globaltype/Instance.childAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#childAdded", "code_sample": "" }, "@roblox/globaltype/Instance.ChildRemoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildRemoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.ChildRemoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildRemoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.ChildRemoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildRemoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildRemoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.ChildRemoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildRemoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.ChildRemoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildRemoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildRemoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.ChildRemoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildRemoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.ChildRemoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildRemoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.ChildRemoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.ChildRemoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.ChildRemoved": { "documentation": "Fires after a child is removed from this Instance.", "keys": { "Connect": "@roblox/globaltype/Instance.ChildRemoved.Connect", "ConnectParallel": "@roblox/globaltype/Instance.ChildRemoved.ConnectParallel", "Once": "@roblox/globaltype/Instance.ChildRemoved.Once", "Wait": "@roblox/globaltype/Instance.ChildRemoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#ChildRemoved", "code_sample": "local function onChildRemoved(instance)\n\tprint(instance.Name .. \" removed from the workspace\")\nend\n\nworkspace.ChildRemoved:Connect(onChildRemoved)\n\nlocal part = Instance.new(\"Part\")\npart.Parent = workspace\n\ntask.wait(2)\n\npart:Destroy()" }, "@roblox/globaltype/Instance.DescendantAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.DescendantAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.DescendantAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.DescendantAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.DescendantAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.DescendantAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.DescendantAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantAdded": { "documentation": "Fires after a descendant is added to the Instance.", "keys": { "Connect": "@roblox/globaltype/Instance.DescendantAdded.Connect", "ConnectParallel": "@roblox/globaltype/Instance.DescendantAdded.ConnectParallel", "Once": "@roblox/globaltype/Instance.DescendantAdded.Once", "Wait": "@roblox/globaltype/Instance.DescendantAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#DescendantAdded", "code_sample": "local function onDescendantAdded(descendant)\n\tprint(descendant)\nend\n\nworkspace.DescendantAdded:Connect(onDescendantAdded)\n\nlocal part = Instance.new(\"Part\")\npart.Parent = workspace" }, "@roblox/globaltype/Instance.DescendantRemoving.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantRemoving.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.DescendantRemoving.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantRemoving.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantRemoving.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.DescendantRemoving.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantRemoving.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantRemoving.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.DescendantRemoving.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantRemoving.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.DescendantRemoving.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.DescendantRemoving.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.DescendantRemoving": { "documentation": "Fires immediately before a descendant of the Instance is removed.", "keys": { "Connect": "@roblox/globaltype/Instance.DescendantRemoving.Connect", "ConnectParallel": "@roblox/globaltype/Instance.DescendantRemoving.ConnectParallel", "Once": "@roblox/globaltype/Instance.DescendantRemoving.Once", "Wait": "@roblox/globaltype/Instance.DescendantRemoving.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#DescendantRemoving", "code_sample": "" }, "@roblox/globaltype/Instance.Destroying.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.Destroying.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.Destroying.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Destroying.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.Destroying.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.Destroying.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.Destroying.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.Destroying.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Destroying.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.Destroying.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.Destroying.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.Destroying.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.Destroying.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Destroying.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.Destroying.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.Destroying.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.Destroying.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.Destroying.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.Destroying": { "documentation": "Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().", "keys": { "Connect": "@roblox/globaltype/Instance.Destroying.Connect", "ConnectParallel": "@roblox/globaltype/Instance.Destroying.ConnectParallel", "Once": "@roblox/globaltype/Instance.Destroying.Once", "Wait": "@roblox/globaltype/Instance.Destroying.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#Destroying", "code_sample": "local part = Instance.new(\"Part\", workspace)\n\nlocal function onPartDestroying()\n\tprint(\"Before yielding:\", part:GetFullName(), #part:GetChildren())\n\ttask.wait()\n\tprint(\"After yielding:\", part:GetFullName(), #part:GetChildren())\nend\n\npart.Destroying:Connect(onPartDestroying)\n\npart:Destroy()" }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.StyledPropertiesChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.StyledPropertiesChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.StyledPropertiesChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Instance.StyledPropertiesChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Instance.StyledPropertiesChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Instance.StyledPropertiesChanged": { "documentation": "Fires whenever any style property is changed on the instance, including when a property is set to nil.", "keys": { "Connect": "@roblox/globaltype/Instance.StyledPropertiesChanged.Connect", "ConnectParallel": "@roblox/globaltype/Instance.StyledPropertiesChanged.ConnectParallel", "Once": "@roblox/globaltype/Instance.StyledPropertiesChanged.Once", "Wait": "@roblox/globaltype/Instance.StyledPropertiesChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Instance#StyledPropertiesChanged", "code_sample": "" }, "@roblox/globaltype/AudioEcho": { "documentation": "Overlays delayed copies of audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioEcho.Bypass", "DelayTime": "@roblox/globaltype/AudioEcho.DelayTime", "DryLevel": "@roblox/globaltype/AudioEcho.DryLevel", "Feedback": "@roblox/globaltype/AudioEcho.Feedback", "RampTime": "@roblox/globaltype/AudioEcho.RampTime", "WetLevel": "@roblox/globaltype/AudioEcho.WetLevel", "GetConnectedWires": "@roblox/globaltype/AudioEcho.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioEcho.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioEcho.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho", "code_sample": "" }, "@roblox/globaltype/AudioEcho.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioEcho.DelayTime": { "documentation": "The amount of time between echoes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#DelayTime", "code_sample": "" }, "@roblox/globaltype/AudioEcho.DryLevel": { "documentation": "Gain level determining how loud the original, unaltered audio stream will be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#DryLevel", "code_sample": "" }, "@roblox/globaltype/AudioEcho.Feedback": { "documentation": "How slowly echoes fade away.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#Feedback", "code_sample": "" }, "@roblox/globaltype/AudioEcho.RampTime": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#RampTime", "code_sample": "" }, "@roblox/globaltype/AudioEcho.WetLevel": { "documentation": "Gain level determining how loud the echoed stream will be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#WetLevel", "code_sample": "" }, "@roblox/globaltype/AudioEcho.GetConnectedWires/param/0": { "documentation": "Overlays delayed copies of audio streams." }, "@roblox/globaltype/AudioEcho.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEcho.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEcho.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioEcho.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioEcho.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioEcho.GetInputPins/param/0": { "documentation": "Overlays delayed copies of audio streams." }, "@roblox/globaltype/AudioEcho.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEcho.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioEcho.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioEcho.GetOutputPins/param/0": { "documentation": "Overlays delayed copies of audio streams." }, "@roblox/globaltype/AudioEcho.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEcho.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioEcho.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioEcho.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEcho.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEcho.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEcho.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEcho.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEcho.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEcho.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEcho.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEcho.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEcho.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEcho.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEcho.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioEcho.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioEcho via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioEcho.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioEcho.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioEcho.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioEcho.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEcho#WiringChanged", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataClass": { "documentation": "Registers information about a class, and its members. Should be parented to ReflectionMetadataClasses.", "keys": { "ExplorerImageIndex": "@roblox/globaltype/ReflectionMetadataClass.ExplorerImageIndex", "ExplorerOrder": "@roblox/globaltype/ReflectionMetadataClass.ExplorerOrder", "Insertable": "@roblox/globaltype/ReflectionMetadataClass.Insertable", "PreferredParent": "@roblox/globaltype/ReflectionMetadataClass.PreferredParent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataClass", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataClass.ExplorerImageIndex": { "documentation": "A number index, which refers to a specific class icon.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataClass#ExplorerImageIndex", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataClass.ExplorerOrder": { "documentation": "Determines how this class is sorted in the Explorer compared to other classes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataClass#ExplorerOrder", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataClass.Insertable": { "documentation": "Toggles whether or not this object can be inserted through the Advanced Objects menu.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataClass#Insertable", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataClass.PreferredParent": { "documentation": "Sets the class that this class would prefer parenting to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataClass#PreferredParent", "code_sample": "" }, "@roblox/globaltype/NumberPose": { "documentation": "Holds the value applied to a specific FACS control.", "keys": { "Value": "@roblox/globaltype/NumberPose.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NumberPose", "code_sample": "" }, "@roblox/globaltype/NumberPose.Value": { "documentation": "The value that will be applied to the FACS control corresponding to the NumberPose.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NumberPose#Value", "code_sample": "" }, "@roblox/globaltype/SolidModelContentProvider": { "documentation": "An internal service which serves no functionality to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SolidModelContentProvider", "code_sample": "" }, "@roblox/globaltype/GenerationService": { "documentation": "Service that allows developers to generate 3D objects from text prompts.", "keys": { "GenerateMeshAsync": "@roblox/globaltype/GenerationService.GenerateMeshAsync", "GenerateModelAsync": "@roblox/globaltype/GenerationService.GenerateModelAsync", "LoadGeneratedMeshAsync": "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GenerationService", "code_sample": "" }, "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/0": { "documentation": "Service that allows developers to generate 3D objects from text prompts." }, "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/1": { "documentation": "A dictionary containing the mesh generation prompts. Currently, the only supported key is the Prompt (string) that describes the mesh to generate." }, "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/2": { "documentation": "The Player requesting the generation." }, "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/3": { "documentation": "A dictionary for additional generation options to influence the result. The following key is supported: - SuggestedSize — Optional Vector3 representing a size guide for the generated asset. The service will attempt to create a model with a size and proportion similar to the provided Vector3. This does not guarantee the final output size." }, "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/4": { "documentation": "A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions before textures are applied." }, "@roblox/globaltype/GenerationService.GenerateMeshAsync/return/0": { "documentation": "A tuple of the generation ID (a unique ID returned for each invocation of GenerateMeshAsync()) and context ID (not currently used)." }, "@roblox/globaltype/GenerationService.GenerateMeshAsync": { "documentation": "Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/0" }, { "name": "inputs", "documentation": "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/1" }, { "name": "player", "documentation": "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/3" }, { "name": "intermediateResultCallback", "documentation": "@roblox/globaltype/GenerationService.GenerateMeshAsync/param/4" } ], "returns": [ "@roblox/globaltype/GenerationService.GenerateMeshAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateMeshAsync", "code_sample": "" }, "@roblox/globaltype/GenerationService.GenerateModelAsync/param/0": { "documentation": "Service that allows developers to generate 3D objects from text prompts." }, "@roblox/globaltype/GenerationService.GenerateModelAsync/param/1": { "documentation": "" }, "@roblox/globaltype/GenerationService.GenerateModelAsync/param/2": { "documentation": "" }, "@roblox/globaltype/GenerationService.GenerateModelAsync/param/3": { "documentation": "" }, "@roblox/globaltype/GenerationService.GenerateModelAsync/return/0": { "documentation": "" }, "@roblox/globaltype/GenerationService.GenerateModelAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GenerationService.GenerateModelAsync/param/0" }, { "name": "inputs", "documentation": "@roblox/globaltype/GenerationService.GenerateModelAsync/param/1" }, { "name": "schema", "documentation": "@roblox/globaltype/GenerationService.GenerateModelAsync/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/GenerationService.GenerateModelAsync/param/3" } ], "returns": [ "@roblox/globaltype/GenerationService.GenerateModelAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync", "code_sample": "" }, "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync/param/0": { "documentation": "Service that allows developers to generate 3D objects from text prompts." }, "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync/param/1": { "documentation": "The unique ID returned by GenerateMeshAsync(). Identifies the mesh to load." }, "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync/return/0": { "documentation": "The generated asset, returned as a Model with a single MeshPart containing an EditableMesh." }, "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync": { "documentation": "Retrieves and loads a mesh generated by GenerationService:GenerateMeshAsync() using the provided generationId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync/param/0" }, { "name": "generationId", "documentation": "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync/param/1" } ], "returns": [ "@roblox/globaltype/GenerationService.LoadGeneratedMeshAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GenerationService#LoadGeneratedMeshAsync", "code_sample": "" }, "@roblox/globaltype/AngularVelocity": { "documentation": "Applies torque on an assembly to maintain a constant angular velocity.", "keys": { "AngularVelocity": "@roblox/globaltype/AngularVelocity.AngularVelocity", "MaxTorque": "@roblox/globaltype/AngularVelocity.MaxTorque", "ReactionTorqueEnabled": "@roblox/globaltype/AngularVelocity.ReactionTorqueEnabled", "RelativeTo": "@roblox/globaltype/AngularVelocity.RelativeTo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AngularVelocity", "code_sample": "" }, "@roblox/globaltype/AngularVelocity.AngularVelocity": { "documentation": "A Vector3 that gives the desired or target angular velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AngularVelocity#AngularVelocity", "code_sample": "" }, "@roblox/globaltype/AngularVelocity.MaxTorque": { "documentation": "Magnitude of the maximum torque the constraint can apply.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AngularVelocity#MaxTorque", "code_sample": "" }, "@roblox/globaltype/AngularVelocity.ReactionTorqueEnabled": { "documentation": "Causes the constraint to apply equal and opposite reaction forces.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AngularVelocity#ReactionTorqueEnabled", "code_sample": "" }, "@roblox/globaltype/AngularVelocity.RelativeTo": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AngularVelocity#RelativeTo", "code_sample": "" }, "@roblox/globaltype/UIStroke": { "documentation": "Applies an outline to text or a UI border.", "keys": { "ApplyStrokeMode": "@roblox/globaltype/UIStroke.ApplyStrokeMode", "BorderOffset": "@roblox/globaltype/UIStroke.BorderOffset", "BorderStrokePosition": "@roblox/globaltype/UIStroke.BorderStrokePosition", "Color": "@roblox/globaltype/UIStroke.Color", "Enabled": "@roblox/globaltype/UIStroke.Enabled", "LineJoinMode": "@roblox/globaltype/UIStroke.LineJoinMode", "StrokeSizingMode": "@roblox/globaltype/UIStroke.StrokeSizingMode", "Thickness": "@roblox/globaltype/UIStroke.Thickness", "Transparency": "@roblox/globaltype/UIStroke.Transparency", "ZIndex": "@roblox/globaltype/UIStroke.ZIndex" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke", "code_sample": "" }, "@roblox/globaltype/UIStroke.ApplyStrokeMode": { "documentation": "Determines whether to apply the stroke to the object's border instead of the text itself.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#ApplyStrokeMode", "code_sample": "" }, "@roblox/globaltype/UIStroke.BorderOffset": { "documentation": "Specifies an additional offset to the stroke's position, relative to the parent's minimum height or width.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#BorderOffset", "code_sample": "" }, "@roblox/globaltype/UIStroke.BorderStrokePosition": { "documentation": "Determines the stroke's position on its parent's border.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#BorderStrokePosition", "code_sample": "" }, "@roblox/globaltype/UIStroke.Color": { "documentation": "Determines the stroke color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#Color", "code_sample": "" }, "@roblox/globaltype/UIStroke.Enabled": { "documentation": "Determines whether the stroke in visible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#Enabled", "code_sample": "" }, "@roblox/globaltype/UIStroke.LineJoinMode": { "documentation": "Determines how corners are interpreted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#LineJoinMode", "code_sample": "" }, "@roblox/globaltype/UIStroke.StrokeSizingMode": { "documentation": "Determines whether the stroke's Thickness will be measured in pixels or be relative to the parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#StrokeSizingMode", "code_sample": "" }, "@roblox/globaltype/UIStroke.Thickness": { "documentation": "Determines the stroke's thickness.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#Thickness", "code_sample": "" }, "@roblox/globaltype/UIStroke.Transparency": { "documentation": "Sets the stroke opacity independently of the parent object's BackgroundTransparency or TextTransparency.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#Transparency", "code_sample": "" }, "@roblox/globaltype/UIStroke.ZIndex": { "documentation": "Determines the order in which the stroke renders relative to sibling UIStroke instances.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIStroke#ZIndex", "code_sample": "" }, "@roblox/globaltype/KeyframeMarker": { "documentation": "An instance meant to represent an event that will eventually be fired when a Keyframe is hit.", "keys": { "Value": "@roblox/globaltype/KeyframeMarker.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeMarker", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal marker1 = Instance.new(\"KeyframeMarker\")\nmarker1.Name = \"FootStep\"\nmarker1.Value = 100\n\nlocal marker2 = Instance.new(\"KeyframeMarker\")\nmarker2.Name = \"Wave\"\nmarker2.Value = 100\n\nkeyframe:AddMarker(marker1) --marker.Parent = keyframe\nkeyframe:AddMarker(marker2) --marker.Parent = keyframe\n\nlocal markers = keyframe:GetMarkers()\nfor _, marker in pairs(markers) do\n\tprint(marker.Name)\nend" }, "@roblox/globaltype/KeyframeMarker.Value": { "documentation": "A value that is specified for a KeyframeMarker.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeMarker#Value", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal marker1 = Instance.new(\"KeyframeMarker\")\nmarker1.Name = \"FootStep\"\nmarker1.Value = 100\n\nlocal marker2 = Instance.new(\"KeyframeMarker\")\nmarker2.Name = \"Wave\"\nmarker2.Value = 100\n\nkeyframe:AddMarker(marker1) --marker.Parent = keyframe\nkeyframe:AddMarker(marker2) --marker.Parent = keyframe\n\nlocal markers = keyframe:GetMarkers()\nfor _, marker in pairs(markers) do\n\tprint(marker.Name)\nend" }, "@roblox/globaltype/TerrainRegion": { "documentation": "", "keys": { "IsSmooth": "@roblox/globaltype/TerrainRegion.IsSmooth", "SizeInCells": "@roblox/globaltype/TerrainRegion.SizeInCells", "ConvertToSmooth": "@roblox/globaltype/TerrainRegion.ConvertToSmooth" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainRegion", "code_sample": "" }, "@roblox/globaltype/TerrainRegion.IsSmooth": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
The state of this property shows whether or not this TerrainRegion contains smooth terrain.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainRegion#IsSmooth", "code_sample": "" }, "@roblox/globaltype/TerrainRegion.SizeInCells": { "documentation": "The size of this TerrainRegion in cells.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainRegion#SizeInCells", "code_sample": "" }, "@roblox/globaltype/TerrainRegion.ConvertToSmooth/param/0": { "documentation": "" }, "@roblox/globaltype/TerrainRegion.ConvertToSmooth": { "documentation": "Deprecated: This item is a deprecated function of a legacy Terrain engine that has been removed. Do not use it for new work.
Transforms the TerrainRegion so it can be used with smooth terrain.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainRegion.ConvertToSmooth/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainRegion#ConvertToSmooth", "code_sample": "" }, "@roblox/globaltype/WireframeHandleAdornment": { "documentation": "Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace.", "keys": { "Scale": "@roblox/globaltype/WireframeHandleAdornment.Scale", "Thickness": "@roblox/globaltype/WireframeHandleAdornment.Thickness", "AddLine": "@roblox/globaltype/WireframeHandleAdornment.AddLine", "AddLines": "@roblox/globaltype/WireframeHandleAdornment.AddLines", "AddPath": "@roblox/globaltype/WireframeHandleAdornment.AddPath", "AddText": "@roblox/globaltype/WireframeHandleAdornment.AddText", "Clear": "@roblox/globaltype/WireframeHandleAdornment.Clear" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment", "code_sample": "local wireframe = script.Parent\n\n-- Declare four points in a square arrangement\nlocal pathArray = {\n\tVector3.new(-10, 10, 0),\n\tVector3.new(10, 10, 0),\n\tVector3.new(10, -10, 0),\n\tVector3.new(-10, -10, 0)\n}\n\n-- Apply path to adornment and close it (connect starting and ending points)\nwireframe:AddPath(pathArray, true)" }, "@roblox/globaltype/WireframeHandleAdornment.Scale": { "documentation": "The XYZ scale of the wireframe adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Scale", "code_sample": "" }, "@roblox/globaltype/WireframeHandleAdornment.Thickness": { "documentation": "Thickness of the wireframe adornment's lines in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Thickness", "code_sample": "" }, "@roblox/globaltype/WireframeHandleAdornment.AddLine/param/0": { "documentation": "Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace." }, "@roblox/globaltype/WireframeHandleAdornment.AddLine/param/1": { "documentation": "Starting point of the line." }, "@roblox/globaltype/WireframeHandleAdornment.AddLine/param/2": { "documentation": "Ending point of the line." }, "@roblox/globaltype/WireframeHandleAdornment.AddLine": { "documentation": "Adds a line to the wireframe adornment from a starting point to an ending point relative to the center of the Adornee.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddLine/param/0" }, { "name": "from", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddLine/param/1" }, { "name": "to", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddLine/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddLine", "code_sample": "local wireframe = script.Parent\n\nwireframe.Color3 = Color3.fromRGB(255, 0, 0) -- Sets next line to red\nwireframe:AddLine(Vector3.new(-10, 0, 0), Vector3.new(10, 0, 0))\nwireframe.Color3 = Color3.fromRGB(0, 255, 0) -- Sets next line to green\nwireframe:AddLine(Vector3.new(0, -10, 0), Vector3.new(0, 10, 0))\nwireframe.Color3 = Color3.fromRGB(0, 0, 255) -- Sets next line to blue\nwireframe:AddLine(Vector3.new(0, 0, -10), Vector3.new(0, 0, 10))" }, "@roblox/globaltype/WireframeHandleAdornment.AddLines/param/0": { "documentation": "Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace." }, "@roblox/globaltype/WireframeHandleAdornment.AddLines/param/1": { "documentation": "Array of Vector3 points in which each pair acts as a starting point and ending point for a line." }, "@roblox/globaltype/WireframeHandleAdornment.AddLines": { "documentation": "Adds one or more lines to the wireframe adornment using an array.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddLines/param/0" }, { "name": "points", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddLines/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddLines", "code_sample": "local wireframe = script.Parent\n\nlocal linesArray = {\n\tVector3.new(-10, 0, 0), -- Starting point of first line\n\tVector3.new(10, 0, 0), -- Ending point of first line\n\tVector3.new(0, -10, 0), -- Starting point of second line\n\tVector3.new(0, 10, 0), -- Ending point of second line\n\tVector3.new(0, 0, -10), -- Starting point of third line\n\tVector3.new(0, 0, 10) -- Ending point of third line\n}\n-- Apply path to adornment\nwireframe:AddLines(linesArray)" }, "@roblox/globaltype/WireframeHandleAdornment.AddPath/param/0": { "documentation": "Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace." }, "@roblox/globaltype/WireframeHandleAdornment.AddPath/param/1": { "documentation": "Array of Vector3 points to connect in sequence with line segments." }, "@roblox/globaltype/WireframeHandleAdornment.AddPath/param/2": { "documentation": "Whether the path is closed by connecting its ending point to its starting point with an additional line." }, "@roblox/globaltype/WireframeHandleAdornment.AddPath": { "documentation": "Adds multiple line segments to the wireframe adornment in a sequence from point to point.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddPath/param/0" }, { "name": "points", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddPath/param/1" }, { "name": "loop", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddPath/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddPath", "code_sample": "local wireframe = script.Parent\n\n-- Declare four points in a square arrangement\nlocal pathArray = {\n\tVector3.new(-10, 10, 0),\n\tVector3.new(10, 10, 0),\n\tVector3.new(10, -10, 0),\n\tVector3.new(-10, -10, 0)\n}\n\n-- Apply path to adornment and close it (connect starting and ending points)\nwireframe:AddPath(pathArray, true)" }, "@roblox/globaltype/WireframeHandleAdornment.AddText/param/0": { "documentation": "Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace." }, "@roblox/globaltype/WireframeHandleAdornment.AddText/param/1": { "documentation": "Position of the text in the adornment." }, "@roblox/globaltype/WireframeHandleAdornment.AddText/param/2": { "documentation": "String to display." }, "@roblox/globaltype/WireframeHandleAdornment.AddText/param/3": { "documentation": "Size of the text." }, "@roblox/globaltype/WireframeHandleAdornment.AddText": { "documentation": "Adds a text label to the wireframe adornment.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddText/param/0" }, { "name": "point", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddText/param/1" }, { "name": "text", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddText/param/2" }, { "name": "size", "documentation": "@roblox/globaltype/WireframeHandleAdornment.AddText/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#AddText", "code_sample": "" }, "@roblox/globaltype/WireframeHandleAdornment.Clear/param/0": { "documentation": "Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace." }, "@roblox/globaltype/WireframeHandleAdornment.Clear": { "documentation": "Instantly clears all lines and text in the wireframe adornment.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WireframeHandleAdornment.Clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment#Clear", "code_sample": "" }, "@roblox/globaltype/FloorWire": { "documentation": "Deprecated: The FloorWire object has been deprecated and should not be used in new work.
A FloorWire attempts to make a wire from two of its properties: FloorWire.From and FloorWire.From, which both need to be set to a BasePart.", "keys": { "CycleOffset": "@roblox/globaltype/FloorWire.CycleOffset", "From": "@roblox/globaltype/FloorWire.From", "StudsBetweenTextures": "@roblox/globaltype/FloorWire.StudsBetweenTextures", "Texture": "@roblox/globaltype/FloorWire.Texture", "TextureSize": "@roblox/globaltype/FloorWire.TextureSize", "To": "@roblox/globaltype/FloorWire.To", "Velocity": "@roblox/globaltype/FloorWire.Velocity", "WireRadius": "@roblox/globaltype/FloorWire.WireRadius" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire", "code_sample": "" }, "@roblox/globaltype/FloorWire.CycleOffset": { "documentation": "A decimal number between 0 and 1, through which you can control how far all of the decals are along the wire.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#CycleOffset", "code_sample": "" }, "@roblox/globaltype/FloorWire.From": { "documentation": "The object that the FloorWire travels from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#From", "code_sample": "" }, "@roblox/globaltype/FloorWire.StudsBetweenTextures": { "documentation": "The number of studs between each FloorWire segment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#StudsBetweenTextures", "code_sample": "" }, "@roblox/globaltype/FloorWire.Texture": { "documentation": "Sets the texture to be displayed on the FloorWire.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#Texture", "code_sample": "" }, "@roblox/globaltype/FloorWire.TextureSize": { "documentation": "Sets the size of the texture used with the FloorWire.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#TextureSize", "code_sample": "" }, "@roblox/globaltype/FloorWire.To": { "documentation": "The object that the FloorWire travels to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#To", "code_sample": "" }, "@roblox/globaltype/FloorWire.Velocity": { "documentation": "The speed that the textures flow along the wire.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#Velocity", "code_sample": "" }, "@roblox/globaltype/FloorWire.WireRadius": { "documentation": "The radius of the wire.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloorWire#WireRadius", "code_sample": "" }, "@roblox/globaltype/MaterialVariant": { "documentation": "Represent a variant of a Material.", "keys": { "AlphaMode": "@roblox/globaltype/MaterialVariant.AlphaMode", "BaseMaterial": "@roblox/globaltype/MaterialVariant.BaseMaterial", "ColorMap": "@roblox/globaltype/MaterialVariant.ColorMap", "ColorMapContent": "@roblox/globaltype/MaterialVariant.ColorMapContent", "CustomPhysicalProperties": "@roblox/globaltype/MaterialVariant.CustomPhysicalProperties", "EmissiveMaskContent": "@roblox/globaltype/MaterialVariant.EmissiveMaskContent", "EmissiveStrength": "@roblox/globaltype/MaterialVariant.EmissiveStrength", "EmissiveTint": "@roblox/globaltype/MaterialVariant.EmissiveTint", "MaterialPattern": "@roblox/globaltype/MaterialVariant.MaterialPattern", "MetalnessMap": "@roblox/globaltype/MaterialVariant.MetalnessMap", "MetalnessMapContent": "@roblox/globaltype/MaterialVariant.MetalnessMapContent", "NormalMap": "@roblox/globaltype/MaterialVariant.NormalMap", "NormalMapContent": "@roblox/globaltype/MaterialVariant.NormalMapContent", "RoughnessMap": "@roblox/globaltype/MaterialVariant.RoughnessMap", "RoughnessMapContent": "@roblox/globaltype/MaterialVariant.RoughnessMapContent", "StudsPerTile": "@roblox/globaltype/MaterialVariant.StudsPerTile" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.AlphaMode": { "documentation": "Determines how the alpha channel of the MaterialVariant.ColorMap is used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#AlphaMode", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.BaseMaterial": { "documentation": "Category Material this variant belongs to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#BaseMaterial", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.ColorMap": { "documentation": "Determines the color of the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#ColorMap", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.ColorMapContent": { "documentation": "Determines the color of the surface. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#ColorMapContent", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.CustomPhysicalProperties": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#CustomPhysicalProperties", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.EmissiveMaskContent": { "documentation": "Determines the emissivity across the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#EmissiveMaskContent", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.EmissiveStrength": { "documentation": "Determines the strength of emissive contribution.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#EmissiveStrength", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.EmissiveTint": { "documentation": "Determines the tinting color for emissive contribution.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#EmissiveTint", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.MaterialPattern": { "documentation": "Determines texture tiling method.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#MaterialPattern", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.MetalnessMap": { "documentation": "Determines which parts of the surface are metal and are non-metal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#MetalnessMap", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.MetalnessMapContent": { "documentation": "Determines which parts of the surface are metal and are non-metal. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#MetalnessMapContent", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.NormalMap": { "documentation": "Modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#NormalMap", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.NormalMapContent": { "documentation": "Modifies the lighting of the surface by adding bumps, dents, cracks, and curves without adding more polygons. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#NormalMapContent", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.RoughnessMap": { "documentation": "Determines the apparent roughness across the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#RoughnessMap", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.RoughnessMapContent": { "documentation": "Determines the apparent roughness across the surface. Only supports asset URIs as textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#RoughnessMapContent", "code_sample": "" }, "@roblox/globaltype/MaterialVariant.StudsPerTile": { "documentation": "Determines the scale of textures.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#StudsPerTile", "code_sample": "" }, "@roblox/globaltype/TerrainIterateOperation": { "documentation": "", "keys": { "CommitBlock": "@roblox/globaltype/TerrainIterateOperation.CommitBlock" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation", "code_sample": "" }, "@roblox/globaltype/TerrainIterateOperation.CommitBlock/param/0": { "documentation": "" }, "@roblox/globaltype/TerrainIterateOperation.CommitBlock/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainIterateOperation.CommitBlock/return/0": { "documentation": "" }, "@roblox/globaltype/TerrainIterateOperation.CommitBlock": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainIterateOperation.CommitBlock/param/0" }, { "name": "block", "documentation": "@roblox/globaltype/TerrainIterateOperation.CommitBlock/param/1" } ], "returns": [ "@roblox/globaltype/TerrainIterateOperation.CommitBlock/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation#CommitBlock", "code_sample": "" }, "@roblox/globaltype/TerrainIterateOperation.Ready.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainIterateOperation.Ready.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainIterateOperation.Ready.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainIterateOperation.Ready.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainIterateOperation.Ready.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainIterateOperation.Ready.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainIterateOperation.Ready.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainIterateOperation.Ready.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainIterateOperation.Ready.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainIterateOperation.Ready.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainIterateOperation.Ready.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainIterateOperation.Ready.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TerrainIterateOperation.Ready": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/TerrainIterateOperation.Ready.Connect", "ConnectParallel": "@roblox/globaltype/TerrainIterateOperation.Ready.ConnectParallel", "Once": "@roblox/globaltype/TerrainIterateOperation.Ready.Once", "Wait": "@roblox/globaltype/TerrainIterateOperation.Ready.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainIterateOperation#Ready", "code_sample": "" }, "@roblox/globaltype/WrapTarget": { "documentation": "The WrapTarget object defines a target. A target is the 3D body with only an outer surface, or an Outer Cage.", "keys": { "Color": "@roblox/globaltype/WrapTarget.Color", "DebugMode": "@roblox/globaltype/WrapTarget.DebugMode", "Stiffness": "@roblox/globaltype/WrapTarget.Stiffness" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTarget", "code_sample": "" }, "@roblox/globaltype/WrapTarget.Color": { "documentation": "Sets color used for the debug rendering. See WrapTarget.DebugMode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTarget#Color", "code_sample": "" }, "@roblox/globaltype/WrapTarget.DebugMode": { "documentation": "Allows switching between different debugging visualization modes for cage meshes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTarget#DebugMode", "code_sample": "" }, "@roblox/globaltype/WrapTarget.Stiffness": { "documentation": "Defines how much the body mesh can be compressed by clothing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WrapTarget#Stiffness", "code_sample": "" }, "@roblox/globaltype/EchoSoundEffect": { "documentation": "Adds delayed repetitions of a sound with diminishing volume.", "keys": { "Delay": "@roblox/globaltype/EchoSoundEffect.Delay", "DryLevel": "@roblox/globaltype/EchoSoundEffect.DryLevel", "Feedback": "@roblox/globaltype/EchoSoundEffect.Feedback", "WetLevel": "@roblox/globaltype/EchoSoundEffect.WetLevel" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EchoSoundEffect", "code_sample": "" }, "@roblox/globaltype/EchoSoundEffect.Delay": { "documentation": "The amount of time between echoes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EchoSoundEffect#Delay", "code_sample": "" }, "@roblox/globaltype/EchoSoundEffect.DryLevel": { "documentation": "The output volume of the original sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EchoSoundEffect#DryLevel", "code_sample": "" }, "@roblox/globaltype/EchoSoundEffect.Feedback": { "documentation": "The echo decay every time the echo plays.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EchoSoundEffect#Feedback", "code_sample": "" }, "@roblox/globaltype/EchoSoundEffect.WetLevel": { "documentation": "The output volume of the echoed effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EchoSoundEffect#WetLevel", "code_sample": "" }, "@roblox/globaltype/Weld": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Weld", "code_sample": "" }, "@roblox/globaltype/GeometryService": { "documentation": "Service containing geometric operations.", "keys": { "CalculateConstraintsToPreserve": "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve", "IntersectAsync": "@roblox/globaltype/GeometryService.IntersectAsync", "SubtractAsync": "@roblox/globaltype/GeometryService.SubtractAsync", "UnionAsync": "@roblox/globaltype/GeometryService.UnionAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GeometryService", "code_sample": "" }, "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/0": { "documentation": "Service containing geometric operations." }, "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/1": { "documentation": "An original object that the solid modeling operation was performed on, for example part in UnionAsync()." }, "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/2": { "documentation": "" }, "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/3": { "documentation": "Options dictionary for the method: " }, "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/return/0": { "documentation": "Table containing information for general case Constraints, NoCollisionConstraints, and WeldConstraints. In cases where an Attachment or Constraint should be dropped, its respective parent will be nil. For general case Constraints such as HingeConstraint:
Key Type
Attachment Class.Attachment
Constraint Class.Constraint or nil
AttachmentParent Class.BasePart or nil
ConstraintParent Class.BasePart or nil
For WeldConstraints:
Key Type
WeldConstraint Class.WeldConstraint
WeldConstraintParent Class.BasePart or nil
WeldConstraintPart0 Class.BasePart
WeldConstraintPart1 Class.BasePart
For NoCollisionConstraints:
Key Type
NoCollisionConstraint Class.NoCollisionConstraint
NoCollisionConstraintParent Class.BasePart or nil
NoCollisionConstraintPart0 Class.BasePart
NoCollisionConstraintPart1 Class.BasePart
" }, "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve": { "documentation": "Returns a table of Constraints and Attachments which you may choose to preserve, along with their respective parents.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/0" }, { "name": "source", "documentation": "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/1" }, { "name": "destination", "documentation": "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/param/3" } ], "returns": [ "@roblox/globaltype/GeometryService.CalculateConstraintsToPreserve/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GeometryService#CalculateConstraintsToPreserve", "code_sample": "" }, "@roblox/globaltype/GeometryService.IntersectAsync/param/0": { "documentation": "Service containing geometric operations." }, "@roblox/globaltype/GeometryService.IntersectAsync/param/1": { "documentation": "Main Part or PartOperation to operate on." }, "@roblox/globaltype/GeometryService.IntersectAsync/param/2": { "documentation": "Array of parts to intersect with the main part." }, "@roblox/globaltype/GeometryService.IntersectAsync/param/3": { "documentation": "Options table containing all the controls for the method: " }, "@roblox/globaltype/GeometryService.IntersectAsync/return/0": { "documentation": "One or more PartOperations from the intersecting geometry of the main part (part) and the other parts." }, "@roblox/globaltype/GeometryService.IntersectAsync": { "documentation": "Creates one or more PartOperations from the intersecting geometry of one part and other parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GeometryService.IntersectAsync/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/GeometryService.IntersectAsync/param/1" }, { "name": "parts", "documentation": "@roblox/globaltype/GeometryService.IntersectAsync/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/GeometryService.IntersectAsync/param/3" } ], "returns": [ "@roblox/globaltype/GeometryService.IntersectAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GeometryService#IntersectAsync", "code_sample": "" }, "@roblox/globaltype/GeometryService.SubtractAsync/param/0": { "documentation": "Service containing geometric operations." }, "@roblox/globaltype/GeometryService.SubtractAsync/param/1": { "documentation": "Main Part or PartOperation to operate on." }, "@roblox/globaltype/GeometryService.SubtractAsync/param/2": { "documentation": "Array of parts to subtract from the main part." }, "@roblox/globaltype/GeometryService.SubtractAsync/param/3": { "documentation": "Options table containing all the controls for the method: " }, "@roblox/globaltype/GeometryService.SubtractAsync/return/0": { "documentation": "One or more PartOperations from the geometry of the main part (part) minus the geometry occupied by the other parts." }, "@roblox/globaltype/GeometryService.SubtractAsync": { "documentation": "Creates one or more PartOperations from one part minus the geometry occupied by other parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GeometryService.SubtractAsync/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/GeometryService.SubtractAsync/param/1" }, { "name": "parts", "documentation": "@roblox/globaltype/GeometryService.SubtractAsync/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/GeometryService.SubtractAsync/param/3" } ], "returns": [ "@roblox/globaltype/GeometryService.SubtractAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GeometryService#SubtractAsync", "code_sample": "" }, "@roblox/globaltype/GeometryService.UnionAsync/param/0": { "documentation": "Service containing geometric operations." }, "@roblox/globaltype/GeometryService.UnionAsync/param/1": { "documentation": "Main Part or PartOperation to operate on." }, "@roblox/globaltype/GeometryService.UnionAsync/param/2": { "documentation": "Array of parts to union with the main part." }, "@roblox/globaltype/GeometryService.UnionAsync/param/3": { "documentation": "Options table containing all the controls for the method: " }, "@roblox/globaltype/GeometryService.UnionAsync/return/0": { "documentation": "One or more PartOperations from the geometry of the main part (part) plus the geometry occupied by the other parts." }, "@roblox/globaltype/GeometryService.UnionAsync": { "documentation": "Creates one or more PartOperations from one part plus the geometry occupied by other parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GeometryService.UnionAsync/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/GeometryService.UnionAsync/param/1" }, { "name": "parts", "documentation": "@roblox/globaltype/GeometryService.UnionAsync/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/GeometryService.UnionAsync/param/3" } ], "returns": [ "@roblox/globaltype/GeometryService.UnionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GeometryService#UnionAsync", "code_sample": "" }, "@roblox/globaltype/SoundService": { "documentation": "A service that determines various aspects of how the audio engine works. Most of its properties affect how Sounds play in the experience.", "keys": { "AcousticSimulationEnabled": "@roblox/globaltype/SoundService.AcousticSimulationEnabled", "AmbientReverb": "@roblox/globaltype/SoundService.AmbientReverb", "CharacterSoundsUseNewApi": "@roblox/globaltype/SoundService.CharacterSoundsUseNewApi", "DefaultListenerLocation": "@roblox/globaltype/SoundService.DefaultListenerLocation", "DistanceFactor": "@roblox/globaltype/SoundService.DistanceFactor", "DopplerScale": "@roblox/globaltype/SoundService.DopplerScale", "RespectFilteringEnabled": "@roblox/globaltype/SoundService.RespectFilteringEnabled", "RolloffScale": "@roblox/globaltype/SoundService.RolloffScale", "VolumetricAudio": "@roblox/globaltype/SoundService.VolumetricAudio", "GetListener": "@roblox/globaltype/SoundService.GetListener", "OpenAttenuationCurveEditor": "@roblox/globaltype/SoundService.OpenAttenuationCurveEditor", "OpenDirectionalCurveEditor": "@roblox/globaltype/SoundService.OpenDirectionalCurveEditor", "PlayLocalSound": "@roblox/globaltype/SoundService.PlayLocalSound", "SetListener": "@roblox/globaltype/SoundService.SetListener" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService", "code_sample": "" }, "@roblox/globaltype/SoundService.AcousticSimulationEnabled": { "documentation": "Determines whether acoustic simulation is enabled globally in the advanced audio system.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#AcousticSimulationEnabled", "code_sample": "" }, "@roblox/globaltype/SoundService.AmbientReverb": { "documentation": "The ambient sound environment preset applied to all Sounds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#AmbientReverb", "code_sample": "" }, "@roblox/globaltype/SoundService.CharacterSoundsUseNewApi": { "documentation": "Determines whether the default character sounds will use instances in the advanced audio system vs. Sounds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi", "code_sample": "" }, "@roblox/globaltype/SoundService.DefaultListenerLocation": { "documentation": "Determines where (if anywhere) to place an AudioListener by default.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#DefaultListenerLocation", "code_sample": "" }, "@roblox/globaltype/SoundService.DistanceFactor": { "documentation": "The number of studs to be considered a meter by SoundService when simulating the Doppler effect for Sounds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#DistanceFactor", "code_sample": "" }, "@roblox/globaltype/SoundService.DopplerScale": { "documentation": "Degree to which the pitch of a Sound varies due to the Doppler effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#DopplerScale", "code_sample": "" }, "@roblox/globaltype/SoundService.RespectFilteringEnabled": { "documentation": "Sets whether Sound playback from a client will replicate to the server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#RespectFilteringEnabled", "code_sample": "" }, "@roblox/globaltype/SoundService.RolloffScale": { "documentation": "Determines how fast the volume of a Sound attenuates beyond its Sound.RollOffMinDistance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#RolloffScale", "code_sample": "" }, "@roblox/globaltype/SoundService.VolumetricAudio": { "documentation": "Determines whether certain spatialized Sounds emit volumetrically, throughout the space of their parent object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#VolumetricAudio", "code_sample": "" }, "@roblox/globaltype/SoundService.GetListener/param/0": { "documentation": "A service that determines various aspects of how the audio engine works. Most of its properties affect how Sounds play in the experience." }, "@roblox/globaltype/SoundService.GetListener/return/0": { "documentation": "A table containing two results. The first result is the listener's ListenerType and the second result is dependent on that type:
Listener Type Description
Enum.ListenerType.Camera Does not return a listener object as Class.Workspace.CurrentCamera|CurrentCamera is always used.
Enum.ListenerType.CFrame Returns the Datatype.CFrame used in Class.SoundService:SetListener()|SetListener().
Enum.ListenerType.ObjectPosition Returns the Class.BasePart used in Class.SoundService:SetListener()|SetListener().
Enum.ListenerType.ObjectCFrame Returns the Class.BasePart used in Class.SoundService:SetListener()|SetListener().
" }, "@roblox/globaltype/SoundService.GetListener": { "documentation": "Returns the current listener type used by Sounds, as well as what that listener is currently set to.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SoundService.GetListener/param/0" } ], "returns": [ "@roblox/globaltype/SoundService.GetListener/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#GetListener", "code_sample": "" }, "@roblox/globaltype/SoundService.OpenAttenuationCurveEditor/param/0": { "documentation": "A service that determines various aspects of how the audio engine works. Most of its properties affect how Sounds play in the experience." }, "@roblox/globaltype/SoundService.OpenAttenuationCurveEditor/param/1": { "documentation": "A list of AudioEmitters or AudioListeners." }, "@roblox/globaltype/SoundService.OpenAttenuationCurveEditor": { "documentation": "Opens the attenuation curve editor in Studio for the provided AudioEmitter or AudioListener instances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SoundService.OpenAttenuationCurveEditor/param/0" }, { "name": "selectedCurveObjects", "documentation": "@roblox/globaltype/SoundService.OpenAttenuationCurveEditor/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#OpenAttenuationCurveEditor", "code_sample": "" }, "@roblox/globaltype/SoundService.OpenDirectionalCurveEditor/param/0": { "documentation": "A service that determines various aspects of how the audio engine works. Most of its properties affect how Sounds play in the experience." }, "@roblox/globaltype/SoundService.OpenDirectionalCurveEditor/param/1": { "documentation": "A list of AudioEmitters or AudioListeners." }, "@roblox/globaltype/SoundService.OpenDirectionalCurveEditor": { "documentation": "Opens the directional curve editor in Studio for the provided AudioEmitter or AudioListener instances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SoundService.OpenDirectionalCurveEditor/param/0" }, { "name": "selectedCurveObjects", "documentation": "@roblox/globaltype/SoundService.OpenDirectionalCurveEditor/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#OpenDirectionalCurveEditor", "code_sample": "" }, "@roblox/globaltype/SoundService.PlayLocalSound/param/0": { "documentation": "A service that determines various aspects of how the audio engine works. Most of its properties affect how Sounds play in the experience." }, "@roblox/globaltype/SoundService.PlayLocalSound/param/1": { "documentation": "The Sound to be played." }, "@roblox/globaltype/SoundService.PlayLocalSound": { "documentation": "Plays a copy of a Sound locally, such that it will only be heard by the client calling this method.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SoundService.PlayLocalSound/param/0" }, { "name": "sound", "documentation": "@roblox/globaltype/SoundService.PlayLocalSound/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#PlayLocalSound", "code_sample": "" }, "@roblox/globaltype/SoundService.SetListener/param/0": { "documentation": "A service that determines various aspects of how the audio engine works. Most of its properties affect how Sounds play in the experience." }, "@roblox/globaltype/SoundService.SetListener/param/1": { "documentation": "The ListenerType of the listener." }, "@roblox/globaltype/SoundService.SetListener/param/2": { "documentation": "Dependent on the ListenerType. Use a BasePart for ListenerType.ObjectPosition or ListenerType.ObjectCFrame, a CFrame for ListenerType.CFrame, or nil for ListenerType.Camera." }, "@roblox/globaltype/SoundService.SetListener": { "documentation": "Sets the listener used by Sounds.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SoundService.SetListener/param/0" }, { "name": "listenerType", "documentation": "@roblox/globaltype/SoundService.SetListener/param/1" }, { "name": "listener", "documentation": "@roblox/globaltype/SoundService.SetListener/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundService#SetListener", "code_sample": "" }, "@roblox/globaltype/GenericSettings": { "documentation": "The abstract class for settings database classes.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GenericSettings", "code_sample": "" }, "@roblox/globaltype/BlockMesh": { "documentation": "The BlockMesh object applies a 'brick' mesh to the BasePart it is parented to. It behaves identically to a SpecialMesh with SpecialMesh.MeshType set to 'Brick'.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BlockMesh", "code_sample": "local part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 2, 0)\npart.Size = Vector3.new(5, 2, 5)\npart.Anchored = true\n\nlocal mesh = Instance.new(\"BlockMesh\")\nmesh.Scale = Vector3.new(0.5, 0.5, 0.5)\nmesh.Offset = Vector3.new(0, 2, 0)\nmesh.Parent = part\n\nlocal adornment = Instance.new(\"SelectionBox\")\nadornment.Adornee = part\nadornment.Parent = part\n\npart.Parent = workspace" }, "@roblox/globaltype/TimerService": { "documentation": "An internal service responsible for scheduling timed events. It is used by the Debris class. Its functionality can not be accessed by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TimerService", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve": { "documentation": "Represents a 3D rotation curve through a group of three FloatCurves.", "keys": { "RotationOrder": "@roblox/globaltype/EulerRotationCurve.RotationOrder", "GetAnglesAtTime": "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime", "GetRotationAtTime": "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime", "X": "@roblox/globaltype/EulerRotationCurve.X", "Y": "@roblox/globaltype/EulerRotationCurve.Y", "Z": "@roblox/globaltype/EulerRotationCurve.Z" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve.RotationOrder": { "documentation": "Euler angles rotation order.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#RotationOrder", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime/param/0": { "documentation": "Represents a 3D rotation curve through a group of three FloatCurves." }, "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime/param/1": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime/return/0": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime": { "documentation": "Samples the three FloatCurves (X, Y, Z) at the passed time argument and returns the result as three Euler angles.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime/param/1" } ], "returns": [ "@roblox/globaltype/EulerRotationCurve.GetAnglesAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#GetAnglesAtTime", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime/param/0": { "documentation": "Represents a 3D rotation curve through a group of three FloatCurves." }, "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime/param/1": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime/return/0": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime": { "documentation": "Samples the EulerRotationCurve at a given time and returns the corresponding rotation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime/param/1" } ], "returns": [ "@roblox/globaltype/EulerRotationCurve.GetRotationAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#GetRotationAtTime", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve.X/param/0": { "documentation": "Represents a 3D rotation curve through a group of three FloatCurves." }, "@roblox/globaltype/EulerRotationCurve.X/return/0": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.X": { "documentation": "Returns the FloatCurve controlling the X Euler angle channel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EulerRotationCurve.X/param/0" } ], "returns": [ "@roblox/globaltype/EulerRotationCurve.X/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#X", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve.Y/param/0": { "documentation": "Represents a 3D rotation curve through a group of three FloatCurves." }, "@roblox/globaltype/EulerRotationCurve.Y/return/0": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.Y": { "documentation": "Returns the FloatCurve controlling the Y Euler angle channel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EulerRotationCurve.Y/param/0" } ], "returns": [ "@roblox/globaltype/EulerRotationCurve.Y/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#Y", "code_sample": "" }, "@roblox/globaltype/EulerRotationCurve.Z/param/0": { "documentation": "Represents a 3D rotation curve through a group of three FloatCurves." }, "@roblox/globaltype/EulerRotationCurve.Z/return/0": { "documentation": "" }, "@roblox/globaltype/EulerRotationCurve.Z": { "documentation": "Returns the FloatCurve controlling the Z Euler angle channel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EulerRotationCurve.Z/param/0" } ], "returns": [ "@roblox/globaltype/EulerRotationCurve.Z/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EulerRotationCurve#Z", "code_sample": "" }, "@roblox/globaltype/CylinderMesh": { "documentation": "Deprecated: This class is deprecated, and CylinderMeshes are no longer supported. Do not use it for new work.
The CylinderMesh object applies a 'cylinder' mesh to the BasePart it is parented to.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylinderMesh", "code_sample": "local part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 2, 0)\npart.Size = Vector3.new(10, 2, 5)\npart.Anchored = true\n\nlocal mesh = Instance.new(\"CylinderMesh\")\nmesh.Parent = part\n\nmesh.Scale = Vector3.new(1, 1, 1)\nmesh.Offset = Vector3.new(0, 0, 0)\n\nlocal adornment = Instance.new(\"SelectionBox\")\nadornment.Adornee = part\nadornment.Parent = part\n\npart.Parent = workspace" }, "@roblox/globaltype/StarterCharacterScripts": { "documentation": "Stores instances to be parented to a player's character when it spawns.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterCharacterScripts", "code_sample": "" }, "@roblox/globaltype/BodyThrust": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use VectorForce instead, and see the legacy conversion notes.
Applies a constant force to an object at a specific point.", "keys": { "Force": "@roblox/globaltype/BodyThrust.Force", "force": "@roblox/globaltype/BodyThrust.force", "Location": "@roblox/globaltype/BodyThrust.Location", "location": "@roblox/globaltype/BodyThrust.location" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyThrust", "code_sample": "" }, "@roblox/globaltype/BodyThrust.Force": { "documentation": "Determines the amount of force exerted on each axis relative to the assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyThrust#Force", "code_sample": "" }, "@roblox/globaltype/BodyThrust.force": { "documentation": "Deprecated: This property is a deprecated variant of Force which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyThrust#force", "code_sample": "" }, "@roblox/globaltype/BodyThrust.Location": { "documentation": "Determines the relative position where the Force is exerted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyThrust#Location", "code_sample": "" }, "@roblox/globaltype/BodyThrust.location": { "documentation": "Deprecated: This property is a deprecated variant of BodyThrust.Location which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyThrust#location", "code_sample": "" }, "@roblox/globaltype/ReverbSoundEffect": { "documentation": "Reverberates audio, simulating the effect of bouncing off walls in a room.", "keys": { "DecayTime": "@roblox/globaltype/ReverbSoundEffect.DecayTime", "Density": "@roblox/globaltype/ReverbSoundEffect.Density", "Diffusion": "@roblox/globaltype/ReverbSoundEffect.Diffusion", "DryLevel": "@roblox/globaltype/ReverbSoundEffect.DryLevel", "WetLevel": "@roblox/globaltype/ReverbSoundEffect.WetLevel" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReverbSoundEffect", "code_sample": "" }, "@roblox/globaltype/ReverbSoundEffect.DecayTime": { "documentation": "Sets how long it takes for the reverberating echoes to fade out completely.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReverbSoundEffect#DecayTime", "code_sample": "" }, "@roblox/globaltype/ReverbSoundEffect.Density": { "documentation": "Controls how many reflections are generated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReverbSoundEffect#Density", "code_sample": "" }, "@roblox/globaltype/ReverbSoundEffect.Diffusion": { "documentation": "Controls how smooth and reflective the simulated surfaces are.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReverbSoundEffect#Diffusion", "code_sample": "" }, "@roblox/globaltype/ReverbSoundEffect.DryLevel": { "documentation": "The output volume of the original sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReverbSoundEffect#DryLevel", "code_sample": "" }, "@roblox/globaltype/ReverbSoundEffect.WetLevel": { "documentation": "The output volume of the echoed effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReverbSoundEffect#WetLevel", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration": { "documentation": "Configures properties of the default chat window.", "keys": { "AbsolutePosition": "@roblox/globaltype/ChatWindowConfiguration.AbsolutePosition", "AbsoluteSize": "@roblox/globaltype/ChatWindowConfiguration.AbsoluteSize", "BackgroundColor3": "@roblox/globaltype/ChatWindowConfiguration.BackgroundColor3", "BackgroundTransparency": "@roblox/globaltype/ChatWindowConfiguration.BackgroundTransparency", "Enabled": "@roblox/globaltype/ChatWindowConfiguration.Enabled", "FontFace": "@roblox/globaltype/ChatWindowConfiguration.FontFace", "HeightScale": "@roblox/globaltype/ChatWindowConfiguration.HeightScale", "HorizontalAlignment": "@roblox/globaltype/ChatWindowConfiguration.HorizontalAlignment", "TextColor3": "@roblox/globaltype/ChatWindowConfiguration.TextColor3", "TextSize": "@roblox/globaltype/ChatWindowConfiguration.TextSize", "TextStrokeColor3": "@roblox/globaltype/ChatWindowConfiguration.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/ChatWindowConfiguration.TextStrokeTransparency", "VerticalAlignment": "@roblox/globaltype/ChatWindowConfiguration.VerticalAlignment", "WidthScale": "@roblox/globaltype/ChatWindowConfiguration.WidthScale", "DeriveNewMessageProperties": "@roblox/globaltype/ChatWindowConfiguration.DeriveNewMessageProperties" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.AbsolutePosition": { "documentation": "Actual screen position of the default chat window, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#AbsolutePosition", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.AbsoluteSize": { "documentation": "Actual screen size of the default chat window, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#AbsoluteSize", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.BackgroundColor3": { "documentation": "Background color of the default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#BackgroundColor3", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.BackgroundTransparency": { "documentation": "Background transparency of the default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#BackgroundTransparency", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.Enabled": { "documentation": "Whether to show the default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#Enabled", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.FontFace": { "documentation": "Font used to render text in the default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#FontFace", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.HeightScale": { "documentation": "Factor by which the height of the default chat window should be scaled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#HeightScale", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.HorizontalAlignment": { "documentation": "Horizontal alignment of the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#HorizontalAlignment", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.TextColor3": { "documentation": "Color of the text in default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#TextColor3", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.TextSize": { "documentation": "Size of the text in default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#TextSize", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.TextStrokeColor3": { "documentation": "Color of the text stroke for text in default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.TextStrokeTransparency": { "documentation": "Transparency of the text stroke for text in default chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.VerticalAlignment": { "documentation": "Vertical alignment of the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#VerticalAlignment", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.WidthScale": { "documentation": "Factor by which the width of the default chat window should be scaled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#WidthScale", "code_sample": "" }, "@roblox/globaltype/ChatWindowConfiguration.DeriveNewMessageProperties/param/0": { "documentation": "Configures properties of the default chat window." }, "@roblox/globaltype/ChatWindowConfiguration.DeriveNewMessageProperties/return/0": { "documentation": "" }, "@roblox/globaltype/ChatWindowConfiguration.DeriveNewMessageProperties": { "documentation": "Creates a new ChatWindowMessageProperties instance that can be used to customize the appearance of messages in the chat window.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ChatWindowConfiguration.DeriveNewMessageProperties/param/0" } ], "returns": [ "@roblox/globaltype/ChatWindowConfiguration.DeriveNewMessageProperties/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowConfiguration#DeriveNewMessageProperties", "code_sample": "" }, "@roblox/globaltype/SpringConstraint": { "documentation": "Simulates spring and damper behavior between two attachments.", "keys": { "Coils": "@roblox/globaltype/SpringConstraint.Coils", "CurrentLength": "@roblox/globaltype/SpringConstraint.CurrentLength", "Damping": "@roblox/globaltype/SpringConstraint.Damping", "FreeLength": "@roblox/globaltype/SpringConstraint.FreeLength", "LimitsEnabled": "@roblox/globaltype/SpringConstraint.LimitsEnabled", "MaxForce": "@roblox/globaltype/SpringConstraint.MaxForce", "MaxLength": "@roblox/globaltype/SpringConstraint.MaxLength", "MinLength": "@roblox/globaltype/SpringConstraint.MinLength", "Radius": "@roblox/globaltype/SpringConstraint.Radius", "Stiffness": "@roblox/globaltype/SpringConstraint.Stiffness", "Thickness": "@roblox/globaltype/SpringConstraint.Thickness" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.Coils": { "documentation": "The number of coils visualized on the SpringConstraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#Coils", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.CurrentLength": { "documentation": "The current distance between the constraint's Attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#CurrentLength", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.Damping": { "documentation": "Damping constant for the SpringConstraint. Multiplied to the velocity of the constraint's Attachments to reduce the spring force applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#Damping", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.FreeLength": { "documentation": "Natural resting length of the spring.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#FreeLength", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.LimitsEnabled": { "documentation": "Sets whether the SpringConstraint enforces a minimum and maximum length.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.MaxForce": { "documentation": "The maximum force the SpringConstraint can apply on its Attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#MaxForce", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.MaxLength": { "documentation": "The maximum separation the SpringConstraint will allow if LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#MaxLength", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.MinLength": { "documentation": "The minimum separation the SpringConstraint will allow if LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#MinLength", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.Radius": { "documentation": "The visualized radius of the spring's coils.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#Radius", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.Stiffness": { "documentation": "The strength of the spring. The higher this value the more force will be applied when the attachments are separated a different length than the FreeLength.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#Stiffness", "code_sample": "" }, "@roblox/globaltype/SpringConstraint.Thickness": { "documentation": "The visualized thickness of the spring's coils.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpringConstraint#Thickness", "code_sample": "" }, "@roblox/globaltype/ScriptService": { "documentation": "An unimplemented service that has zero functionality, in a similar manner to the LocalWorkspace service.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptService", "code_sample": "" }, "@roblox/globaltype/BaseScript": { "documentation": "The base class for all script objects which run automatically.", "keys": { "Disabled": "@roblox/globaltype/BaseScript.Disabled", "Enabled": "@roblox/globaltype/BaseScript.Enabled", "LinkedSource": "@roblox/globaltype/BaseScript.LinkedSource", "RunContext": "@roblox/globaltype/BaseScript.RunContext" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseScript", "code_sample": "" }, "@roblox/globaltype/BaseScript.Disabled": { "documentation": "Determines whether a BaseScript will run or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseScript#Disabled", "code_sample": "" }, "@roblox/globaltype/BaseScript.Enabled": { "documentation": "Determines whether a BaseScript will run or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseScript#Enabled", "code_sample": "" }, "@roblox/globaltype/BaseScript.LinkedSource": { "documentation": "Deprecated: This property is now replaced by packages which has greater functionality.
The content ID of an uploaded script. When set binds the uploaded code to the script's Script.Source.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseScript#LinkedSource", "code_sample": "" }, "@roblox/globaltype/BaseScript.RunContext": { "documentation": "Determines the context under which the script will run.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BaseScript#RunContext", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud": { "documentation": "A 2D user interface that allows users to capture and save screenshots to their local device.", "keys": { "CameraButtonIcon": "@roblox/globaltype/ScreenshotHud.CameraButtonIcon", "CameraButtonPosition": "@roblox/globaltype/ScreenshotHud.CameraButtonPosition", "CloseButtonPosition": "@roblox/globaltype/ScreenshotHud.CloseButtonPosition", "CloseWhenScreenshotTaken": "@roblox/globaltype/ScreenshotHud.CloseWhenScreenshotTaken", "ExperienceNameOverlayEnabled": "@roblox/globaltype/ScreenshotHud.ExperienceNameOverlayEnabled", "HideCoreGuiForCaptures": "@roblox/globaltype/ScreenshotHud.HideCoreGuiForCaptures", "HidePlayerGuiForCaptures": "@roblox/globaltype/ScreenshotHud.HidePlayerGuiForCaptures", "OverlayFont": "@roblox/globaltype/ScreenshotHud.OverlayFont", "UsernameOverlayEnabled": "@roblox/globaltype/ScreenshotHud.UsernameOverlayEnabled", "Visible": "@roblox/globaltype/ScreenshotHud.Visible" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud", "code_sample": "local GuiService = game:GetService(\"GuiService\")\n\nlocal screenshotHud = GuiService:WaitForChild(\"ScreenshotHud\")\nscreenshotHud.ExperienceNameOverlayEnabled = true\nscreenshotHud.OverlayFont = Enum.Font.GothamMedium\nscreenshotHud.Visible = true" }, "@roblox/globaltype/ScreenshotHud.CameraButtonIcon": { "documentation": "Asset ID of the icon used for the camera button.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonIcon", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.CameraButtonPosition": { "documentation": "Screen location of the camera button.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CameraButtonPosition", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.CloseButtonPosition": { "documentation": "Screen location of the close button.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CloseButtonPosition", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.CloseWhenScreenshotTaken": { "documentation": "Whether the ScreenshotHud closes automatically when a screenshot is taken.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#CloseWhenScreenshotTaken", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.ExperienceNameOverlayEnabled": { "documentation": "Deprecated:
Whether the experience name in the overlay is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#ExperienceNameOverlayEnabled", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.HideCoreGuiForCaptures": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#HideCoreGuiForCaptures", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.HidePlayerGuiForCaptures": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#HidePlayerGuiForCaptures", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.OverlayFont": { "documentation": "Deprecated:
Font used for the experience name in the overlay.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#OverlayFont", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.UsernameOverlayEnabled": { "documentation": "Deprecated:
Currently disabled with no effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#UsernameOverlayEnabled", "code_sample": "" }, "@roblox/globaltype/ScreenshotHud.Visible": { "documentation": "Determines whether the ScreenshotHud is visible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud#Visible", "code_sample": "" }, "@roblox/globaltype/MotorFeature": { "documentation": "Deprecated: A MotorFeature is an unused type of surface joint. It should not be used for new work.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MotorFeature", "code_sample": "" }, "@roblox/globaltype/BuoyancySensor": { "documentation": "A SensorBase that outputs data about how its BasePart is interacting with Terrain water.", "keys": { "FullySubmerged": "@roblox/globaltype/BuoyancySensor.FullySubmerged", "TouchingSurface": "@roblox/globaltype/BuoyancySensor.TouchingSurface" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BuoyancySensor", "code_sample": "" }, "@roblox/globaltype/BuoyancySensor.FullySubmerged": { "documentation": "True when the entirety of the BasePart is submerged in Terrain water with at least one voxel of water above it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BuoyancySensor#FullySubmerged", "code_sample": "" }, "@roblox/globaltype/BuoyancySensor.TouchingSurface": { "documentation": "True when any position on the BasePart is touching Terrain water.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BuoyancySensor#TouchingSurface", "code_sample": "" }, "@roblox/globaltype/PluginMouse": { "documentation": "The PluginMouse object gives Plugins access to the mouse. It works like the Mouse object and can be obtained using the plugin Plugin:GetMouse() method.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMouse", "code_sample": "plugin:Activate(false) -- gain non exclusive access to the mouse\nlocal mouse = plugin:GetMouse()\n\nlocal function button1Down()\n\tprint(\"Left mouse click\")\nend\n\nmouse.Button1Down:Connect(button1Down)" }, "@roblox/globaltype/PluginMouse.DragEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginMouse.DragEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginMouse.DragEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginMouse.DragEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginMouse.DragEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginMouse.DragEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginMouse.DragEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginMouse.DragEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginMouse.DragEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginMouse.DragEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginMouse.DragEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginMouse.DragEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginMouse.DragEnter": { "documentation": "Fired when Instances are being selected while the mouse is dragging.", "keys": { "Connect": "@roblox/globaltype/PluginMouse.DragEnter.Connect", "ConnectParallel": "@roblox/globaltype/PluginMouse.DragEnter.ConnectParallel", "Once": "@roblox/globaltype/PluginMouse.DragEnter.Once", "Wait": "@roblox/globaltype/PluginMouse.DragEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginMouse#DragEnter", "code_sample": "" }, "@roblox/globaltype/BasePlayerGui": { "documentation": "The BasePlayerGui is an abstract class which the GUI drawing storage classes inherit from.", "keys": { "GetGuiObjectsAtPosition": "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePlayerGui", "code_sample": "" }, "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/param/0": { "documentation": "The BasePlayerGui is an abstract class which the GUI drawing storage classes inherit from." }, "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/param/1": { "documentation": "The x position on the screen relative to the top left corner after the GuiInset is applied." }, "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/param/2": { "documentation": "The y position on the screen relative to the top left corner after the GuiInset is applied." }, "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/return/0": { "documentation": "A table of the GuiObject instances that occupy the given screen space." }, "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition": { "documentation": "Returns a list of all GuiObject instances occupying the given point on the screen.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/param/0" }, { "name": "x", "documentation": "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/param/1" }, { "name": "y", "documentation": "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/param/2" } ], "returns": [ "@roblox/globaltype/BasePlayerGui.GetGuiObjectsAtPosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BasePlayerGui#GetGuiObjectsAtPosition", "code_sample": "" }, "@roblox/globaltype/OutfitPages": { "documentation": "The OutfitPages class is used in the case of iterating over a user's outfits.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OutfitPages", "code_sample": "" }, "@roblox/globaltype/Configuration": { "documentation": "The Configuration object is a container object that is designed to hold value objects to make values used in Tools or any model using Scripts more accessible.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Configuration", "code_sample": "" }, "@roblox/globaltype/StudioTestService": { "documentation": "Service allowing plugins to automate and customize Test and Run mode testing.", "keys": { "EndTest": "@roblox/globaltype/StudioTestService.EndTest", "ExecutePlayModeAsync": "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync", "ExecuteRunModeAsync": "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync", "GetTestArgs": "@roblox/globaltype/StudioTestService.GetTestArgs" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTestService", "code_sample": "" }, "@roblox/globaltype/StudioTestService.EndTest/param/0": { "documentation": "Service allowing plugins to automate and customize Test and Run mode testing." }, "@roblox/globaltype/StudioTestService.EndTest/param/1": { "documentation": "Value returned to the calling StudioTestService:ExecutePlayModeAsync() or StudioTestService:ExecuteRunModeAsync() method." }, "@roblox/globaltype/StudioTestService.EndTest": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioTestService.EndTest/param/0" }, { "name": "value", "documentation": "@roblox/globaltype/StudioTestService.EndTest/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTestService#EndTest", "code_sample": "" }, "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync/param/0": { "documentation": "Service allowing plugins to automate and customize Test and Run mode testing." }, "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync/param/1": { "documentation": "Argument passed to the test session, or nil." }, "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync/return/0": { "documentation": "Value passed from StudioTestService:EndTest(), or nil." }, "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync/param/0" }, { "name": "args", "documentation": "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync/param/1" } ], "returns": [ "@roblox/globaltype/StudioTestService.ExecutePlayModeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecutePlayModeAsync", "code_sample": "" }, "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync/param/0": { "documentation": "Service allowing plugins to automate and customize Test and Run mode testing." }, "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync/param/1": { "documentation": "Argument passed to the test session, or nil." }, "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync/return/0": { "documentation": "Value passed from StudioTestService:EndTest(), or nil." }, "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync/param/0" }, { "name": "args", "documentation": "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync/param/1" } ], "returns": [ "@roblox/globaltype/StudioTestService.ExecuteRunModeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTestService#ExecuteRunModeAsync", "code_sample": "" }, "@roblox/globaltype/StudioTestService.GetTestArgs/param/0": { "documentation": "Service allowing plugins to automate and customize Test and Run mode testing." }, "@roblox/globaltype/StudioTestService.GetTestArgs/return/0": { "documentation": "Arguments passed to the test, or nil." }, "@roblox/globaltype/StudioTestService.GetTestArgs": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioTestService.GetTestArgs/param/0" } ], "returns": [ "@roblox/globaltype/StudioTestService.GetTestArgs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioTestService#GetTestArgs", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LineForce instead, and see the legacy conversion notes.
Applies a force so that an assembly follows and faces a target part.", "keys": { "CartoonFactor": "@roblox/globaltype/RocketPropulsion.CartoonFactor", "MaxSpeed": "@roblox/globaltype/RocketPropulsion.MaxSpeed", "MaxThrust": "@roblox/globaltype/RocketPropulsion.MaxThrust", "MaxTorque": "@roblox/globaltype/RocketPropulsion.MaxTorque", "Target": "@roblox/globaltype/RocketPropulsion.Target", "TargetOffset": "@roblox/globaltype/RocketPropulsion.TargetOffset", "TargetRadius": "@roblox/globaltype/RocketPropulsion.TargetRadius", "ThrustD": "@roblox/globaltype/RocketPropulsion.ThrustD", "ThrustP": "@roblox/globaltype/RocketPropulsion.ThrustP", "TurnD": "@roblox/globaltype/RocketPropulsion.TurnD", "TurnP": "@roblox/globaltype/RocketPropulsion.TurnP", "Abort": "@roblox/globaltype/RocketPropulsion.Abort", "Fire": "@roblox/globaltype/RocketPropulsion.Fire", "fire": "@roblox/globaltype/RocketPropulsion.fire" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.CartoonFactor": { "documentation": "Determines the tendency of the assembly to face the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#CartoonFactor", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.MaxSpeed": { "documentation": "Determines the maximum speed at which the assembly will move toward the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#MaxSpeed", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.MaxThrust": { "documentation": "Determines the maximum amount of thrust that will be exerted to move the assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#MaxThrust", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.MaxTorque": { "documentation": "Determines the maximum amount of torque that may be exerted to rotate the assembly towards the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#MaxTorque", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.Target": { "documentation": "Determines the object towards which the assembly should follow/face.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#Target", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.TargetOffset": { "documentation": "Determines the world offset from the Target toward which the force/torque is exerted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#TargetOffset", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.TargetRadius": { "documentation": "Determines the maximum distance from the Target at which the assembly must be in order for ReachedTarget to be fired.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#TargetRadius", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.ThrustD": { "documentation": "Determines the dampening applied to the assembly in order to prevent it from overshooting the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#ThrustD", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.ThrustP": { "documentation": "Determines how aggressive of a force is applied in reaching the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#ThrustP", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.TurnD": { "documentation": "Determines the amount of dampening that to use in reaching the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#TurnD", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.TurnP": { "documentation": "Determines how aggressive of a torque is applied in facing the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#TurnP", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.Abort/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LineForce instead, and see the legacy conversion notes.
Applies a force so that an assembly follows and faces a target part." }, "@roblox/globaltype/RocketPropulsion.Abort": { "documentation": "Causes the assembly to stop moving toward its Target.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.Abort/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#Abort", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.Fire/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LineForce instead, and see the legacy conversion notes.
Applies a force so that an assembly follows and faces a target part." }, "@roblox/globaltype/RocketPropulsion.Fire": { "documentation": "Causes the assembly to start moving toward its Target.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.Fire/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#Fire", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.fire/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use LineForce instead, and see the legacy conversion notes.
Applies a force so that an assembly follows and faces a target part." }, "@roblox/globaltype/RocketPropulsion.fire": { "documentation": "Deprecated: This function is a deprecated variant of RocketPropulsion:Fire() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.fire/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#fire", "code_sample": "" }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RocketPropulsion.ReachedTarget.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RocketPropulsion.ReachedTarget": { "documentation": "Fires when the assembly comes within TargetRadius of the Target.", "keys": { "Connect": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Connect", "ConnectParallel": "@roblox/globaltype/RocketPropulsion.ReachedTarget.ConnectParallel", "Once": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Once", "Wait": "@roblox/globaltype/RocketPropulsion.ReachedTarget.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RocketPropulsion#ReachedTarget", "code_sample": "" }, "@roblox/globaltype/ManualGlue": { "documentation": "Deprecated:
ManualGlue is a joint created in a similar manner to the ManualWeld class. It functions identically to the Glue class.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ManualGlue", "code_sample": "" }, "@roblox/globaltype/WorkspaceAnnotation": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorkspaceAnnotation", "code_sample": "" }, "@roblox/globaltype/MultipleDocumentInterfaceInstance": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MultipleDocumentInterfaceInstance", "code_sample": "" }, "@roblox/globaltype/ServerReplicator": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServerReplicator", "code_sample": "" }, "@roblox/globaltype/TeleportOptions": { "documentation": "Optional input arguments to the TeleportService:TeleportAsync() function.", "keys": { "ReservedServerAccessCode": "@roblox/globaltype/TeleportOptions.ReservedServerAccessCode", "ServerInstanceId": "@roblox/globaltype/TeleportOptions.ServerInstanceId", "ShouldReserveServer": "@roblox/globaltype/TeleportOptions.ShouldReserveServer", "GetTeleportData": "@roblox/globaltype/TeleportOptions.GetTeleportData", "SetTeleportData": "@roblox/globaltype/TeleportOptions.SetTeleportData" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportOptions", "code_sample": "" }, "@roblox/globaltype/TeleportOptions.ReservedServerAccessCode": { "documentation": "The reserved server access code that indicates the reserved server that the teleport should be to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#ReservedServerAccessCode", "code_sample": "" }, "@roblox/globaltype/TeleportOptions.ServerInstanceId": { "documentation": "The DataModel.JobId of the server instance to teleport to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#ServerInstanceId", "code_sample": "" }, "@roblox/globaltype/TeleportOptions.ShouldReserveServer": { "documentation": "A flag to indicate if a reserved server should be allocated and the players should then be teleported to this allocation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#ShouldReserveServer", "code_sample": "" }, "@roblox/globaltype/TeleportOptions.GetTeleportData/param/0": { "documentation": "Optional input arguments to the TeleportService:TeleportAsync() function." }, "@roblox/globaltype/TeleportOptions.GetTeleportData/return/0": { "documentation": "" }, "@roblox/globaltype/TeleportOptions.GetTeleportData": { "documentation": "Returns the teleport data stored in the TeleportOptions instance by TeleportOptions:SetTeleportData().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportOptions.GetTeleportData/param/0" } ], "returns": [ "@roblox/globaltype/TeleportOptions.GetTeleportData/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#GetTeleportData", "code_sample": "" }, "@roblox/globaltype/TeleportOptions.SetTeleportData/param/0": { "documentation": "Optional input arguments to the TeleportService:TeleportAsync() function." }, "@roblox/globaltype/TeleportOptions.SetTeleportData/param/1": { "documentation": "Data to be passed to the destination place." }, "@roblox/globaltype/TeleportOptions.SetTeleportData": { "documentation": "Setter function for data to be passed to the destination place.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportOptions.SetTeleportData/param/0" }, { "name": "teleportData", "documentation": "@roblox/globaltype/TeleportOptions.SetTeleportData/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportOptions#SetTeleportData", "code_sample": "" }, "@roblox/globaltype/ArcHandles": { "documentation": "The ArcHandles object places 3D arc handles around any 3D object that its Adornee is set to.", "keys": { "Axes": "@roblox/globaltype/ArcHandles.Axes" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles", "code_sample": "" }, "@roblox/globaltype/ArcHandles.Axes": { "documentation": "Sets the current Axes ArcHandles will show.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles#Axes", "code_sample": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Down": { "documentation": "Fired when the left mouse button goes down on one of the GUI handles.", "keys": { "Connect": "@roblox/globaltype/ArcHandles.MouseButton1Down.Connect", "ConnectParallel": "@roblox/globaltype/ArcHandles.MouseButton1Down.ConnectParallel", "Once": "@roblox/globaltype/ArcHandles.MouseButton1Down.Once", "Wait": "@roblox/globaltype/ArcHandles.MouseButton1Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles#MouseButton1Down", "code_sample": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseButton1Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseButton1Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseButton1Up": { "documentation": "Fired when the left mouse button is released on one of the GUI handles.", "keys": { "Connect": "@roblox/globaltype/ArcHandles.MouseButton1Up.Connect", "ConnectParallel": "@roblox/globaltype/ArcHandles.MouseButton1Up.ConnectParallel", "Once": "@roblox/globaltype/ArcHandles.MouseButton1Up.Once", "Wait": "@roblox/globaltype/ArcHandles.MouseButton1Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles#MouseButton1Up", "code_sample": "" }, "@roblox/globaltype/ArcHandles.MouseDrag.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseDrag.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseDrag.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseDrag.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseDrag.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseDrag.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseDrag.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseDrag.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseDrag.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseDrag.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseDrag.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseDrag.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseDrag": { "documentation": "Fired when the mouse moves while the MouseButton1Down event has fired, but the left mouse button has not been released yet.", "keys": { "Connect": "@roblox/globaltype/ArcHandles.MouseDrag.Connect", "ConnectParallel": "@roblox/globaltype/ArcHandles.MouseDrag.ConnectParallel", "Once": "@roblox/globaltype/ArcHandles.MouseDrag.Once", "Wait": "@roblox/globaltype/ArcHandles.MouseDrag.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles#MouseDrag", "code_sample": "" }, "@roblox/globaltype/ArcHandles.MouseEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseEnter": { "documentation": "Fired when a mouse \"enters\" the GUI handle.", "keys": { "Connect": "@roblox/globaltype/ArcHandles.MouseEnter.Connect", "ConnectParallel": "@roblox/globaltype/ArcHandles.MouseEnter.ConnectParallel", "Once": "@roblox/globaltype/ArcHandles.MouseEnter.Once", "Wait": "@roblox/globaltype/ArcHandles.MouseEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles#MouseEnter", "code_sample": "" }, "@roblox/globaltype/ArcHandles.MouseLeave.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseLeave.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseLeave.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseLeave.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseLeave.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseLeave.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseLeave.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseLeave.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ArcHandles.MouseLeave.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseLeave.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ArcHandles.MouseLeave.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ArcHandles.MouseLeave.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ArcHandles.MouseLeave": { "documentation": "Fired when the mouse leaves the GUI handle.", "keys": { "Connect": "@roblox/globaltype/ArcHandles.MouseLeave.Connect", "ConnectParallel": "@roblox/globaltype/ArcHandles.MouseLeave.ConnectParallel", "Once": "@roblox/globaltype/ArcHandles.MouseLeave.Once", "Wait": "@roblox/globaltype/ArcHandles.MouseLeave.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ArcHandles#MouseLeave", "code_sample": "" }, "@roblox/globaltype/DraftsService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DraftsService", "code_sample": "" }, "@roblox/globaltype/PlayerScripts": { "documentation": "A container for LocalScripts to be run on the client.", "keys": { "ClearComputerCameraMovementModes": "@roblox/globaltype/PlayerScripts.ClearComputerCameraMovementModes", "ClearComputerMovementModes": "@roblox/globaltype/PlayerScripts.ClearComputerMovementModes", "ClearTouchCameraMovementModes": "@roblox/globaltype/PlayerScripts.ClearTouchCameraMovementModes", "ClearTouchMovementModes": "@roblox/globaltype/PlayerScripts.ClearTouchMovementModes", "RegisterComputerCameraMovementMode": "@roblox/globaltype/PlayerScripts.RegisterComputerCameraMovementMode", "RegisterComputerMovementMode": "@roblox/globaltype/PlayerScripts.RegisterComputerMovementMode", "RegisterTouchCameraMovementMode": "@roblox/globaltype/PlayerScripts.RegisterTouchCameraMovementMode", "RegisterTouchMovementMode": "@roblox/globaltype/PlayerScripts.RegisterTouchMovementMode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.ClearComputerCameraMovementModes/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.ClearComputerCameraMovementModes": { "documentation": "Unregisters all ComputerCameraMovementMode enums from the experience's settings menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.ClearComputerCameraMovementModes/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearComputerCameraMovementModes", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.ClearComputerMovementModes/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.ClearComputerMovementModes": { "documentation": "Unregisters all ComputerMovementMode enums from the experience's settings menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.ClearComputerMovementModes/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearComputerMovementModes", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.ClearTouchCameraMovementModes/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.ClearTouchCameraMovementModes": { "documentation": "Unregisters all TouchCameraMovementMode enums from the experience's settings menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.ClearTouchCameraMovementModes/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearTouchCameraMovementModes", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.ClearTouchMovementModes/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.ClearTouchMovementModes": { "documentation": "Unregisters all TouchMovementMode enums from the experience's settings menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.ClearTouchMovementModes/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#ClearTouchMovementModes", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.RegisterComputerCameraMovementMode/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.RegisterComputerCameraMovementMode/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerScripts.RegisterComputerCameraMovementMode": { "documentation": "Registers that a computer camera movement mode is available to be selected from the game menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.RegisterComputerCameraMovementMode/param/0" }, { "name": "cameraMovementMode", "documentation": "@roblox/globaltype/PlayerScripts.RegisterComputerCameraMovementMode/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerCameraMovementMode", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.RegisterComputerMovementMode/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.RegisterComputerMovementMode/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerScripts.RegisterComputerMovementMode": { "documentation": "Registers that a computer movement mode is available to be selected from the game menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.RegisterComputerMovementMode/param/0" }, { "name": "movementMode", "documentation": "@roblox/globaltype/PlayerScripts.RegisterComputerMovementMode/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterComputerMovementMode", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.RegisterTouchCameraMovementMode/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.RegisterTouchCameraMovementMode/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerScripts.RegisterTouchCameraMovementMode": { "documentation": "Registers that a touch camera movement mode is available to be selected from the game menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.RegisterTouchCameraMovementMode/param/0" }, { "name": "cameraMovementMode", "documentation": "@roblox/globaltype/PlayerScripts.RegisterTouchCameraMovementMode/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchCameraMovementMode", "code_sample": "" }, "@roblox/globaltype/PlayerScripts.RegisterTouchMovementMode/param/0": { "documentation": "A container for LocalScripts to be run on the client." }, "@roblox/globaltype/PlayerScripts.RegisterTouchMovementMode/param/1": { "documentation": "" }, "@roblox/globaltype/PlayerScripts.RegisterTouchMovementMode": { "documentation": "Registers that a touch movement mode is available to be selected from the game menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerScripts.RegisterTouchMovementMode/param/0" }, { "name": "movementMode", "documentation": "@roblox/globaltype/PlayerScripts.RegisterTouchMovementMode/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerScripts#RegisterTouchMovementMode", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataProperties": { "documentation": "Acts as a Folder containing information about properties for a ReflectionMetadataClass, and should be parented to it. ReflectionMetadataMembers that are parented to this object will be perceived as properties under the class this is parented to.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataProperties", "code_sample": "" }, "@roblox/globaltype/KeyframeSequenceProvider": { "documentation": "Provides functions to load and preview KeyframeSequence.", "keys": { "GetAnimationsAsync": "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync", "GetAnimations": "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations", "GetKeyframeSequence": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence", "GetKeyframeSequenceAsync": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync", "GetKeyframeSequenceById": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById", "RegisterActiveKeyframeSequence": "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence", "RegisterKeyframeSequence": "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider", "code_sample": "" }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync/param/1": { "documentation": "The user ID of the user." }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync/return/0": { "documentation": "An InventoryPages of animations." }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync": { "documentation": "This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync/param/1" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.GetAnimationsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetAnimationsAsync", "code_sample": "local KeyframeSequenceProvider = game:GetService(\"KeyframeSequenceProvider\")\n\nlocal USER_ID = 0 -- Insert your UserId here\n\nlocal function extractPages(pagesObject)\n\tlocal array = {}\n\twhile true do\n\t\tlocal thisPage = pagesObject:GetCurrentPage()\n\t\tfor _, v in pairs(thisPage) do\n\t\t\ttable.insert(array, v)\n\t\tend\n\t\tif pagesObject.IsFinished then\n\t\t\tbreak\n\t\tend\n\t\tpagesObject:AdvanceToNextPageAsync()\n\tend\n\treturn array\nend\n\nlocal inventoryPages = KeyframeSequenceProvider:GetAnimationsAsync(USER_ID)\n\nlocal animationIds = extractPages(inventoryPages)\n\nfor _, id in pairs(animationIds) do\n\tprint(id)\nend\nprint(\"total: \", #animationIds)" }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations/param/1": { "documentation": "The user ID of the user." }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations/return/0": { "documentation": "An InventoryPages of animations." }, "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations": { "documentation": "Deprecated:
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations/param/1" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.GetAnimations/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetAnimations", "code_sample": "local KeyframeSequenceProvider = game:GetService(\"KeyframeSequenceProvider\")\n\nlocal USER_ID = 0 -- Insert your UserId here\n\nlocal function extractPages(pagesObject)\n\tlocal array = {}\n\twhile true do\n\t\tlocal thisPage = pagesObject:GetCurrentPage()\n\t\tfor _, v in pairs(thisPage) do\n\t\t\ttable.insert(array, v)\n\t\tend\n\t\tif pagesObject.IsFinished then\n\t\t\tbreak\n\t\tend\n\t\tpagesObject:AdvanceToNextPageAsync()\n\tend\n\treturn array\nend\n\nlocal inventoryPages = KeyframeSequenceProvider:GetAnimationsAsync(USER_ID)\n\nlocal animationIds = extractPages(inventoryPages)\n\nfor _, id in pairs(animationIds) do\n\tprint(id)\nend\nprint(\"total: \", #animationIds)" }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence/param/1": { "documentation": "The content ID of the animation." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence/return/0": { "documentation": "The KeyframeSequence found." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence": { "documentation": "Deprecated: This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use KeyframeSequenceProvider:GetKeyframeSequenceAsync() instead.
Returns a KeyframeSequence from a given asset URL.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence/param/1" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequence/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetKeyframeSequence", "code_sample": "" }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync/param/1": { "documentation": "The content ID of the animation." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync/return/0": { "documentation": "The KeyframeSequence found." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync": { "documentation": "Returns a KeyframeSequence based on the specified assetId asynchronously.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync/param/1" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetKeyframeSequenceAsync", "code_sample": "" }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/param/1": { "documentation": "The content ID of the animation." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/param/2": { "documentation": "True if a cached version can be returned." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/return/0": { "documentation": "The KeyframeSequence found." }, "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById": { "documentation": "Deprecated: This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use KeyframeSequenceProvider:GetKeyframeSequenceAsync() instead.
Returns a KeyframeSequence from the supplied assetId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/param/1" }, { "name": "useCache", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/param/2" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.GetKeyframeSequenceById/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetKeyframeSequenceById", "code_sample": "" }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence/param/1": { "documentation": "The KeyframeSequence to be used." }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence/return/0": { "documentation": "A temporary asset ID generated for localized animation playback." }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence": { "documentation": "Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation. Generates an active:// URL.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence/param/0" }, { "name": "keyframeSequence", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence/param/1" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.RegisterActiveKeyframeSequence/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#RegisterActiveKeyframeSequence", "code_sample": "" }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence/param/0": { "documentation": "Provides functions to load and preview KeyframeSequence." }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence/param/1": { "documentation": "The KeyframeSequence to be used." }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence/return/0": { "documentation": "A temporary asset ID generated for localized animation playback." }, "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence": { "documentation": "Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation. Generates a hash.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence/param/0" }, { "name": "keyframeSequence", "documentation": "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence/param/1" } ], "returns": [ "@roblox/globaltype/KeyframeSequenceProvider.RegisterKeyframeSequence/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#RegisterKeyframeSequence", "code_sample": "" }, "@roblox/globaltype/AudioFlanger": { "documentation": "Imparts a whooshing or sweeping sound on audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioFlanger.Bypass", "Depth": "@roblox/globaltype/AudioFlanger.Depth", "Mix": "@roblox/globaltype/AudioFlanger.Mix", "Rate": "@roblox/globaltype/AudioFlanger.Rate", "GetConnectedWires": "@roblox/globaltype/AudioFlanger.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioFlanger.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioFlanger.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.Depth": { "documentation": "Controls how strong the pitch modulation of the flanger is.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#Depth", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.Mix": { "documentation": "Controls the balance of plain input stream to modified output stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#Mix", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.Rate": { "documentation": "Controls the rate of pitch modulations.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#Rate", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.GetConnectedWires/param/0": { "documentation": "Imparts a whooshing or sweeping sound on audio streams." }, "@roblox/globaltype/AudioFlanger.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioFlanger.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioFlanger.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.GetInputPins/param/0": { "documentation": "Imparts a whooshing or sweeping sound on audio streams." }, "@roblox/globaltype/AudioFlanger.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioFlanger.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.GetOutputPins/param/0": { "documentation": "Imparts a whooshing or sweeping sound on audio streams." }, "@roblox/globaltype/AudioFlanger.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioFlanger.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioFlanger.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFlanger.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFlanger.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFlanger.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFlanger.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFlanger.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFlanger.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFlanger.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFlanger.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFlanger.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioFlanger.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioFlanger via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioFlanger.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioFlanger.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioFlanger.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioFlanger.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#WiringChanged", "code_sample": "" }, "@roblox/globaltype/UIAspectRatioConstraint": { "documentation": "Ensures the parent UI element maintains a particular aspect ratio.", "keys": { "AspectRatio": "@roblox/globaltype/UIAspectRatioConstraint.AspectRatio", "AspectType": "@roblox/globaltype/UIAspectRatioConstraint.AspectType", "DominantAxis": "@roblox/globaltype/UIAspectRatioConstraint.DominantAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIAspectRatioConstraint", "code_sample": "" }, "@roblox/globaltype/UIAspectRatioConstraint.AspectRatio": { "documentation": "Determines the width-to-height ratio to maintain.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIAspectRatioConstraint#AspectRatio", "code_sample": "" }, "@roblox/globaltype/UIAspectRatioConstraint.AspectType": { "documentation": "Determines how the maximum size of the object is limited.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIAspectRatioConstraint#AspectType", "code_sample": "" }, "@roblox/globaltype/UIAspectRatioConstraint.DominantAxis": { "documentation": "Determines the axis to use when setting the new size of the object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIAspectRatioConstraint#DominantAxis", "code_sample": "" }, "@roblox/globaltype/TotalCountTimeIntervalItem": { "documentation": "Measures a total-count-over-time interval.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TotalCountTimeIntervalItem", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadata": { "documentation": "A currently unused object whose functionality was split into ReflectionMetadataClasses and ReflectionMetadataEnums.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadata", "code_sample": "" }, "@roblox/globaltype/GuiService": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks.", "keys": { "AutoSelectGuiEnabled": "@roblox/globaltype/GuiService.AutoSelectGuiEnabled", "CoreGuiNavigationEnabled": "@roblox/globaltype/GuiService.CoreGuiNavigationEnabled", "GuiNavigationEnabled": "@roblox/globaltype/GuiService.GuiNavigationEnabled", "IsModalDialog": "@roblox/globaltype/GuiService.IsModalDialog", "IsWindows": "@roblox/globaltype/GuiService.IsWindows", "MenuIsOpen": "@roblox/globaltype/GuiService.MenuIsOpen", "PreferredTextSize": "@roblox/globaltype/GuiService.PreferredTextSize", "PreferredTransparency": "@roblox/globaltype/GuiService.PreferredTransparency", "ReducedMotionEnabled": "@roblox/globaltype/GuiService.ReducedMotionEnabled", "SelectedObject": "@roblox/globaltype/GuiService.SelectedObject", "TopbarInset": "@roblox/globaltype/GuiService.TopbarInset", "TouchControlsEnabled": "@roblox/globaltype/GuiService.TouchControlsEnabled", "ViewportDisplaySize": "@roblox/globaltype/GuiService.ViewportDisplaySize", "AddSelectionParent": "@roblox/globaltype/GuiService.AddSelectionParent", "AddSelectionTuple": "@roblox/globaltype/GuiService.AddSelectionTuple", "CloseInspectMenu": "@roblox/globaltype/GuiService.CloseInspectMenu", "DismissNotification": "@roblox/globaltype/GuiService.DismissNotification", "GetEmotesMenuOpen": "@roblox/globaltype/GuiService.GetEmotesMenuOpen", "GetGameplayPausedNotificationEnabled": "@roblox/globaltype/GuiService.GetGameplayPausedNotificationEnabled", "GetGuiInset": "@roblox/globaltype/GuiService.GetGuiInset", "GetInspectMenuEnabled": "@roblox/globaltype/GuiService.GetInspectMenuEnabled", "InspectPlayerFromHumanoidDescription": "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription", "InspectPlayerFromUserId": "@roblox/globaltype/GuiService.InspectPlayerFromUserId", "IsTenFootInterface": "@roblox/globaltype/GuiService.IsTenFootInterface", "RemoveSelectionGroup": "@roblox/globaltype/GuiService.RemoveSelectionGroup", "Select": "@roblox/globaltype/GuiService.Select", "SendNotification": "@roblox/globaltype/GuiService.SendNotification", "SetEmotesMenuOpen": "@roblox/globaltype/GuiService.SetEmotesMenuOpen", "SetGameplayPausedNotificationEnabled": "@roblox/globaltype/GuiService.SetGameplayPausedNotificationEnabled", "SetInspectMenuEnabled": "@roblox/globaltype/GuiService.SetInspectMenuEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService", "code_sample": "" }, "@roblox/globaltype/GuiService.AutoSelectGuiEnabled": { "documentation": "If activated, the Select button on a gamepad or Backslash will automatically set a GUI as the selected object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#AutoSelectGuiEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.CoreGuiNavigationEnabled": { "documentation": "Toggles whether or not objects in the CoreGui can be navigated using a gamepad.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#CoreGuiNavigationEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.GuiNavigationEnabled": { "documentation": "Used to enable and disable the default controller GUI navigation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#GuiNavigationEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.IsModalDialog": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.
Indicates whether a modal dialog is visible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#IsModalDialog", "code_sample": "" }, "@roblox/globaltype/GuiService.IsWindows": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.
Indicates whether the user is playing on a computer running Windows.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#IsWindows", "code_sample": "" }, "@roblox/globaltype/GuiService.MenuIsOpen": { "documentation": "Returns true if any menu of CoreGui is open.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#MenuIsOpen", "code_sample": "" }, "@roblox/globaltype/GuiService.PreferredTextSize": { "documentation": "Gets the player's preferred text size as an PreferredTextSize value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#PreferredTextSize", "code_sample": "" }, "@roblox/globaltype/GuiService.PreferredTransparency": { "documentation": "Gets the player's preferred transparency as a number between 0 and 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#PreferredTransparency", "code_sample": "" }, "@roblox/globaltype/GuiService.ReducedMotionEnabled": { "documentation": "Returns true if the player has enabled reduced motion.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#ReducedMotionEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.SelectedObject": { "documentation": "Sets the GuiObject currently being focused on by the GUI navigator.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#SelectedObject", "code_sample": "" }, "@roblox/globaltype/GuiService.TopbarInset": { "documentation": "Used to determine the absolute size and position of unobstructed area within top bar space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#TopbarInset", "code_sample": "local GuiService = game:GetService(\"GuiService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal screenGui = Instance.new(\"ScreenGui\")\nscreenGui.IgnoreGuiInset = true\nscreenGui.Parent = Players.LocalPlayer.PlayerGui\n\nlocal frame = Instance.new(\"Frame\")\nframe.BackgroundColor3 = Color3.fromRGB(0, 255, 0)\nframe.Parent = screenGui\n\nGuiService:GetPropertyChangedSignal(\"TopbarInset\"):Connect(function()\n\tlocal inset = GuiService.TopbarInset\n\tframe.Size = UDim2.new(0, inset.Width, 0, inset.Height)\n\tframe.Position = UDim2.new(0, inset.Min.X, 0, inset.Min.Y)\nend)" }, "@roblox/globaltype/GuiService.TouchControlsEnabled": { "documentation": "Used to enable and disable touch controls and touch control display UI. Defaults to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#TouchControlsEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.ViewportDisplaySize": { "documentation": "Read-only property which represents the physical rendering size of the viewport.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#ViewportDisplaySize", "code_sample": "local GuiService = game:GetService(\"GuiService\")\n\nlocal function updateUI()\n\tif (GuiService.ViewportDisplaySize == Enum.DisplaySize.Small) then\n\t\t-- Update UI to small screen\n\telseif (GuiService.ViewportDisplaySize == Enum.DisplaySize.Large) then\n\t\t-- Update UI to large screen\n\telse\n\t\t-- Update UI to medium/default screen\n\tend\nend\n\nGuiService:GetPropertyChangedSignal(\"ViewportDisplaySize\"):Connect(updateUI)\nupdateUI()" }, "@roblox/globaltype/GuiService.AddSelectionParent/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.AddSelectionParent/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.AddSelectionParent/param/2": { "documentation": "" }, "@roblox/globaltype/GuiService.AddSelectionParent": { "documentation": "Deprecated:
Creates a selection group where gamepad GUI navigation will only consider selectable objects that are within the group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.AddSelectionParent/param/0" }, { "name": "selectionName", "documentation": "@roblox/globaltype/GuiService.AddSelectionParent/param/1" }, { "name": "selectionParent", "documentation": "@roblox/globaltype/GuiService.AddSelectionParent/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionParent", "code_sample": "" }, "@roblox/globaltype/GuiService.AddSelectionTuple/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.AddSelectionTuple/param/1": { "documentation": "The name of the added selection." }, "@roblox/globaltype/GuiService.AddSelectionTuple/param/2": { "documentation": "The selection(s) added." }, "@roblox/globaltype/GuiService.AddSelectionTuple": { "documentation": "Deprecated:
AddSelectionTuple works similarly to GuiService:AddSelectionParent(), but you can give it a tuple of GuiObject that you want to be contained in the group. Beware that the second argument is not a table, but rather the first of several GuiObject in the tuple. To pass the contents of a table, use unpack/unpack: 
local frame = script.Parent -- Passing various GuiObject individually GuiService:AddSelectionTuple("InventoryButtons", frame.Sort, frame.Trash, frame.Drop) -- Unpacking a table of GuiObject (unpack/table.unpack are equivalent) local inventoryButtons = { frame.Sort, frame.Trash, frame.Drop } GuiService:AddSelectionTuple("InventoryButtons", unpack(inventoryButtons))
", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.AddSelectionTuple/param/0" }, { "name": "selectionName", "documentation": "@roblox/globaltype/GuiService.AddSelectionTuple/param/1" }, { "name": "selections", "documentation": "@roblox/globaltype/GuiService.AddSelectionTuple/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#AddSelectionTuple", "code_sample": "" }, "@roblox/globaltype/GuiService.CloseInspectMenu/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.CloseInspectMenu": { "documentation": "Closes the avatar inspection menu, if open.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.CloseInspectMenu/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#CloseInspectMenu", "code_sample": "" }, "@roblox/globaltype/GuiService.DismissNotification/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.DismissNotification/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.DismissNotification/return/0": { "documentation": "" }, "@roblox/globaltype/GuiService.DismissNotification": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.DismissNotification/param/0" }, { "name": "notificationId", "documentation": "@roblox/globaltype/GuiService.DismissNotification/param/1" } ], "returns": [ "@roblox/globaltype/GuiService.DismissNotification/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#DismissNotification", "code_sample": "" }, "@roblox/globaltype/GuiService.GetEmotesMenuOpen/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.GetEmotesMenuOpen/return/0": { "documentation": "Whether the emotes menu is open." }, "@roblox/globaltype/GuiService.GetEmotesMenuOpen": { "documentation": "Checks if the player emotes menu is open.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.GetEmotesMenuOpen/param/0" } ], "returns": [ "@roblox/globaltype/GuiService.GetEmotesMenuOpen/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#GetEmotesMenuOpen", "code_sample": "" }, "@roblox/globaltype/GuiService.GetGameplayPausedNotificationEnabled/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.GetGameplayPausedNotificationEnabled/return/0": { "documentation": "Whether or not the Player.GameplayPaused notification has been disabled." }, "@roblox/globaltype/GuiService.GetGameplayPausedNotificationEnabled": { "documentation": "Returns whether or not the Player.GameplayPaused notification has been disabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.GetGameplayPausedNotificationEnabled/param/0" } ], "returns": [ "@roblox/globaltype/GuiService.GetGameplayPausedNotificationEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGameplayPausedNotificationEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.GetGuiInset/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.GetGuiInset/return/0": { "documentation": "A tuple of two Vector2 values describing the current specified GUI inset." }, "@roblox/globaltype/GuiService.GetGuiInset": { "documentation": "Returns two Vector2 values representing the inset of user GUIs in pixels, from the top‑left corner of the screen and the bottom‑right corner of the screen respectively.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.GetGuiInset/param/0" } ], "returns": [ "@roblox/globaltype/GuiService.GetGuiInset/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#GetGuiInset", "code_sample": "" }, "@roblox/globaltype/GuiService.GetInspectMenuEnabled/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.GetInspectMenuEnabled/return/0": { "documentation": "Whether the avatar inspection menu is enabled." }, "@roblox/globaltype/GuiService.GetInspectMenuEnabled": { "documentation": "Returns whether the avatar inspection menu is enabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.GetInspectMenuEnabled/param/0" } ], "returns": [ "@roblox/globaltype/GuiService.GetInspectMenuEnabled/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInspectMenuEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription/param/1": { "documentation": "A HumanoidDescription object that contains the assets to show in the inspection menu." }, "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription/param/2": { "documentation": "The name of the player being inspected to show in the menu." }, "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription": { "documentation": "Allows the avatar inspection menu to appear showing the assets listed in a HumanoidDescription object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription/param/1" }, { "name": "name", "documentation": "@roblox/globaltype/GuiService.InspectPlayerFromHumanoidDescription/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromHumanoidDescription", "code_sample": "" }, "@roblox/globaltype/GuiService.InspectPlayerFromUserId/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.InspectPlayerFromUserId/param/1": { "documentation": "The UserId of the player to inspect." }, "@roblox/globaltype/GuiService.InspectPlayerFromUserId": { "documentation": "Allows the avatar inspection menu to appear showing the user that has the given UserId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.InspectPlayerFromUserId/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/GuiService.InspectPlayerFromUserId/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#InspectPlayerFromUserId", "code_sample": "" }, "@roblox/globaltype/GuiService.IsTenFootInterface/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.IsTenFootInterface/return/0": { "documentation": "" }, "@roblox/globaltype/GuiService.IsTenFootInterface": { "documentation": "Returns true if the client is using the ten foot interface, a special version of Roblox's UI exclusive to consoles.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.IsTenFootInterface/param/0" } ], "returns": [ "@roblox/globaltype/GuiService.IsTenFootInterface/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#IsTenFootInterface", "code_sample": "" }, "@roblox/globaltype/GuiService.RemoveSelectionGroup/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.RemoveSelectionGroup/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.RemoveSelectionGroup": { "documentation": "Deprecated:
Removes a group that was created with AddSelectionParent() or AddSelectionTuple().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.RemoveSelectionGroup/param/0" }, { "name": "selectionName", "documentation": "@roblox/globaltype/GuiService.RemoveSelectionGroup/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#RemoveSelectionGroup", "code_sample": "" }, "@roblox/globaltype/GuiService.Select/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.Select/param/1": { "documentation": "The parent of selection whose descendants are searched." }, "@roblox/globaltype/GuiService.Select": { "documentation": "Sets GuiService.SelectedObject to a child of a provided instance that is the PlayerGui or its descendants.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.Select/param/0" }, { "name": "selectionParent", "documentation": "@roblox/globaltype/GuiService.Select/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#Select", "code_sample": "" }, "@roblox/globaltype/GuiService.SendNotification/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.SendNotification/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.SendNotification/return/0": { "documentation": "" }, "@roblox/globaltype/GuiService.SendNotification": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.SendNotification/param/0" }, { "name": "notificationInfo", "documentation": "@roblox/globaltype/GuiService.SendNotification/param/1" } ], "returns": [ "@roblox/globaltype/GuiService.SendNotification/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#SendNotification", "code_sample": "" }, "@roblox/globaltype/GuiService.SetEmotesMenuOpen/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.SetEmotesMenuOpen/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.SetEmotesMenuOpen": { "documentation": "Opens or closes the player emotes menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.SetEmotesMenuOpen/param/0" }, { "name": "isOpen", "documentation": "@roblox/globaltype/GuiService.SetEmotesMenuOpen/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#SetEmotesMenuOpen", "code_sample": "" }, "@roblox/globaltype/GuiService.SetGameplayPausedNotificationEnabled/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.SetGameplayPausedNotificationEnabled/param/1": { "documentation": "Whether or not the built-in notification GUI is disabled." }, "@roblox/globaltype/GuiService.SetGameplayPausedNotificationEnabled": { "documentation": "Lets you disable the built-in notification when a player's gameplay is paused.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.SetGameplayPausedNotificationEnabled/param/0" }, { "name": "enabled", "documentation": "@roblox/globaltype/GuiService.SetGameplayPausedNotificationEnabled/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#SetGameplayPausedNotificationEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.SetInspectMenuEnabled/param/0": { "documentation": "Offers numerous properties and methods for working with GuiObjects, player preferences, and other UI‑related tasks." }, "@roblox/globaltype/GuiService.SetInspectMenuEnabled/param/1": { "documentation": "A boolean indicating whether to enable or disable the menu." }, "@roblox/globaltype/GuiService.SetInspectMenuEnabled": { "documentation": "Allows you to enable or disable the avatar inspection menu.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.SetInspectMenuEnabled/param/0" }, { "name": "enabled", "documentation": "@roblox/globaltype/GuiService.SetInspectMenuEnabled/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#SetInspectMenuEnabled", "code_sample": "" }, "@roblox/globaltype/GuiService.MenuClosed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuClosed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.MenuClosed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuClosed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiService.MenuClosed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuClosed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuClosed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.MenuClosed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuClosed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiService.MenuClosed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuClosed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuClosed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.MenuClosed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuClosed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiService.MenuClosed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuClosed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuClosed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuClosed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuClosed": { "documentation": "Fires when the user closes the Roblox CoreGui escape menu.", "keys": { "Connect": "@roblox/globaltype/GuiService.MenuClosed.Connect", "ConnectParallel": "@roblox/globaltype/GuiService.MenuClosed.ConnectParallel", "Once": "@roblox/globaltype/GuiService.MenuClosed.Once", "Wait": "@roblox/globaltype/GuiService.MenuClosed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#MenuClosed", "code_sample": "" }, "@roblox/globaltype/GuiService.MenuOpened.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuOpened.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.MenuOpened.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuOpened.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiService.MenuOpened.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuOpened.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuOpened.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.MenuOpened.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuOpened.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiService.MenuOpened.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuOpened.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuOpened.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiService.MenuOpened.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuOpened.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiService.MenuOpened.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuOpened.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiService.MenuOpened.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiService.MenuOpened.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiService.MenuOpened": { "documentation": "Fires when the user opens the Roblox CoreGui escape menu.", "keys": { "Connect": "@roblox/globaltype/GuiService.MenuOpened.Connect", "ConnectParallel": "@roblox/globaltype/GuiService.MenuOpened.ConnectParallel", "Once": "@roblox/globaltype/GuiService.MenuOpened.Once", "Wait": "@roblox/globaltype/GuiService.MenuOpened.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiService#MenuOpened", "code_sample": "" }, "@roblox/globaltype/MeshContentProvider": { "documentation": "An internal Roblox service that is responsible for fetching, parsing and caching meshes. This service cannot be used by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshContentProvider", "code_sample": "" }, "@roblox/globaltype/MemStorageService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemStorageService", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout": { "documentation": "The base class for grid style UI layouts.", "keys": { "AbsoluteContentSize": "@roblox/globaltype/UIGridStyleLayout.AbsoluteContentSize", "FillDirection": "@roblox/globaltype/UIGridStyleLayout.FillDirection", "HorizontalAlignment": "@roblox/globaltype/UIGridStyleLayout.HorizontalAlignment", "SortOrder": "@roblox/globaltype/UIGridStyleLayout.SortOrder", "VerticalAlignment": "@roblox/globaltype/UIGridStyleLayout.VerticalAlignment", "ApplyLayout": "@roblox/globaltype/UIGridStyleLayout.ApplyLayout", "SetCustomSortFunction": "@roblox/globaltype/UIGridStyleLayout.SetCustomSortFunction" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.AbsoluteContentSize": { "documentation": "The absolute size of space being taken up by the grid layout.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#AbsoluteContentSize", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.FillDirection": { "documentation": "Determines the axis in which UI objects are laid out.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#FillDirection", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.HorizontalAlignment": { "documentation": "Determines the horizontal alignment of UI elements within the parent element.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#HorizontalAlignment", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.SortOrder": { "documentation": "Determines the order in which child UI objects are placed in a layout.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#SortOrder", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.VerticalAlignment": { "documentation": "Determines the vertical alignment of UI elements within the parent element.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#VerticalAlignment", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.ApplyLayout/param/0": { "documentation": "The base class for grid style UI layouts." }, "@roblox/globaltype/UIGridStyleLayout.ApplyLayout": { "documentation": "Deprecated:
Force re-layout of sibling UI elements.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIGridStyleLayout.ApplyLayout/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#ApplyLayout", "code_sample": "" }, "@roblox/globaltype/UIGridStyleLayout.SetCustomSortFunction/param/0": { "documentation": "The base class for grid style UI layouts." }, "@roblox/globaltype/UIGridStyleLayout.SetCustomSortFunction/param/1": { "documentation": "" }, "@roblox/globaltype/UIGridStyleLayout.SetCustomSortFunction": { "documentation": "Deprecated: This method is deprecated in favor of using other SortOrder means, such as by Name or LayoutOrder.
Sets the function used to determine the order of elements when SortOrder is set to Custom.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIGridStyleLayout.SetCustomSortFunction/param/0" }, { "name": "function", "documentation": "@roblox/globaltype/UIGridStyleLayout.SetCustomSortFunction/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIGridStyleLayout#SetCustomSortFunction", "code_sample": "" }, "@roblox/globaltype/RunningAverageTimeIntervalItem": { "documentation": "Measures the runtime average of a time interval value.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunningAverageTimeIntervalItem", "code_sample": "" }, "@roblox/globaltype/BoxHandleAdornment": { "documentation": "A box-shaped handle that can be adorned to a BasePart.", "keys": { "Shading": "@roblox/globaltype/BoxHandleAdornment.Shading", "Size": "@roblox/globaltype/BoxHandleAdornment.Size" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoxHandleAdornment", "code_sample": "" }, "@roblox/globaltype/BoxHandleAdornment.Shading": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoxHandleAdornment#Shading", "code_sample": "" }, "@roblox/globaltype/BoxHandleAdornment.Size": { "documentation": "Size of the adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoxHandleAdornment#Size", "code_sample": "" }, "@roblox/globaltype/VoiceChatService": { "documentation": "VoiceChatService is responsible for voice chat's high-level functionality.", "keys": { "DefaultDistanceAttenuation": "@roblox/globaltype/VoiceChatService.DefaultDistanceAttenuation", "EnableDefaultVoice": "@roblox/globaltype/VoiceChatService.EnableDefaultVoice", "UseAudioApi": "@roblox/globaltype/VoiceChatService.UseAudioApi", "IsVoiceEnabledForUserIdAsync": "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VoiceChatService", "code_sample": "" }, "@roblox/globaltype/VoiceChatService.DefaultDistanceAttenuation": { "documentation": "Determines which distance attenuation curve the default voice chat setup uses when AudioDeviceInput and AudioEmitter objects are generated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#DefaultDistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/VoiceChatService.EnableDefaultVoice": { "documentation": "Controls whether each voice-eligible player can be heard as though they were speaking through their character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#EnableDefaultVoice", "code_sample": "" }, "@roblox/globaltype/VoiceChatService.UseAudioApi": { "documentation": "Controls whether voice chat is represented and controlled by AudioDeviceInput objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#UseAudioApi", "code_sample": "" }, "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync/param/0": { "documentation": "VoiceChatService is responsible for voice chat's high-level functionality." }, "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync/param/1": { "documentation": "The Player.UserId to check." }, "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync/return/0": { "documentation": "If that user has voice enabled." }, "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync": { "documentation": "Returns whether or not the given user has voice enabled.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync/param/1" } ], "returns": [ "@roblox/globaltype/VoiceChatService.IsVoiceEnabledForUserIdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#IsVoiceEnabledForUserIdAsync", "code_sample": "" }, "@roblox/globaltype/Frame": { "documentation": "A GuiObject that renders as a plain rectangle, generally used as a container.", "keys": { "Style": "@roblox/globaltype/Frame.Style" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Frame", "code_sample": "" }, "@roblox/globaltype/Frame.Style": { "documentation": "Sets what the frame looks like from a selection of pre-determined styles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Frame#Style", "code_sample": "" }, "@roblox/globaltype/LineForce": { "documentation": "Applies a force along the theoretical line connecting its two Attachments.", "keys": { "ApplyAtCenterOfMass": "@roblox/globaltype/LineForce.ApplyAtCenterOfMass", "InverseSquareLaw": "@roblox/globaltype/LineForce.InverseSquareLaw", "Magnitude": "@roblox/globaltype/LineForce.Magnitude", "MaxForce": "@roblox/globaltype/LineForce.MaxForce", "ReactionForceEnabled": "@roblox/globaltype/LineForce.ReactionForceEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineForce", "code_sample": "" }, "@roblox/globaltype/LineForce.ApplyAtCenterOfMass": { "documentation": "Whether force is applied at the center of mass of the parent assembly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineForce#ApplyAtCenterOfMass", "code_sample": "" }, "@roblox/globaltype/LineForce.InverseSquareLaw": { "documentation": "When true, the force magnitude is multiplied by the inverse square of the distance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineForce#InverseSquareLaw", "code_sample": "" }, "@roblox/globaltype/LineForce.Magnitude": { "documentation": "The magnitude of the force.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineForce#Magnitude", "code_sample": "" }, "@roblox/globaltype/LineForce.MaxForce": { "documentation": "Maximum absolute force that can be applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineForce#MaxForce", "code_sample": "" }, "@roblox/globaltype/LineForce.ReactionForceEnabled": { "documentation": "Enables an equal and opposite reaction force on the parent of Attachment1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineForce#ReactionForceEnabled", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter": { "documentation": "Adjusts the perceived pitch of audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioPitchShifter.Bypass", "Pitch": "@roblox/globaltype/AudioPitchShifter.Pitch", "WindowSize": "@roblox/globaltype/AudioPitchShifter.WindowSize", "GetConnectedWires": "@roblox/globaltype/AudioPitchShifter.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioPitchShifter.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioPitchShifter.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.Pitch": { "documentation": "Pitch modification to be multiplied by the pitch of the input stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#Pitch", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.WindowSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#WindowSize", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.GetConnectedWires/param/0": { "documentation": "Adjusts the perceived pitch of audio streams." }, "@roblox/globaltype/AudioPitchShifter.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioPitchShifter.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioPitchShifter.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.GetInputPins/param/0": { "documentation": "Adjusts the perceived pitch of audio streams." }, "@roblox/globaltype/AudioPitchShifter.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioPitchShifter.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.GetOutputPins/param/0": { "documentation": "Adjusts the perceived pitch of audio streams." }, "@roblox/globaltype/AudioPitchShifter.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioPitchShifter.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPitchShifter.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioPitchShifter.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioPitchShifter via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioPitchShifter.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioPitchShifter.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#WiringChanged", "code_sample": "" }, "@roblox/globaltype/StarterPlayer": { "documentation": "A service which allows the defaults of properties in the Player object to be set.", "keys": { "AllowCustomAnimations": "@roblox/globaltype/StarterPlayer.AllowCustomAnimations", "AutoJumpEnabled": "@roblox/globaltype/StarterPlayer.AutoJumpEnabled", "AvatarJointUpgrade": "@roblox/globaltype/StarterPlayer.AvatarJointUpgrade", "CameraMaxZoomDistance": "@roblox/globaltype/StarterPlayer.CameraMaxZoomDistance", "CameraMinZoomDistance": "@roblox/globaltype/StarterPlayer.CameraMinZoomDistance", "CameraMode": "@roblox/globaltype/StarterPlayer.CameraMode", "CharacterBreakJointsOnDeath": "@roblox/globaltype/StarterPlayer.CharacterBreakJointsOnDeath", "CharacterJumpHeight": "@roblox/globaltype/StarterPlayer.CharacterJumpHeight", "CharacterJumpPower": "@roblox/globaltype/StarterPlayer.CharacterJumpPower", "CharacterMaxSlopeAngle": "@roblox/globaltype/StarterPlayer.CharacterMaxSlopeAngle", "CharacterUseJumpPower": "@roblox/globaltype/StarterPlayer.CharacterUseJumpPower", "CharacterWalkSpeed": "@roblox/globaltype/StarterPlayer.CharacterWalkSpeed", "ClassicDeath": "@roblox/globaltype/StarterPlayer.ClassicDeath", "CreateDefaultPlayerModule": "@roblox/globaltype/StarterPlayer.CreateDefaultPlayerModule", "DevCameraOcclusionMode": "@roblox/globaltype/StarterPlayer.DevCameraOcclusionMode", "DevComputerCameraMovementMode": "@roblox/globaltype/StarterPlayer.DevComputerCameraMovementMode", "DevComputerMovementMode": "@roblox/globaltype/StarterPlayer.DevComputerMovementMode", "DevTouchCameraMovementMode": "@roblox/globaltype/StarterPlayer.DevTouchCameraMovementMode", "DevTouchMovementMode": "@roblox/globaltype/StarterPlayer.DevTouchMovementMode", "EnableDynamicHeads": "@roblox/globaltype/StarterPlayer.EnableDynamicHeads", "EnableMouseLockOption": "@roblox/globaltype/StarterPlayer.EnableMouseLockOption", "HealthDisplayDistance": "@roblox/globaltype/StarterPlayer.HealthDisplayDistance", "LoadCharacterAppearance": "@roblox/globaltype/StarterPlayer.LoadCharacterAppearance", "LoadCharacterLayeredClothing ": "@roblox/globaltype/StarterPlayer.LoadCharacterLayeredClothing ", "LuaCharacterController": "@roblox/globaltype/StarterPlayer.LuaCharacterController", "NameDisplayDistance": "@roblox/globaltype/StarterPlayer.NameDisplayDistance", "UserEmotesEnabled": "@roblox/globaltype/StarterPlayer.UserEmotesEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.AllowCustomAnimations": { "documentation": "Describes the current game's permission levels regarding custom avatar animations from the website.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#AllowCustomAnimations", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.AutoJumpEnabled": { "documentation": "Sets whether the character will automatically jump when hitting an obstacle on a mobile device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#AutoJumpEnabled", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal button = script.Parent\n\nlocal function update()\n\t-- Update button text\n\tif player.AutoJumpEnabled then\n\t\tbutton.Text = \"Auto-Jump is ON\"\n\telse\n\t\tbutton.Text = \"Auto-Jump is OFF\"\n\tend\n\t-- Reflect the property in the player's character, if they have one\n\tif player.Character then\n\t\tlocal human = player.Character:FindFirstChild(\"Humanoid\")\n\t\tif human then\n\t\t\thuman.AutoJumpEnabled = player.AutoJumpEnabled\n\t\tend\n\tend\nend\n\nlocal function onActivated()\n\t-- Toggle auto-jump\n\tplayer.AutoJumpEnabled = not player.AutoJumpEnabled\n\t-- Update everything else\n\tupdate()\nend\n\nbutton.Activated:Connect(onActivated)\nupdate()" }, "@roblox/globaltype/StarterPlayer.AvatarJointUpgrade": { "documentation": "Controls whether avatars spawn with AnimationConstraint joints for physical simulation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#AvatarJointUpgrade", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CameraMaxZoomDistance": { "documentation": "The maximum distance the player's default camera is allowed to zoom out in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CameraMaxZoomDistance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.CameraMaxZoomDistance = 50\nplayer.CameraMinZoomDistance = 75" }, "@roblox/globaltype/StarterPlayer.CameraMinZoomDistance": { "documentation": "The minimum distance in studs the player's default camera is allowed to zoom in.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CameraMinZoomDistance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.CameraMaxZoomDistance = 50\nplayer.CameraMinZoomDistance = 75" }, "@roblox/globaltype/StarterPlayer.CameraMode": { "documentation": "Changes the default camera's mode to either first or third person.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CameraMode", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.CameraMode = Enum.CameraMode.LockFirstPerson" }, "@roblox/globaltype/StarterPlayer.CharacterBreakJointsOnDeath": { "documentation": "Determines the starting value of Humanoid.BreakJointsOnDeath for Player.Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterBreakJointsOnDeath", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CharacterJumpHeight": { "documentation": "Determines the starting value of Humanoid.JumpHeight for Player.Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterJumpHeight", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CharacterJumpPower": { "documentation": "Determines the starting value of Humanoid.JumpPower for Player.Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterJumpPower", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CharacterMaxSlopeAngle": { "documentation": "Determines the starting value of Humanoid.MaxSlopeAngle for Player.Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterMaxSlopeAngle", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CharacterUseJumpPower": { "documentation": "Determines the starting state of Humanoid.UseJumpPower for Player.Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterUseJumpPower", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CharacterWalkSpeed": { "documentation": "Determines the starting value of Humanoid.WalkSpeed for Player.Character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterWalkSpeed", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.ClassicDeath": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#ClassicDeath", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.CreateDefaultPlayerModule": { "documentation": "Controls how the default player module and related scripts are handled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CreateDefaultPlayerModule", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.DevCameraOcclusionMode": { "documentation": "Sets how the default camera handles objects between the camera and the player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#DevCameraOcclusionMode", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.DevComputerCameraMovementMode": { "documentation": "Lets you overwrite the player's camera mode on a computer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#DevComputerCameraMovementMode", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.DevComputerMovementMode": { "documentation": "Lets you overwrite the player's movement mode on a computer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#DevComputerMovementMode", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.DevTouchCameraMovementMode": { "documentation": "Lets you overwrite the player's camera mode on a touch-enabled device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#DevTouchCameraMovementMode", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.DevTouchMovementMode": { "documentation": "Lets you overwrite the player's movement mode on a touch-enabled device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#DevTouchMovementMode", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.EnableDynamicHeads": { "documentation": "Sets the use of dynamic heads. When true, enables the use of avatar heads with facial animation data.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#EnableDynamicHeads", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.EnableMouseLockOption": { "documentation": "Determines if a player can toggle mouse lock by default.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#EnableMouseLockOption", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nwhile true do\n\tplayer.DevEnableMouseLock = not player.DevEnableMouseLock\n\ttask.wait(5)\nend" }, "@roblox/globaltype/StarterPlayer.HealthDisplayDistance": { "documentation": "Sets the distance at which this player will see other Humanoid health bars. If set to 0, the health bars will not be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#HealthDisplayDistance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.HealthDisplayDistance = 0\nplayer.NameDisplayDistance = 0" }, "@roblox/globaltype/StarterPlayer.LoadCharacterAppearance": { "documentation": "Whether or not the appearance of a player's character should be loaded.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#LoadCharacterAppearance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.CanLoadCharacterAppearance = false" }, "@roblox/globaltype/StarterPlayer.LoadCharacterLayeredClothing ": { "documentation": "Indicates whether characters spawning into an experience will have layered clothing accessories equipped on them.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#LoadCharacterLayeredClothing ", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.LuaCharacterController": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#LuaCharacterController", "code_sample": "" }, "@roblox/globaltype/StarterPlayer.NameDisplayDistance": { "documentation": "Sets the distance at which this player will see other Humanoid names.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#NameDisplayDistance", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nplayer.HealthDisplayDistance = 0\nplayer.NameDisplayDistance = 0" }, "@roblox/globaltype/StarterPlayer.UserEmotesEnabled": { "documentation": "Determines if user-owned emotes are loaded when loading avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#UserEmotesEnabled", "code_sample": "" }, "@roblox/globaltype/MeshPart": { "documentation": "A form of BasePart that includes a physically simulated custom mesh.", "keys": { "DoubleSided": "@roblox/globaltype/MeshPart.DoubleSided", "HasJointOffset": "@roblox/globaltype/MeshPart.HasJointOffset", "HasSkinnedMesh": "@roblox/globaltype/MeshPart.HasSkinnedMesh", "JointOffset": "@roblox/globaltype/MeshPart.JointOffset", "MeshContent": "@roblox/globaltype/MeshPart.MeshContent", "MeshId": "@roblox/globaltype/MeshPart.MeshId", "RenderFidelity": "@roblox/globaltype/MeshPart.RenderFidelity", "TextureContent": "@roblox/globaltype/MeshPart.TextureContent", "TextureID": "@roblox/globaltype/MeshPart.TextureID", "ApplyMesh": "@roblox/globaltype/MeshPart.ApplyMesh" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart", "code_sample": "" }, "@roblox/globaltype/MeshPart.DoubleSided": { "documentation": "Determines whether to render both faces of polygons in the mesh.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#DoubleSided", "code_sample": "" }, "@roblox/globaltype/MeshPart.HasJointOffset": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#HasJointOffset", "code_sample": "" }, "@roblox/globaltype/MeshPart.HasSkinnedMesh": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#HasSkinnedMesh", "code_sample": "" }, "@roblox/globaltype/MeshPart.JointOffset": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#JointOffset", "code_sample": "" }, "@roblox/globaltype/MeshPart.MeshContent": { "documentation": "The mesh that is displayed on the MeshPart. Supports asset URIs and EditableMesh objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#MeshContent", "code_sample": "" }, "@roblox/globaltype/MeshPart.MeshId": { "documentation": "The asset URIs of the mesh that is displayed on the MeshPart. Reads and writes to MeshContent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#MeshId", "code_sample": "" }, "@roblox/globaltype/MeshPart.RenderFidelity": { "documentation": "The level of detail used to render the MeshPart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#RenderFidelity", "code_sample": "" }, "@roblox/globaltype/MeshPart.TextureContent": { "documentation": "The texture applied to the MeshPart. Supports asset URIs and EditableImage objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#TextureContent", "code_sample": "" }, "@roblox/globaltype/MeshPart.TextureID": { "documentation": "The texture applied to the MeshPart. Reads and writes to TextureContent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#TextureID", "code_sample": "" }, "@roblox/globaltype/MeshPart.ApplyMesh/param/0": { "documentation": "A form of BasePart that includes a physically simulated custom mesh." }, "@roblox/globaltype/MeshPart.ApplyMesh/param/1": { "documentation": "" }, "@roblox/globaltype/MeshPart.ApplyMesh": { "documentation": "Overwrites the MeshContent, TextureContent, and collision geometry properties of this MeshPart from the given source meshPart.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MeshPart.ApplyMesh/param/0" }, { "name": "meshPart", "documentation": "@roblox/globaltype/MeshPart.ApplyMesh/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MeshPart#ApplyMesh", "code_sample": "" }, "@roblox/globaltype/AudioReverb": { "documentation": "Reverberates audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioReverb.Bypass", "DecayRatio": "@roblox/globaltype/AudioReverb.DecayRatio", "DecayTime": "@roblox/globaltype/AudioReverb.DecayTime", "Density": "@roblox/globaltype/AudioReverb.Density", "Diffusion": "@roblox/globaltype/AudioReverb.Diffusion", "DryLevel": "@roblox/globaltype/AudioReverb.DryLevel", "EarlyDelayTime": "@roblox/globaltype/AudioReverb.EarlyDelayTime", "HighCutFrequency": "@roblox/globaltype/AudioReverb.HighCutFrequency", "LateDelayTime": "@roblox/globaltype/AudioReverb.LateDelayTime", "LowShelfFrequency": "@roblox/globaltype/AudioReverb.LowShelfFrequency", "LowShelfGain": "@roblox/globaltype/AudioReverb.LowShelfGain", "ReferenceFrequency": "@roblox/globaltype/AudioReverb.ReferenceFrequency", "WetLevel": "@roblox/globaltype/AudioReverb.WetLevel", "GetConnectedWires": "@roblox/globaltype/AudioReverb.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioReverb.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioReverb.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb", "code_sample": "" }, "@roblox/globaltype/AudioReverb.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioReverb.DecayRatio": { "documentation": "Controls how quickly high frequency sound decays compared to the overall reverb.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#DecayRatio", "code_sample": "" }, "@roblox/globaltype/AudioReverb.DecayTime": { "documentation": "Controls how long it takes for the reverb to dissipate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#DecayTime", "code_sample": "" }, "@roblox/globaltype/AudioReverb.Density": { "documentation": "Controls how many reflections are generated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#Density", "code_sample": "" }, "@roblox/globaltype/AudioReverb.Diffusion": { "documentation": "Controls how smooth and reflective the simulated surfaces are.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#Diffusion", "code_sample": "" }, "@roblox/globaltype/AudioReverb.DryLevel": { "documentation": "Gain level determining how loud the original, unaltered audio stream will be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#DryLevel", "code_sample": "" }, "@roblox/globaltype/AudioReverb.EarlyDelayTime": { "documentation": "Controls the amount of time before reverberation begins .", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#EarlyDelayTime", "code_sample": "" }, "@roblox/globaltype/AudioReverb.HighCutFrequency": { "documentation": "Frequency above which sound is filtered out of the reverb.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#HighCutFrequency", "code_sample": "" }, "@roblox/globaltype/AudioReverb.LateDelayTime": { "documentation": "Time, following early delays, before diffuse reverberations begin.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#LateDelayTime", "code_sample": "" }, "@roblox/globaltype/AudioReverb.LowShelfFrequency": { "documentation": "Frequency below which audio can be boosted or reduced in the reverb.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#LowShelfFrequency", "code_sample": "" }, "@roblox/globaltype/AudioReverb.LowShelfGain": { "documentation": "Controls the presence of low frequency content in the reverb.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#LowShelfGain", "code_sample": "" }, "@roblox/globaltype/AudioReverb.ReferenceFrequency": { "documentation": "Frequency that separates low frequency decay speeds from high frequency decay speeds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#ReferenceFrequency", "code_sample": "" }, "@roblox/globaltype/AudioReverb.WetLevel": { "documentation": "Gain level determining how loud the reverberated stream will be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#WetLevel", "code_sample": "" }, "@roblox/globaltype/AudioReverb.GetConnectedWires/param/0": { "documentation": "Reverberates audio streams." }, "@roblox/globaltype/AudioReverb.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioReverb.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioReverb.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioReverb.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioReverb.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioReverb.GetInputPins/param/0": { "documentation": "Reverberates audio streams." }, "@roblox/globaltype/AudioReverb.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioReverb.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioReverb.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioReverb.GetOutputPins/param/0": { "documentation": "Reverberates audio streams." }, "@roblox/globaltype/AudioReverb.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioReverb.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioReverb.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioReverb.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioReverb.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioReverb.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioReverb.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioReverb.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioReverb.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioReverb.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioReverb.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioReverb.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioReverb.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioReverb.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioReverb.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioReverb.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioReverb via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioReverb.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioReverb.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioReverb.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioReverb.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioReverb#WiringChanged", "code_sample": "" }, "@roblox/globaltype/Backpack": { "documentation": "A container object that holds a player's inventory. Any Tool in a player's Backpack will be displayed in their inventory at the bottom of their screen.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Backpack", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterAdded(character)\n\tlocal player = Players:GetPlayerFromCharacter(character)\n\tlocal tool = Instance.new(\"Tool\")\n\tlocal backpack = player:FindFirstChildOfClass(\"Backpack\")\n\ttool.Parent = backpack\nend\n\nlocal function onPlayerAdded(player)\n\tif player.Character then\n\t\tonCharacterAdded(player.Character)\n\tend\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/AssetService": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API.", "keys": { "AllowInsertFreeAssets": "@roblox/globaltype/AssetService.AllowInsertFreeAssets", "ComposeDecalAsync": "@roblox/globaltype/AssetService.ComposeDecalAsync", "CreateAssetAsync": "@roblox/globaltype/AssetService.CreateAssetAsync", "CreateAssetVersionAsync": "@roblox/globaltype/AssetService.CreateAssetVersionAsync", "CreateEditableImage": "@roblox/globaltype/AssetService.CreateEditableImage", "CreateEditableImageAsync": "@roblox/globaltype/AssetService.CreateEditableImageAsync", "CreateEditableMesh": "@roblox/globaltype/AssetService.CreateEditableMesh", "CreateEditableMeshAsync": "@roblox/globaltype/AssetService.CreateEditableMeshAsync", "CreateMeshPartAsync": "@roblox/globaltype/AssetService.CreateMeshPartAsync", "CreatePlaceAsync": "@roblox/globaltype/AssetService.CreatePlaceAsync", "CreatePlaceInPlayerInventoryAsync": "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync", "CreateSurfaceAppearanceAsync": "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync", "GetAssetIdsForPackageAsync": "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync", "GetAssetIdsForPackage": "@roblox/globaltype/AssetService.GetAssetIdsForPackage", "GetAudioMetadataAsync": "@roblox/globaltype/AssetService.GetAudioMetadataAsync", "GetBundleDetailsAsync": "@roblox/globaltype/AssetService.GetBundleDetailsAsync", "GetCreatorAssetID": "@roblox/globaltype/AssetService.GetCreatorAssetID", "GetGamePlacesAsync": "@roblox/globaltype/AssetService.GetGamePlacesAsync", "LoadAssetAsync": "@roblox/globaltype/AssetService.LoadAssetAsync", "PromptCreateAssetAsync": "@roblox/globaltype/AssetService.PromptCreateAssetAsync", "PromptImportAnimationClipFromVideoAsync": "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync", "SavePlaceAsync": "@roblox/globaltype/AssetService.SavePlaceAsync", "SearchAudioAsync": "@roblox/globaltype/AssetService.SearchAudioAsync", "SearchAudio": "@roblox/globaltype/AssetService.SearchAudio" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService", "code_sample": "" }, "@roblox/globaltype/AssetService.AllowInsertFreeAssets": { "documentation": "Controls whether AssetService:LoadAssetAsync() can load assets that are not owned by the experience creator.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#AllowInsertFreeAssets", "code_sample": "" }, "@roblox/globaltype/AssetService.ComposeDecalAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.ComposeDecalAsync/param/1": { "documentation": "An array of Dictionary tables that maps PBR names to ContentID." }, "@roblox/globaltype/AssetService.ComposeDecalAsync/return/0": { "documentation": "A new Decal containing the composed texture set." }, "@roblox/globaltype/AssetService.ComposeDecalAsync": { "documentation": "Creates a Decal instance that uses composite PBR textures created by layering the provided textures in the order they are provided in the layers array. Textures layer based on the alpha value of the ColorMap.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.ComposeDecalAsync/param/0" }, { "name": "layers", "documentation": "@roblox/globaltype/AssetService.ComposeDecalAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.ComposeDecalAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#ComposeDecalAsync", "code_sample": "-- Get AssetService\nlocal AssetService = game:GetService(\"AssetService\")\n\n-- Create two decal instances\nlocal DecalA = Instance.new(\"Decal\")\nlocal DecalB = Instance.new(\"Decal\")\n\n-- Build composite info table\nlocal compositeInfo = {\n\t{\n\t\tColorMap = DecalA.ColorMapContent,\n\t\tRoughnessMap = DecalA.RoughnessMapContent,\n\t\tMetalnessMap = DecalA.MetalnessMapContent,\n\t\tNormalMap = DecalA.NormalMapContent,\n\t},\n\t{\n\t\tColorMap = Content.fromAssetId(123456),\n\t\tRoughnessMap = DecalB.RoughnessMapContent,\n\t\tMetalnessMap = DecalB.MetalnessMapContent,\n\t\tNormalMap = DecalB.NormalMapContent,\n\t}\n}\n\n-- Compose a new decal using AssetService\nlocal compositeDecal = AssetService:ComposeDecalAsync(compositeInfo)" }, "@roblox/globaltype/AssetService.CreateAssetAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateAssetAsync/param/1": { "documentation": "The object to be created as an asset." }, "@roblox/globaltype/AssetService.CreateAssetAsync/param/2": { "documentation": "Currently supported types are: " }, "@roblox/globaltype/AssetService.CreateAssetAsync/param/3": { "documentation": "Options table containing asset metadata: " }, "@roblox/globaltype/AssetService.CreateAssetAsync/return/0": { "documentation": "The CreateAssetResult and asset ID pair if successful." }, "@roblox/globaltype/AssetService.CreateAssetAsync": { "documentation": "Uploads a new asset to Roblox from the given object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateAssetAsync/param/0" }, { "name": "object", "documentation": "@roblox/globaltype/AssetService.CreateAssetAsync/param/1" }, { "name": "assetType", "documentation": "@roblox/globaltype/AssetService.CreateAssetAsync/param/2" }, { "name": "requestParameters", "documentation": "@roblox/globaltype/AssetService.CreateAssetAsync/param/3" } ], "returns": [ "@roblox/globaltype/AssetService.CreateAssetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateAssetAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/1": { "documentation": "The object to be created as an asset." }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/2": { "documentation": "Currently supported types are: " }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/3": { "documentation": "The ID of the asset for the new version." }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/4": { "documentation": "Options table containing asset metadata: " }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync/return/0": { "documentation": "The CreateAssetResult and asset version number pair if successful." }, "@roblox/globaltype/AssetService.CreateAssetVersionAsync": { "documentation": "Uploads a new version for an existing asset from the given object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/0" }, { "name": "object", "documentation": "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/1" }, { "name": "assetType", "documentation": "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/2" }, { "name": "assetId", "documentation": "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/3" }, { "name": "requestParameters", "documentation": "@roblox/globaltype/AssetService.CreateAssetVersionAsync/param/4" } ], "returns": [ "@roblox/globaltype/AssetService.CreateAssetVersionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateAssetVersionAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateEditableImage/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateEditableImage/param/1": { "documentation": "Options table containing controls for the method: " }, "@roblox/globaltype/AssetService.CreateEditableImage/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.CreateEditableImage": { "documentation": "Creates a new EditableImage.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateEditableImage/param/0" }, { "name": "editableImageOptions", "documentation": "@roblox/globaltype/AssetService.CreateEditableImage/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.CreateEditableImage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableImage", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateEditableImageAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateEditableImageAsync/param/1": { "documentation": "Reference to asset content stored externally or as an object within the place, wrapping a single value of one of the supported ContentSourceType values." }, "@roblox/globaltype/AssetService.CreateEditableImageAsync/param/2": { "documentation": "Table containing options for the created EditableImage. Currently no options are available since resizing via Size is not supported." }, "@roblox/globaltype/AssetService.CreateEditableImageAsync/return/0": { "documentation": "A new EditableImage containing the provided image." }, "@roblox/globaltype/AssetService.CreateEditableImageAsync": { "documentation": "Creates a new EditableImage object populated with the given image.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateEditableImageAsync/param/0" }, { "name": "content", "documentation": "@roblox/globaltype/AssetService.CreateEditableImageAsync/param/1" }, { "name": "editableImageOptions", "documentation": "@roblox/globaltype/AssetService.CreateEditableImageAsync/param/2" } ], "returns": [ "@roblox/globaltype/AssetService.CreateEditableImageAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableImageAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateEditableMesh/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateEditableMesh/param/1": { "documentation": "Table containing options for the created EditableMesh. Currently no options are available since FixedSize will always be false for empty editable meshes." }, "@roblox/globaltype/AssetService.CreateEditableMesh/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.CreateEditableMesh": { "documentation": "Creates a new, empty EditableMesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateEditableMesh/param/0" }, { "name": "editableMeshOptions", "documentation": "@roblox/globaltype/AssetService.CreateEditableMesh/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.CreateEditableMesh/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableMesh", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateEditableMeshAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateEditableMeshAsync/param/1": { "documentation": "Reference to asset content stored externally or as an object within the place, wrapping a single value of one of the supported ContentSourceType values." }, "@roblox/globaltype/AssetService.CreateEditableMeshAsync/param/2": { "documentation": "Options table containing controls for the method: " }, "@roblox/globaltype/AssetService.CreateEditableMeshAsync/return/0": { "documentation": "The new EditableMesh instance." }, "@roblox/globaltype/AssetService.CreateEditableMeshAsync": { "documentation": "Returns a new EditableMesh object created from an existing mesh content ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateEditableMeshAsync/param/0" }, { "name": "content", "documentation": "@roblox/globaltype/AssetService.CreateEditableMeshAsync/param/1" }, { "name": "editableMeshOptions", "documentation": "@roblox/globaltype/AssetService.CreateEditableMeshAsync/param/2" } ], "returns": [ "@roblox/globaltype/AssetService.CreateEditableMeshAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableMeshAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateMeshPartAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateMeshPartAsync/param/1": { "documentation": "Reference to asset content stored externally or as an object within the place, wrapping a single value of one of the supported ContentSourceType values." }, "@roblox/globaltype/AssetService.CreateMeshPartAsync/param/2": { "documentation": "Options table containing one or more controls for the method: " }, "@roblox/globaltype/AssetService.CreateMeshPartAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.CreateMeshPartAsync": { "documentation": "Creates a new MeshPart with a specified mesh ID and an optional table of fidelity values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateMeshPartAsync/param/0" }, { "name": "meshContent", "documentation": "@roblox/globaltype/AssetService.CreateMeshPartAsync/param/1" }, { "name": "options", "documentation": "@roblox/globaltype/AssetService.CreateMeshPartAsync/param/2" } ], "returns": [ "@roblox/globaltype/AssetService.CreateMeshPartAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateMeshPartAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreatePlaceAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreatePlaceAsync/param/1": { "documentation": "Name of the new place." }, "@roblox/globaltype/AssetService.CreatePlaceAsync/param/2": { "documentation": "PlaceId of the place to clone." }, "@roblox/globaltype/AssetService.CreatePlaceAsync/param/3": { "documentation": "Description of the new place." }, "@roblox/globaltype/AssetService.CreatePlaceAsync/return/0": { "documentation": "PlaceId of the new place." }, "@roblox/globaltype/AssetService.CreatePlaceAsync": { "documentation": "Clones a place through the given templatePlaceID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreatePlaceAsync/param/0" }, { "name": "placeName", "documentation": "@roblox/globaltype/AssetService.CreatePlaceAsync/param/1" }, { "name": "templatePlaceID", "documentation": "@roblox/globaltype/AssetService.CreatePlaceAsync/param/2" }, { "name": "description", "documentation": "@roblox/globaltype/AssetService.CreatePlaceAsync/param/3" } ], "returns": [ "@roblox/globaltype/AssetService.CreatePlaceAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreatePlaceAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/2": { "documentation": "" }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/3": { "documentation": "" }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/4": { "documentation": "" }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync": { "documentation": "Clones a place through the given templatePlaceID and puts it into the inventory of the given player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/1" }, { "name": "placeName", "documentation": "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/2" }, { "name": "templatePlaceID", "documentation": "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/3" }, { "name": "description", "documentation": "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/param/4" } ], "returns": [ "@roblox/globaltype/AssetService.CreatePlaceInPlayerInventoryAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreatePlaceInPlayerInventoryAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync/param/1": { "documentation": "Dictionary containing the following key-value pairs: " }, "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync/return/0": { "documentation": "A new SurfaceAppearance instance with the given maps from the content parameter." }, "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync": { "documentation": "Creates a new SurfaceAppearance object using the provided content maps.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync/param/0" }, { "name": "content", "documentation": "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.CreateSurfaceAppearanceAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateSurfaceAppearanceAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync/return/0": { "documentation": "Asset IDs that are contained in a specified package." }, "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync": { "documentation": "Returns an array of asset IDs that are contained in a specified package.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync/param/0" }, { "name": "packageAssetId", "documentation": "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.GetAssetIdsForPackageAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackageAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.GetAssetIdsForPackage/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.GetAssetIdsForPackage/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.GetAssetIdsForPackage/return/0": { "documentation": "Asset IDs that are contained in a specified package." }, "@roblox/globaltype/AssetService.GetAssetIdsForPackage": { "documentation": "Deprecated:
Returns an array of asset IDs that are contained in a specified package.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.GetAssetIdsForPackage/param/0" }, { "name": "packageAssetId", "documentation": "@roblox/globaltype/AssetService.GetAssetIdsForPackage/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.GetAssetIdsForPackage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackage", "code_sample": "" }, "@roblox/globaltype/AssetService.GetAudioMetadataAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.GetAudioMetadataAsync/param/1": { "documentation": "Array of asset or content IDs for which to retrieve metadata. Max batch size is 30." }, "@roblox/globaltype/AssetService.GetAudioMetadataAsync/return/0": { "documentation": "Array of dictionary tables in the same order as the request, where each dictionary contains the following metadata for its asset/content: Note that if an error occurs on fetching metadata for any of the requested assets, for example the asset ID doesn't exist, its dictionary table is still included in the returned array but it only contains the AssetId field for reference purposes. Additionally, if the AudioType cannot be determined for a given asset (perhaps because it's private audio), the resulting dictionary will not contain an AudioType entry." }, "@roblox/globaltype/AssetService.GetAudioMetadataAsync": { "documentation": "Provides relevant metadata about a specific audio source.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.GetAudioMetadataAsync/param/0" }, { "name": "idList", "documentation": "@roblox/globaltype/AssetService.GetAudioMetadataAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.GetAudioMetadataAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAudioMetadataAsync", "code_sample": "local AssetService = game:GetService(\"AssetService\")\nlocal SoundService = game:GetService(\"SoundService\")\n\nlocal trackIDs = {\n\tSoundService.Sound1.SoundId,\n\tSoundService.Sound2.SoundId,\n\tSoundService.Sound3.SoundId,\n\tSoundService.Sound4.SoundId,\n}\n\nlocal success, result = pcall(function()\n\treturn AssetService:GetAudioMetadataAsync(trackIDs)\nend)\n\nif success then\n\tfor i = 1, #trackIDs do\n\t\tlocal contentId = \"rbxassetid://\" .. result[i].AssetId\n\t\tif trackIDs[i] == contentId then\n\t\t\tprint(result[i].Title, \"by\", result[i].Artist)\n\t\telse\n\t\t\twarn(\"No metadata fetched for requested asset #\" .. tostring(i))\n\t\tend\n\tend\nend" }, "@roblox/globaltype/AssetService.GetBundleDetailsAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.GetBundleDetailsAsync/param/1": { "documentation": "The ID of the specified bundle." }, "@roblox/globaltype/AssetService.GetBundleDetailsAsync/return/0": { "documentation": "Dictionary with the following key-value pairs containing details about the specified bundle: " }, "@roblox/globaltype/AssetService.GetBundleDetailsAsync": { "documentation": "Returns details of the contents of specified bundle.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.GetBundleDetailsAsync/param/0" }, { "name": "bundleId", "documentation": "@roblox/globaltype/AssetService.GetBundleDetailsAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.GetBundleDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#GetBundleDetailsAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.GetCreatorAssetID/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.GetCreatorAssetID/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.GetCreatorAssetID/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.GetCreatorAssetID": { "documentation": "Deprecated: This item is deprecated and no longer functions correctly. Do not use it for new work.
Returns the UserId of the account who created the creationID asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.GetCreatorAssetID/param/0" }, { "name": "creationID", "documentation": "@roblox/globaltype/AssetService.GetCreatorAssetID/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.GetCreatorAssetID/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#GetCreatorAssetID", "code_sample": "" }, "@roblox/globaltype/AssetService.GetGamePlacesAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.GetGamePlacesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.GetGamePlacesAsync": { "documentation": "Returns a StandardPages object which contains the name and PlaceId of places within the current experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.GetGamePlacesAsync/param/0" } ], "returns": [ "@roblox/globaltype/AssetService.GetGamePlacesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#GetGamePlacesAsync", "code_sample": "local AssetService = game:GetService(\"AssetService\")\n\nlocal placePages = AssetService:GetGamePlacesAsync()\n\nwhile true do\n\tfor _, place in placePages:GetCurrentPage() do\n\t\tprint(\"Name:\", place.Name)\n\t\tprint(\"PlaceId:\", place.PlaceId)\n\tend\n\tif placePages.IsFinished then\n\t\tbreak\n\tend\n\tplacePages:AdvanceToNextPageAsync()\nend" }, "@roblox/globaltype/AssetService.LoadAssetAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.LoadAssetAsync/param/1": { "documentation": "The asset ID number of the asset being loaded." }, "@roblox/globaltype/AssetService.LoadAssetAsync/return/0": { "documentation": "A Model instance containing the loaded asset." }, "@roblox/globaltype/AssetService.LoadAssetAsync": { "documentation": "Loads a Model instance given its asset ID. This is the modern replacement for InsertService:LoadAsset() and supports loading third-party assets.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.LoadAssetAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/AssetService.LoadAssetAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.LoadAssetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#LoadAssetAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/1": { "documentation": "The user who submits an asset creation." }, "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/2": { "documentation": "The asset to be created. Currently can't contain scripts or nest non-public assets." }, "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/3": { "documentation": "The asset type. Currently can only be AssetType.Model." }, "@roblox/globaltype/AssetService.PromptCreateAssetAsync/return/0": { "documentation": "The PromptCreateAssetResult and asset ID pair if successful." }, "@roblox/globaltype/AssetService.PromptCreateAssetAsync": { "documentation": "Allows in-experience asset creation for users by prompting a publish dialog.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/1" }, { "name": "instance", "documentation": "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/2" }, { "name": "assetType", "documentation": "@roblox/globaltype/AssetService.PromptCreateAssetAsync/param/3" } ], "returns": [ "@roblox/globaltype/AssetService.PromptCreateAssetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#PromptCreateAssetAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/param/2": { "documentation": "" }, "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/param/1" }, { "name": "progressCallback", "documentation": "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/param/2" } ], "returns": [ "@roblox/globaltype/AssetService.PromptImportAnimationClipFromVideoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#PromptImportAnimationClipFromVideoAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.SavePlaceAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.SavePlaceAsync/param/1": { "documentation": "Optional dictionary that includes SaveWithoutPublish, a boolean indicating whether to save with publish or without publish, and PlaceId, the destination place ID to save over. An example usage would be: AssetService:SavePlaceAsync({PlaceId = 1, SaveWithoutPublish = true}). If PlaceId is not provided, the default behavior will save over the current original place which is calling SavePlaceAsync. If SaveWithoutPublish is not provided, the default behavior is SaveWithoutPublish=false." }, "@roblox/globaltype/AssetService.SavePlaceAsync": { "documentation": "Saves the state of the current place.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.SavePlaceAsync/param/0" }, { "name": "requestParameters", "documentation": "@roblox/globaltype/AssetService.SavePlaceAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#SavePlaceAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.SearchAudioAsync/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.SearchAudioAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.SearchAudioAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.SearchAudioAsync": { "documentation": "Finds audio assets matching a variety of search criteria.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.SearchAudioAsync/param/0" }, { "name": "searchParameters", "documentation": "@roblox/globaltype/AssetService.SearchAudioAsync/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.SearchAudioAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudioAsync", "code_sample": "" }, "@roblox/globaltype/AssetService.SearchAudio/param/0": { "documentation": "A non-replicated service that handles asset-related queries to the Roblox web API." }, "@roblox/globaltype/AssetService.SearchAudio/param/1": { "documentation": "" }, "@roblox/globaltype/AssetService.SearchAudio/return/0": { "documentation": "" }, "@roblox/globaltype/AssetService.SearchAudio": { "documentation": "Deprecated:
Finds audio assets matching a variety of search criteria.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AssetService.SearchAudio/param/0" }, { "name": "searchParameters", "documentation": "@roblox/globaltype/AssetService.SearchAudio/param/1" } ], "returns": [ "@roblox/globaltype/AssetService.SearchAudio/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudio", "code_sample": "" }, "@roblox/globaltype/UIFlexItem": { "documentation": "Defines flex behavior for a GuiObject within a UIListLayout.", "keys": { "FlexMode": "@roblox/globaltype/UIFlexItem.FlexMode", "GrowRatio": "@roblox/globaltype/UIFlexItem.GrowRatio", "ItemLineAlignment": "@roblox/globaltype/UIFlexItem.ItemLineAlignment", "ShrinkRatio": "@roblox/globaltype/UIFlexItem.ShrinkRatio" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIFlexItem", "code_sample": "" }, "@roblox/globaltype/UIFlexItem.FlexMode": { "documentation": "How the parent GuiObject grows or shrinks with available space in the flex layout container.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIFlexItem#FlexMode", "code_sample": "" }, "@roblox/globaltype/UIFlexItem.GrowRatio": { "documentation": "Determines the amount the parent GuiObject grows relative to other items in the line. Applies only if FlexMode is set to UIFlexMode.Custom.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIFlexItem#GrowRatio", "code_sample": "" }, "@roblox/globaltype/UIFlexItem.ItemLineAlignment": { "documentation": "Cross-axis alignment of the specific parent GuiObject within the flex line.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIFlexItem#ItemLineAlignment", "code_sample": "" }, "@roblox/globaltype/UIFlexItem.ShrinkRatio": { "documentation": "Determines the amount the parent GuiObject shrinks relative to other items in the line. Applies only if FlexMode is set to UIFlexMode.Custom.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIFlexItem#ShrinkRatio", "code_sample": "" }, "@roblox/globaltype/FriendPages": { "documentation": "A special version of Pages that contains information about a player's connections.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FriendPages", "code_sample": "" }, "@roblox/globaltype/QWidgetPluginGui": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/QWidgetPluginGui", "code_sample": "" }, "@roblox/globaltype/Beam": { "documentation": "Connects two Attachments by drawing a texture between them.", "keys": { "Attachment0": "@roblox/globaltype/Beam.Attachment0", "Attachment1": "@roblox/globaltype/Beam.Attachment1", "Brightness": "@roblox/globaltype/Beam.Brightness", "Color": "@roblox/globaltype/Beam.Color", "CurveSize0": "@roblox/globaltype/Beam.CurveSize0", "CurveSize1": "@roblox/globaltype/Beam.CurveSize1", "Enabled": "@roblox/globaltype/Beam.Enabled", "FaceCamera": "@roblox/globaltype/Beam.FaceCamera", "LightEmission": "@roblox/globaltype/Beam.LightEmission", "LightInfluence": "@roblox/globaltype/Beam.LightInfluence", "LocalTransparencyModifier": "@roblox/globaltype/Beam.LocalTransparencyModifier", "Segments": "@roblox/globaltype/Beam.Segments", "Texture": "@roblox/globaltype/Beam.Texture", "TextureLength": "@roblox/globaltype/Beam.TextureLength", "TextureMode": "@roblox/globaltype/Beam.TextureMode", "TextureSpeed": "@roblox/globaltype/Beam.TextureSpeed", "Transparency": "@roblox/globaltype/Beam.Transparency", "Width0": "@roblox/globaltype/Beam.Width0", "Width1": "@roblox/globaltype/Beam.Width1", "ZOffset": "@roblox/globaltype/Beam.ZOffset", "SetTextureOffset": "@roblox/globaltype/Beam.SetTextureOffset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam", "code_sample": "" }, "@roblox/globaltype/Beam.Attachment0": { "documentation": "The Attachment the beam originates from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Attachment0", "code_sample": "" }, "@roblox/globaltype/Beam.Attachment1": { "documentation": "The Attachment the beam ends at.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Attachment1", "code_sample": "" }, "@roblox/globaltype/Beam.Brightness": { "documentation": "Scales the light emitted from the beam when LightInfluence is less than 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Brightness", "code_sample": "" }, "@roblox/globaltype/Beam.Color": { "documentation": "Determines the color of the beam across its Segments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Color", "code_sample": "" }, "@roblox/globaltype/Beam.CurveSize0": { "documentation": "Determines, along with Attachment0, the position of the second control point in the beam's Bézier curve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#CurveSize0", "code_sample": "" }, "@roblox/globaltype/Beam.CurveSize1": { "documentation": "Determines, along with Attachment1, the position of the third control point in the beam's Bézier curve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#CurveSize1", "code_sample": "" }, "@roblox/globaltype/Beam.Enabled": { "documentation": "Determines whether the beam is visible or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Enabled", "code_sample": "" }, "@roblox/globaltype/Beam.FaceCamera": { "documentation": "Determines whether the Segments of the beam will always face the camera, regardless of its orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#FaceCamera", "code_sample": "" }, "@roblox/globaltype/Beam.LightEmission": { "documentation": "Determines to what degree the colors of the beam are blended with the colors behind it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#LightEmission", "code_sample": "" }, "@roblox/globaltype/Beam.LightInfluence": { "documentation": "Determines the degree to which the beam is influenced by the environment's lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#LightInfluence", "code_sample": "" }, "@roblox/globaltype/Beam.LocalTransparencyModifier": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Beam.Segments": { "documentation": "Sets how many straight segments the beam is made up of.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Segments", "code_sample": "" }, "@roblox/globaltype/Beam.Texture": { "documentation": "The content ID of the texture to be displayed on the beam.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Texture", "code_sample": "" }, "@roblox/globaltype/Beam.TextureLength": { "documentation": "Sets the length of the beam's texture, dependent on TextureMode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#TextureLength", "code_sample": "" }, "@roblox/globaltype/Beam.TextureMode": { "documentation": "Determines the manner in which the Texture scales and repeats.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#TextureMode", "code_sample": "" }, "@roblox/globaltype/Beam.TextureSpeed": { "documentation": "Determines the speed at which the Texture image moves along the beam.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#TextureSpeed", "code_sample": "" }, "@roblox/globaltype/Beam.Transparency": { "documentation": "Determines the transparency of the beam across its segments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Transparency", "code_sample": "" }, "@roblox/globaltype/Beam.Width0": { "documentation": "The width of the beam at its origin (Attachment0), in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Width0", "code_sample": "" }, "@roblox/globaltype/Beam.Width1": { "documentation": "The width of the beam at its end (Attachment1), in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#Width1", "code_sample": "" }, "@roblox/globaltype/Beam.ZOffset": { "documentation": "The distance, in studs, the beam display is offset relative to the CurrentCamera.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#ZOffset", "code_sample": "" }, "@roblox/globaltype/Beam.SetTextureOffset/param/0": { "documentation": "Connects two Attachments by drawing a texture between them." }, "@roblox/globaltype/Beam.SetTextureOffset/param/1": { "documentation": "The desired offset of the texture cycle." }, "@roblox/globaltype/Beam.SetTextureOffset": { "documentation": "Sets the current offset of the beam's texture cycle.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Beam.SetTextureOffset/param/0" }, { "name": "offset", "documentation": "@roblox/globaltype/Beam.SetTextureOffset/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Beam#SetTextureOffset", "code_sample": "" }, "@roblox/globaltype/StyleRule": { "documentation": "Defines style properties which override properties on the instances affected by the Selector property.", "keys": { "Priority": "@roblox/globaltype/StyleRule.Priority", "Selector": "@roblox/globaltype/StyleRule.Selector", "SelectorError": "@roblox/globaltype/StyleRule.SelectorError", "GetProperties": "@roblox/globaltype/StyleRule.GetProperties", "GetProperty": "@roblox/globaltype/StyleRule.GetProperty", "SetProperties": "@roblox/globaltype/StyleRule.SetProperties", "SetProperty": "@roblox/globaltype/StyleRule.SetProperty" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule", "code_sample": "" }, "@roblox/globaltype/StyleRule.Priority": { "documentation": "A number that determines how properties of the StyleRule apply relative to the same properties in other StyleRules. Higher priority values take precedence over lower.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#Priority", "code_sample": "" }, "@roblox/globaltype/StyleRule.Selector": { "documentation": "A string specifying which instances the StyleRule should affect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#Selector", "code_sample": "local ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\n\nlocal screenGui = script.Parent\n\nlocal coreSheet = Instance.new(\"StyleSheet\")\ncoreSheet.Parent = ReplicatedStorage\nlocal styleLink = Instance.new(\"StyleLink\")\nstyleLink.StyleSheet = coreSheet\nstyleLink.Parent = screenGui\nlocal rule = Instance.new(\"StyleRule\")\nrule.Parent = coreSheet\n\n-- Class selector\nrule.Selector = \"TextButton\"\n\n-- Set rule properties\nrule:SetProperties({\n\t[\"BackgroundColor3\"] = Color3.fromHex(\"335FFF\"),\n\t[\"TextColor3\"] = Color3.fromHex(\"E1E1E1\"),\n\t[\"Size\"] = UDim2.new(0.15, 0, 0, 40),\n\t[\"BorderSizePixel\"] = 0,\n})\n\nlocal button = Instance.new(\"TextButton\")\nbutton.Text = \"Main Menu\"\nbutton.Parent = screenGui" }, "@roblox/globaltype/StyleRule.SelectorError": { "documentation": "A read-only string that displays errors from the Selector property.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#SelectorError", "code_sample": "" }, "@roblox/globaltype/StyleRule.GetProperties/param/0": { "documentation": "Defines style properties which override properties on the instances affected by the Selector property." }, "@roblox/globaltype/StyleRule.GetProperties/return/0": { "documentation": "Dictionary of key-value pairs describing the properties of the StyleRule." }, "@roblox/globaltype/StyleRule.GetProperties": { "documentation": "Returns a dictionary of key-value pairs describing the properties of the StyleRule.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleRule.GetProperties/param/0" } ], "returns": [ "@roblox/globaltype/StyleRule.GetProperties/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetProperties", "code_sample": "" }, "@roblox/globaltype/StyleRule.GetProperty/param/0": { "documentation": "Defines style properties which override properties on the instances affected by the Selector property." }, "@roblox/globaltype/StyleRule.GetProperty/param/1": { "documentation": "String name of the property, for example \"AnchorPoint\" or \"BackgroundColor3\"." }, "@roblox/globaltype/StyleRule.GetProperty/return/0": { "documentation": "Value of the property." }, "@roblox/globaltype/StyleRule.GetProperty": { "documentation": "Returns the value of a specific property in the StyleRule.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleRule.GetProperty/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/StyleRule.GetProperty/param/1" } ], "returns": [ "@roblox/globaltype/StyleRule.GetProperty/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetProperty", "code_sample": "" }, "@roblox/globaltype/StyleRule.SetProperties/param/0": { "documentation": "Defines style properties which override properties on the instances affected by the Selector property." }, "@roblox/globaltype/StyleRule.SetProperties/param/1": { "documentation": "Dictionary of key-value pairs defining the properties to set." }, "@roblox/globaltype/StyleRule.SetProperties": { "documentation": "Lets you declare and set multiple properties of the StyleRule at once.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleRule.SetProperties/param/0" }, { "name": "styleProperties", "documentation": "@roblox/globaltype/StyleRule.SetProperties/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetProperties", "code_sample": "" }, "@roblox/globaltype/StyleRule.SetProperty/param/0": { "documentation": "Defines style properties which override properties on the instances affected by the Selector property." }, "@roblox/globaltype/StyleRule.SetProperty/param/1": { "documentation": "Property name to set, for example \"BackgroundColor3\"." }, "@roblox/globaltype/StyleRule.SetProperty/param/2": { "documentation": "Property value to set, for example Color3.new(1, 0, 0.25)." }, "@roblox/globaltype/StyleRule.SetProperty": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StyleRule.SetProperty/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/StyleRule.SetProperty/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/StyleRule.SetProperty/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetProperty", "code_sample": "" }, "@roblox/globaltype/LocalizationTable": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages.", "keys": { "DevelopmentLanguage": "@roblox/globaltype/LocalizationTable.DevelopmentLanguage", "Root": "@roblox/globaltype/LocalizationTable.Root", "SourceLocaleId": "@roblox/globaltype/LocalizationTable.SourceLocaleId", "GetContents": "@roblox/globaltype/LocalizationTable.GetContents", "GetEntries": "@roblox/globaltype/LocalizationTable.GetEntries", "GetString": "@roblox/globaltype/LocalizationTable.GetString", "GetTranslator": "@roblox/globaltype/LocalizationTable.GetTranslator", "RemoveEntry": "@roblox/globaltype/LocalizationTable.RemoveEntry", "RemoveEntryValue": "@roblox/globaltype/LocalizationTable.RemoveEntryValue", "RemoveKey": "@roblox/globaltype/LocalizationTable.RemoveKey", "RemoveTargetLocale": "@roblox/globaltype/LocalizationTable.RemoveTargetLocale", "SetContents": "@roblox/globaltype/LocalizationTable.SetContents", "SetEntries": "@roblox/globaltype/LocalizationTable.SetEntries", "SetEntry": "@roblox/globaltype/LocalizationTable.SetEntry", "SetEntryContext": "@roblox/globaltype/LocalizationTable.SetEntryContext", "SetEntryExample": "@roblox/globaltype/LocalizationTable.SetEntryExample", "SetEntryKey": "@roblox/globaltype/LocalizationTable.SetEntryKey", "SetEntrySource": "@roblox/globaltype/LocalizationTable.SetEntrySource", "SetEntryValue": "@roblox/globaltype/LocalizationTable.SetEntryValue" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.DevelopmentLanguage": { "documentation": "Deprecated: This item has been superseded by LocalizationTable.SourceLocaleId which should be used in all new work.
The default IETF tag to use if the ''languageKey'' parameter is excluded from the LocalizationTable:GetString() method.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#DevelopmentLanguage", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.Root": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.
The object that is being targeted for localization by this table. Localization is applied to it and all of it's descendants.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#Root", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SourceLocaleId": { "documentation": "The locale of source strings.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SourceLocaleId", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.GetContents/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.GetContents/return/0": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.GetContents": { "documentation": "Deprecated: This item has been superseded by LocalizationTable:GetEntries() which should be used in all new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.GetContents/param/0" } ], "returns": [ "@roblox/globaltype/LocalizationTable.GetContents/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetContents", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.GetEntries/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.GetEntries/return/0": { "documentation": "An array of dictionaries, where each dictionary represents an entry of localization data." }, "@roblox/globaltype/LocalizationTable.GetEntries": { "documentation": "Returns an array of dictionaries, where each dictionary represents an entry of localization data.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.GetEntries/param/0" } ], "returns": [ "@roblox/globaltype/LocalizationTable.GetEntries/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetEntries", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.GetString/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.GetString/param/1": { "documentation": "Specified language." }, "@roblox/globaltype/LocalizationTable.GetString/param/2": { "documentation": "An optional unique key for fast hash lookups in code. If it is non-empty it must be unique in the table." }, "@roblox/globaltype/LocalizationTable.GetString/return/0": { "documentation": "Translated string." }, "@roblox/globaltype/LocalizationTable.GetString": { "documentation": "Deprecated: This item has been superseded by LocalizationTable:GetTranslator() which should be used in all new work.
Returns a translation based on the specified language and key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.GetString/param/0" }, { "name": "targetLocaleId", "documentation": "@roblox/globaltype/LocalizationTable.GetString/param/1" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.GetString/param/2" } ], "returns": [ "@roblox/globaltype/LocalizationTable.GetString/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetString", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.GetTranslator/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.GetTranslator/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.GetTranslator/return/0": { "documentation": "The Translator instance for the specified locale." }, "@roblox/globaltype/LocalizationTable.GetTranslator": { "documentation": "Returns a Translator for entries in this LocalizationTable, in the specified locale.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.GetTranslator/param/0" }, { "name": "localeId", "documentation": "@roblox/globaltype/LocalizationTable.GetTranslator/param/1" } ], "returns": [ "@roblox/globaltype/LocalizationTable.GetTranslator/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetTranslator", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntry/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.RemoveEntry/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntry/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntry/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntry": { "documentation": "Removes an entry from the LocalizationTable, using the specified key, source, and context to narrow down the specific entry to be removed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntry/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntry/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntry/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntry/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveEntry", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/4": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveEntryValue": { "documentation": "Removes a single language translation from the LocalizationTable, using the provided key, source, context, and localeId to narrow down the specific entry to be removed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/3" }, { "name": "localeId", "documentation": "@roblox/globaltype/LocalizationTable.RemoveEntryValue/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveEntryValue", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.RemoveKey/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.RemoveKey/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveKey": { "documentation": "Deprecated: This item has been superseded by LocalizationTable:RemoveEntry() which should be used in all new work
Deprecated in favor of LocalizationTable:RemoveEntry().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.RemoveKey/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.RemoveKey/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveKey", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.RemoveTargetLocale/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.RemoveTargetLocale/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.RemoveTargetLocale": { "documentation": "Removes all translations from the LocalizationTable with the specified localeId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.RemoveTargetLocale/param/0" }, { "name": "localeId", "documentation": "@roblox/globaltype/LocalizationTable.RemoveTargetLocale/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#RemoveTargetLocale", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetContents/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetContents/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetContents": { "documentation": "Deprecated: This item has been superseded by LocalizationTable:SetEntries() which should be used in all new work
Sets the contents of the LocalizationTable, via the legacy JSON format.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetContents/param/0" }, { "name": "contents", "documentation": "@roblox/globaltype/LocalizationTable.SetContents/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetContents", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntries/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntries/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntries": { "documentation": "Sets the contents of the LocalizationTable.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntries/param/0" }, { "name": "entries", "documentation": "@roblox/globaltype/LocalizationTable.SetEntries/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntries", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntry/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntry/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntry/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntry/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntry": { "documentation": "Deprecated: This item has been superseded by LocalizationTable:SetEntries() which should be used in all new work", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntry/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.SetEntry/param/1" }, { "name": "targetLocaleId", "documentation": "@roblox/globaltype/LocalizationTable.SetEntry/param/2" }, { "name": "text", "documentation": "@roblox/globaltype/LocalizationTable.SetEntry/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntry", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntryContext/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntryContext/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryContext/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryContext/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryContext/param/4": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryContext": { "documentation": "Sets the Context field of a LocalizationTable entry to newContext, using the specified key, source, and context to narrow down the entry that will have this change applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryContext/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryContext/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryContext/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryContext/param/3" }, { "name": "newContext", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryContext/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryContext", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntryExample/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntryExample/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryExample/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryExample/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryExample/param/4": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryExample": { "documentation": "Sets the Example field of a LocalizationTable entry to example, using the specified key, source, and context to narrow down the entry that will have this change applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryExample/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryExample/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryExample/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryExample/param/3" }, { "name": "example", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryExample/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryExample", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntryKey/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntryKey/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryKey/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryKey/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryKey/param/4": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryKey": { "documentation": "Sets the Key field of a LocalizationTable entry to newKey, using the specified key, source, and context to narrow down the entry that will have this change applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryKey/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryKey/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryKey/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryKey/param/3" }, { "name": "newKey", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryKey/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryKey", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntrySource/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntrySource/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntrySource/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntrySource/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntrySource/param/4": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntrySource": { "documentation": "Sets the Source field of a LocalizationTable entry to newSource, using the specified key, source, and context to narrow down the entry that will have this change applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntrySource/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.SetEntrySource/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.SetEntrySource/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.SetEntrySource/param/3" }, { "name": "newSource", "documentation": "@roblox/globaltype/LocalizationTable.SetEntrySource/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntrySource", "code_sample": "" }, "@roblox/globaltype/LocalizationTable.SetEntryValue/param/0": { "documentation": "A LocalizationTable is a database of translations. It contains source strings and translations for various languages." }, "@roblox/globaltype/LocalizationTable.SetEntryValue/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryValue/param/2": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryValue/param/3": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryValue/param/4": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryValue/param/5": { "documentation": "" }, "@roblox/globaltype/LocalizationTable.SetEntryValue": { "documentation": "Sets the text of the specified localeId in a LocalizationTable entry, using the specified key, source, and context to narrow down the entry that will have this change applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryValue/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryValue/param/1" }, { "name": "source", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryValue/param/2" }, { "name": "context", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryValue/param/3" }, { "name": "localeId", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryValue/param/4" }, { "name": "text", "documentation": "@roblox/globaltype/LocalizationTable.SetEntryValue/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#SetEntryValue", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties": { "documentation": "", "keys": { "BackgroundColor3": "@roblox/globaltype/BubbleChatMessageProperties.BackgroundColor3", "BackgroundTransparency": "@roblox/globaltype/BubbleChatMessageProperties.BackgroundTransparency", "FontFace": "@roblox/globaltype/BubbleChatMessageProperties.FontFace", "TailVisible": "@roblox/globaltype/BubbleChatMessageProperties.TailVisible", "TextColor3": "@roblox/globaltype/BubbleChatMessageProperties.TextColor3", "TextSize": "@roblox/globaltype/BubbleChatMessageProperties.TextSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties.BackgroundColor3": { "documentation": "Background color of bubbles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#BackgroundColor3", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties.BackgroundTransparency": { "documentation": "Background transparency of bubbles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#BackgroundTransparency", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties.FontFace": { "documentation": "Font of the bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#FontFace", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties.TailVisible": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#TailVisible", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties.TextColor3": { "documentation": "Color of bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#TextColor3", "code_sample": "" }, "@roblox/globaltype/BubbleChatMessageProperties.TextSize": { "documentation": "Size of bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatMessageProperties#TextSize", "code_sample": "" }, "@roblox/globaltype/CustomLog": { "documentation": "", "keys": { "Close": "@roblox/globaltype/CustomLog.Close", "GetLogPath": "@roblox/globaltype/CustomLog.GetLogPath", "Open": "@roblox/globaltype/CustomLog.Open", "WriteAppend": "@roblox/globaltype/CustomLog.WriteAppend" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomLog", "code_sample": "" }, "@roblox/globaltype/CustomLog.Close/param/0": { "documentation": "" }, "@roblox/globaltype/CustomLog.Close": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomLog.Close/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomLog#Close", "code_sample": "" }, "@roblox/globaltype/CustomLog.GetLogPath/param/0": { "documentation": "" }, "@roblox/globaltype/CustomLog.GetLogPath/return/0": { "documentation": "" }, "@roblox/globaltype/CustomLog.GetLogPath": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomLog.GetLogPath/param/0" } ], "returns": [ "@roblox/globaltype/CustomLog.GetLogPath/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomLog#GetLogPath", "code_sample": "" }, "@roblox/globaltype/CustomLog.Open/param/0": { "documentation": "" }, "@roblox/globaltype/CustomLog.Open": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomLog.Open/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomLog#Open", "code_sample": "" }, "@roblox/globaltype/CustomLog.WriteAppend/param/0": { "documentation": "" }, "@roblox/globaltype/CustomLog.WriteAppend/param/1": { "documentation": "" }, "@roblox/globaltype/CustomLog.WriteAppend": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CustomLog.WriteAppend/param/0" }, { "name": "append", "documentation": "@roblox/globaltype/CustomLog.WriteAppend/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CustomLog#WriteAppend", "code_sample": "" }, "@roblox/globaltype/AlignPosition": { "documentation": "Constraint which applies force to move two attachments together, or to move one attachment to a goal position.", "keys": { "ApplyAtCenterOfMass": "@roblox/globaltype/AlignPosition.ApplyAtCenterOfMass", "ForceLimitMode": "@roblox/globaltype/AlignPosition.ForceLimitMode", "ForceRelativeTo": "@roblox/globaltype/AlignPosition.ForceRelativeTo", "MaxAxesForce": "@roblox/globaltype/AlignPosition.MaxAxesForce", "MaxForce": "@roblox/globaltype/AlignPosition.MaxForce", "MaxVelocity": "@roblox/globaltype/AlignPosition.MaxVelocity", "Mode": "@roblox/globaltype/AlignPosition.Mode", "Position": "@roblox/globaltype/AlignPosition.Position", "ReactionForceEnabled": "@roblox/globaltype/AlignPosition.ReactionForceEnabled", "Responsiveness": "@roblox/globaltype/AlignPosition.Responsiveness", "RigidityEnabled": "@roblox/globaltype/AlignPosition.RigidityEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition", "code_sample": "" }, "@roblox/globaltype/AlignPosition.ApplyAtCenterOfMass": { "documentation": "Whether force is applied to the parent of Attachment0 at that attachment's location, or at the parents' center of mass.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#ApplyAtCenterOfMass", "code_sample": "" }, "@roblox/globaltype/AlignPosition.ForceLimitMode": { "documentation": "Determines how the constraint force will be limited. Only used if RigidityEnabled is false.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#ForceLimitMode", "code_sample": "" }, "@roblox/globaltype/AlignPosition.ForceRelativeTo": { "documentation": "Determines the axes that the constraint uses to limit the force. Only applies when RigidityEnabled is false and AlignPosition.ForceLimitMode is PerAxis. .", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#ForceRelativeTo", "code_sample": "" }, "@roblox/globaltype/AlignPosition.MaxAxesForce": { "documentation": "Maximum force along each axis that the constraint can apply to achieve its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#MaxAxesForce", "code_sample": "" }, "@roblox/globaltype/AlignPosition.MaxForce": { "documentation": "Maximum force magnitude the constraint can apply to achieve its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#MaxForce", "code_sample": "" }, "@roblox/globaltype/AlignPosition.MaxVelocity": { "documentation": "Maximum speed the attachments can move when converging.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#MaxVelocity", "code_sample": "" }, "@roblox/globaltype/AlignPosition.Mode": { "documentation": "Whether the constraint uses one or two attachments in calculating its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#Mode", "code_sample": "" }, "@roblox/globaltype/AlignPosition.Position": { "documentation": "The position to which the constraint should move its Attachment0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#Position", "code_sample": "" }, "@roblox/globaltype/AlignPosition.ReactionForceEnabled": { "documentation": "Whether the constraint applies force only to Attachment0, or to both attachments in equal and opposite directions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#ReactionForceEnabled", "code_sample": "" }, "@roblox/globaltype/AlignPosition.Responsiveness": { "documentation": "Controls how quickly the constraint reaches its goal. Higher values cause the attachment(s) to align more rapidly.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#Responsiveness", "code_sample": "" }, "@roblox/globaltype/AlignPosition.RigidityEnabled": { "documentation": "Whether force is dependent on other properties, or if the physics solver reacts as quickly as possible to complete the alignment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AlignPosition#RigidityEnabled", "code_sample": "" }, "@roblox/globaltype/BodyAngularVelocity": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use AngularVelocity instead, and see the legacy conversion notes.
Applies a torque to maintain a constant angular velocity.", "keys": { "AngularVelocity": "@roblox/globaltype/BodyAngularVelocity.AngularVelocity", "angularvelocity": "@roblox/globaltype/BodyAngularVelocity.angularvelocity", "MaxTorque": "@roblox/globaltype/BodyAngularVelocity.MaxTorque", "maxTorque": "@roblox/globaltype/BodyAngularVelocity.maxTorque", "P": "@roblox/globaltype/BodyAngularVelocity.P" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity", "code_sample": "" }, "@roblox/globaltype/BodyAngularVelocity.AngularVelocity": { "documentation": "Determines the axis of rotation (direction) and the rotational velocity (magnitude) in radians/s.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity#AngularVelocity", "code_sample": "" }, "@roblox/globaltype/BodyAngularVelocity.angularvelocity": { "documentation": "Deprecated: This deprecated property is a variant of BodyAngularVelocity.AngularVelocity which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity#angularvelocity", "code_sample": "" }, "@roblox/globaltype/BodyAngularVelocity.MaxTorque": { "documentation": "Determines the limit of torque that may be exerted on each world axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity#MaxTorque", "code_sample": "" }, "@roblox/globaltype/BodyAngularVelocity.maxTorque": { "documentation": "Deprecated: This deprecated property is a variant of BodyAngularVelocity.MaxTorque which should be used instead.
Determines how much force can be applied to each axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity#maxTorque", "code_sample": "" }, "@roblox/globaltype/BodyAngularVelocity.P": { "documentation": "Determines how aggressive of a torque is applied in reaching the goal angular velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyAngularVelocity#P", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer": { "documentation": "Takes measurements from audio streams that are connected to it via one or more Wires.", "keys": { "PeakLevel": "@roblox/globaltype/AudioAnalyzer.PeakLevel", "RmsLevel": "@roblox/globaltype/AudioAnalyzer.RmsLevel", "SpectrumEnabled": "@roblox/globaltype/AudioAnalyzer.SpectrumEnabled", "WindowSize": "@roblox/globaltype/AudioAnalyzer.WindowSize", "GetConnectedWires": "@roblox/globaltype/AudioAnalyzer.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioAnalyzer.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioAnalyzer.GetOutputPins", "GetSpectrum": "@roblox/globaltype/AudioAnalyzer.GetSpectrum" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.PeakLevel": { "documentation": "The loudest volume observed during the last audio buffer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#PeakLevel", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.RmsLevel": { "documentation": "The root-mean-square average volume observed during the last audio buffer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#RmsLevel", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.SpectrumEnabled": { "documentation": "Enables usage of GetSpectrum.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#SpectrumEnabled", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.WindowSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#WindowSize", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.GetConnectedWires/param/0": { "documentation": "Takes measurements from audio streams that are connected to it via one or more Wires." }, "@roblox/globaltype/AudioAnalyzer.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioAnalyzer.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioAnalyzer.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.GetInputPins/param/0": { "documentation": "Takes measurements from audio streams that are connected to it via one or more Wires." }, "@roblox/globaltype/AudioAnalyzer.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioAnalyzer.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.GetOutputPins/param/0": { "documentation": "Takes measurements from audio streams that are connected to it via one or more Wires." }, "@roblox/globaltype/AudioAnalyzer.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioAnalyzer.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.GetSpectrum/param/0": { "documentation": "Takes measurements from audio streams that are connected to it via one or more Wires." }, "@roblox/globaltype/AudioAnalyzer.GetSpectrum/return/0": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.GetSpectrum": { "documentation": "Returns the frequency spectrum of the last audio buffer.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.GetSpectrum/param/0" } ], "returns": [ "@roblox/globaltype/AudioAnalyzer.GetSpectrum/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetSpectrum", "code_sample": "" }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioAnalyzer.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioAnalyzer.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioAnalyzer via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioAnalyzer.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioAnalyzer.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#WiringChanged", "code_sample": "" }, "@roblox/globaltype/GamePassService": { "documentation": "A service associated with the legacy game pass system. Use MarketplaceService for all new work.", "keys": { "PlayerHasPass": "@roblox/globaltype/GamePassService.PlayerHasPass" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GamePassService", "code_sample": "" }, "@roblox/globaltype/GamePassService.PlayerHasPass/param/0": { "documentation": "A service associated with the legacy game pass system. Use MarketplaceService for all new work." }, "@roblox/globaltype/GamePassService.PlayerHasPass/param/1": { "documentation": "The Player for which to check ownership." }, "@roblox/globaltype/GamePassService.PlayerHasPass/param/2": { "documentation": "The Asset ID of the game pass. This is not the Game Pass ID (see above)." }, "@roblox/globaltype/GamePassService.PlayerHasPass/return/0": { "documentation": "Whether the Player owns the game pass." }, "@roblox/globaltype/GamePassService.PlayerHasPass": { "documentation": "Deprecated:
Returns true if the Player has the specified legacy game pass. Does not work with new game passes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GamePassService.PlayerHasPass/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/GamePassService.PlayerHasPass/param/1" }, { "name": "gamePassId", "documentation": "@roblox/globaltype/GamePassService.PlayerHasPass/param/2" } ], "returns": [ "@roblox/globaltype/GamePassService.PlayerHasPass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GamePassService#PlayerHasPass", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal GAMEPASS_ID = 103728213\n\nPlayers.PlayerAdded:Connect(function(player)\n\tif game:GetService(\"GamePassService\"):PlayerHasPass(player, GAMEPASS_ID) then\n\t\tprint(player.Name .. \" has the game pass!\")\n\telse\n\t\tprint(player.Name .. \" doesn't have the game pass...\")\n\tend\nend)" }, "@roblox/globaltype/SelectionSphere": { "documentation": "Renders a 3D sphere around its Adornee.", "keys": { "SurfaceColor": "@roblox/globaltype/SelectionSphere.SurfaceColor", "SurfaceColor3": "@roblox/globaltype/SelectionSphere.SurfaceColor3", "SurfaceTransparency": "@roblox/globaltype/SelectionSphere.SurfaceTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionSphere", "code_sample": "" }, "@roblox/globaltype/SelectionSphere.SurfaceColor": { "documentation": "Deprecated: This property is deprecated in favor of SurfaceColor3 which uses the more precise Color3 data type instead of a BrickColor used by this property.
A BrickColor version of SurfaceColor3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceColor", "code_sample": "" }, "@roblox/globaltype/SelectionSphere.SurfaceColor3": { "documentation": "Determines the color of the sphere's surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceColor3", "code_sample": "" }, "@roblox/globaltype/SelectionSphere.SurfaceTransparency": { "documentation": "Determines the transparency of the sphere's surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SelectionSphere#SurfaceTransparency", "code_sample": "" }, "@roblox/globaltype/Selection": { "documentation": "The Selection service controls the Instances that are selected in Roblox Studio.", "keys": { "SelectionThickness": "@roblox/globaltype/Selection.SelectionThickness", "Add": "@roblox/globaltype/Selection.Add", "Get": "@roblox/globaltype/Selection.Get", "Remove": "@roblox/globaltype/Selection.Remove", "Set": "@roblox/globaltype/Selection.Set" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection", "code_sample": "local Selection = game:GetService(\"Selection\")\n\nfor _, object in pairs(Selection:Get()) do\n\tif object:IsA(\"BasePart\") then\n\t\tobject.CFrame = object.CFrame * CFrame.Angles(0, math.pi / 2, 0)\n\tend\nend" }, "@roblox/globaltype/Selection.SelectionThickness": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection#SelectionThickness", "code_sample": "" }, "@roblox/globaltype/Selection.Add/param/0": { "documentation": "The Selection service controls the Instances that are selected in Roblox Studio." }, "@roblox/globaltype/Selection.Add/param/1": { "documentation": "" }, "@roblox/globaltype/Selection.Add": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.Add/param/0" }, { "name": "instancesToAdd", "documentation": "@roblox/globaltype/Selection.Add/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection#Add", "code_sample": "" }, "@roblox/globaltype/Selection.Get/param/0": { "documentation": "The Selection service controls the Instances that are selected in Roblox Studio." }, "@roblox/globaltype/Selection.Get/return/0": { "documentation": "An array of currently selected Instances." }, "@roblox/globaltype/Selection.Get": { "documentation": "Returns an array of currently selected Instances in Roblox Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.Get/param/0" } ], "returns": [ "@roblox/globaltype/Selection.Get/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection#Get", "code_sample": "local Selection = game:GetService(\"Selection\")\n\nfor _, object in pairs(Selection:Get()) do\n\tif object:IsA(\"BasePart\") then\n\t\tobject.CFrame = object.CFrame * CFrame.Angles(0, math.pi / 2, 0)\n\tend\nend" }, "@roblox/globaltype/Selection.Remove/param/0": { "documentation": "The Selection service controls the Instances that are selected in Roblox Studio." }, "@roblox/globaltype/Selection.Remove/param/1": { "documentation": "" }, "@roblox/globaltype/Selection.Remove": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.Remove/param/0" }, { "name": "instancesToRemove", "documentation": "@roblox/globaltype/Selection.Remove/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection#Remove", "code_sample": "" }, "@roblox/globaltype/Selection.Set/param/0": { "documentation": "The Selection service controls the Instances that are selected in Roblox Studio." }, "@roblox/globaltype/Selection.Set/param/1": { "documentation": "An array of Instances to set the current selection to." }, "@roblox/globaltype/Selection.Set": { "documentation": "Sets the currently selected objects in Roblox Studio to Instances in the given array.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.Set/param/0" }, { "name": "selection", "documentation": "@roblox/globaltype/Selection.Set/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection#Set", "code_sample": "" }, "@roblox/globaltype/Selection.SelectionChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Selection.SelectionChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Selection.SelectionChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.SelectionChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Selection.SelectionChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Selection.SelectionChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Selection.SelectionChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Selection.SelectionChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.SelectionChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Selection.SelectionChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Selection.SelectionChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Selection.SelectionChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Selection.SelectionChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.SelectionChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Selection.SelectionChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Selection.SelectionChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Selection.SelectionChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Selection.SelectionChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Selection.SelectionChanged": { "documentation": "Fires when the Instances selected in Roblox Studio changes.", "keys": { "Connect": "@roblox/globaltype/Selection.SelectionChanged.Connect", "ConnectParallel": "@roblox/globaltype/Selection.SelectionChanged.ConnectParallel", "Once": "@roblox/globaltype/Selection.SelectionChanged.Once", "Wait": "@roblox/globaltype/Selection.SelectionChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Selection#SelectionChanged", "code_sample": "local selection = game:GetService(\"Selection\")\n\nselection.SelectionChanged:Connect(function()\n\tprint(\"Selection contains \" .. #selection:Get() .. \" items.\")\nend)" }, "@roblox/globaltype/SmoothVoxelsUpgraderService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SmoothVoxelsUpgraderService", "code_sample": "" }, "@roblox/globaltype/AssetDeliveryProxy": { "documentation": "", "keys": { "Interface": "@roblox/globaltype/AssetDeliveryProxy.Interface", "Port": "@roblox/globaltype/AssetDeliveryProxy.Port", "StartServer": "@roblox/globaltype/AssetDeliveryProxy.StartServer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy", "code_sample": "" }, "@roblox/globaltype/AssetDeliveryProxy.Interface": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy#Interface", "code_sample": "" }, "@roblox/globaltype/AssetDeliveryProxy.Port": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy#Port", "code_sample": "" }, "@roblox/globaltype/AssetDeliveryProxy.StartServer": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetDeliveryProxy#StartServer", "code_sample": "" }, "@roblox/globaltype/DataStoreOptions": { "documentation": "Object used to provide additional parameters to DataStoreService:GetDataStore().", "keys": { "AllScopes": "@roblox/globaltype/DataStoreOptions.AllScopes", "SetExperimentalFeatures": "@roblox/globaltype/DataStoreOptions.SetExperimentalFeatures" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions", "code_sample": "" }, "@roblox/globaltype/DataStoreOptions.AllScopes": { "documentation": "Whether the GlobalDataStore should work with all scopes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions#AllScopes", "code_sample": "" }, "@roblox/globaltype/DataStoreOptions.SetExperimentalFeatures/param/0": { "documentation": "Object used to provide additional parameters to DataStoreService:GetDataStore()." }, "@roblox/globaltype/DataStoreOptions.SetExperimentalFeatures/param/1": { "documentation": "Luau table in key = value format where the key is the experimental feature name and the value is a boolean which specifies whether to enable." }, "@roblox/globaltype/DataStoreOptions.SetExperimentalFeatures": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreOptions.SetExperimentalFeatures/param/0" }, { "name": "experimentalFeatures", "documentation": "@roblox/globaltype/DataStoreOptions.SetExperimentalFeatures/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreOptions#SetExperimentalFeatures", "code_sample": "" }, "@roblox/globaltype/GenericChallengeService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GenericChallengeService", "code_sample": "" }, "@roblox/globaltype/PostEffect": { "documentation": "Abstract base class for post-processing effects.", "keys": { "Enabled": "@roblox/globaltype/PostEffect.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PostEffect", "code_sample": "" }, "@roblox/globaltype/PostEffect.Enabled": { "documentation": "Toggles whether or not the PostEffect is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PostEffect#Enabled", "code_sample": "" }, "@roblox/globaltype/ManualWeld": { "documentation": "Deprecated:
Holds two parts together and functions identically to Weld.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ManualWeld", "code_sample": "" }, "@roblox/globaltype/ReflectionService": { "documentation": "", "keys": { "GetClass": "@roblox/globaltype/ReflectionService.GetClass", "GetClasses": "@roblox/globaltype/ReflectionService.GetClasses", "GetPropertiesOfClass": "@roblox/globaltype/ReflectionService.GetPropertiesOfClass" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionService", "code_sample": "" }, "@roblox/globaltype/ReflectionService.GetClass/param/0": { "documentation": "" }, "@roblox/globaltype/ReflectionService.GetClass/param/1": { "documentation": "The name of the class for which you wish to retrieve information." }, "@roblox/globaltype/ReflectionService.GetClass/param/2": { "documentation": "An optional filter to restrict or expand the set of classes that this method can return and change the method's behavior." }, "@roblox/globaltype/ReflectionService.GetClass/return/0": { "documentation": "A ReflectedClass dictionary with reflection information if the class exists; otherwise, nil." }, "@roblox/globaltype/ReflectionService.GetClass": { "documentation": "Returns information about a class when given its name, assuming that class is accessible.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ReflectionService.GetClass/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/ReflectionService.GetClass/param/1" }, { "name": "filter", "documentation": "@roblox/globaltype/ReflectionService.GetClass/param/2" } ], "returns": [ "@roblox/globaltype/ReflectionService.GetClass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetClass", "code_sample": "" }, "@roblox/globaltype/ReflectionService.GetClasses/param/0": { "documentation": "" }, "@roblox/globaltype/ReflectionService.GetClasses/param/1": { "documentation": "An optional filter to restrict or expand the set of classes that this method can return and change the method's behavior." }, "@roblox/globaltype/ReflectionService.GetClasses/return/0": { "documentation": "A list of ReflectedClass dictionaries with reflection information for each class that matches the filter criteria." }, "@roblox/globaltype/ReflectionService.GetClasses": { "documentation": "Returns a list of all classes accessible with filters applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ReflectionService.GetClasses/param/0" }, { "name": "filter", "documentation": "@roblox/globaltype/ReflectionService.GetClasses/param/1" } ], "returns": [ "@roblox/globaltype/ReflectionService.GetClasses/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetClasses", "code_sample": "" }, "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/param/0": { "documentation": "" }, "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/param/1": { "documentation": "The name of the class for which you wish to retrieve properties." }, "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/param/2": { "documentation": "An optional filter to restrict or expand the set of properties that this method can return and change the method's behavior." }, "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/return/0": { "documentation": "A list of ReflectedProperty dictionaries with reflection information for each property of the class that matches the filter criteria." }, "@roblox/globaltype/ReflectionService.GetPropertiesOfClass": { "documentation": "Returns a list of properties for a given class with filters applied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/param/1" }, { "name": "filter", "documentation": "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/param/2" } ], "returns": [ "@roblox/globaltype/ReflectionService.GetPropertiesOfClass/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetPropertiesOfClass", "code_sample": "" }, "@roblox/globaltype/InstanceAdornment": { "documentation": "A base class for all objects that adorn Instance classes.", "keys": { "Adornee": "@roblox/globaltype/InstanceAdornment.Adornee" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceAdornment", "code_sample": "" }, "@roblox/globaltype/InstanceAdornment.Adornee": { "documentation": "Which Instance to adorn.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceAdornment#Adornee", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech": { "documentation": "Plays text as speech audio.", "keys": { "IsLoaded": "@roblox/globaltype/AudioTextToSpeech.IsLoaded", "IsPlaying": "@roblox/globaltype/AudioTextToSpeech.IsPlaying", "Looping": "@roblox/globaltype/AudioTextToSpeech.Looping", "Pitch": "@roblox/globaltype/AudioTextToSpeech.Pitch", "PlaybackSpeed": "@roblox/globaltype/AudioTextToSpeech.PlaybackSpeed", "Speed": "@roblox/globaltype/AudioTextToSpeech.Speed", "Text": "@roblox/globaltype/AudioTextToSpeech.Text", "TimeLength": "@roblox/globaltype/AudioTextToSpeech.TimeLength", "TimePosition": "@roblox/globaltype/AudioTextToSpeech.TimePosition", "VoiceId": "@roblox/globaltype/AudioTextToSpeech.VoiceId", "Volume": "@roblox/globaltype/AudioTextToSpeech.Volume", "GetConnectedWires": "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires", "GetWaveformAsync": "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync", "LoadAsync": "@roblox/globaltype/AudioTextToSpeech.LoadAsync", "Pause": "@roblox/globaltype/AudioTextToSpeech.Pause", "Play": "@roblox/globaltype/AudioTextToSpeech.Play", "Unload": "@roblox/globaltype/AudioTextToSpeech.Unload" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.IsLoaded": { "documentation": "Denotes whether the AudioTextToSpeech object is loaded, buffered, and ready to play.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#IsLoaded", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.IsPlaying": { "documentation": "Denotes whether the AudioTextToSpeech object is currently playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#IsPlaying", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Looping": { "documentation": "Controls whether the AudioTextToSpeech object loops.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Looping", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Pitch": { "documentation": "Controls the pitch of the generated speech audio, which will be independent of its speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pitch", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.PlaybackSpeed": { "documentation": "Controls how quickly the speech audio will be played, which controls its pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#PlaybackSpeed", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Speed": { "documentation": "Controls the speed of the generated speech audio, which will be independent of its pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Speed", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Text": { "documentation": "The text to be converted into speech audio by AudioTextToSpeech.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Text", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.TimeLength": { "documentation": "Denotes the length of the generated speech audio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#TimeLength", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.TimePosition": { "documentation": "Tracks the current position of the playhead within the generated speech audio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#TimePosition", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.VoiceId": { "documentation": "The voice style to be used by AudioTextToSpeech.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#VoiceId", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Volume": { "documentation": "Controls how loudly the generated speech audio will be played.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Volume", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires/param/0": { "documentation": "Plays text as speech audio." }, "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioTextToSpeech.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/param/0": { "documentation": "Plays text as speech audio." }, "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/param/2": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/param/0" }, { "name": "timeRange", "documentation": "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/param/1" }, { "name": "samples", "documentation": "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/param/2" } ], "returns": [ "@roblox/globaltype/AudioTextToSpeech.GetWaveformAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetWaveformAsync", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.LoadAsync/param/0": { "documentation": "Plays text as speech audio." }, "@roblox/globaltype/AudioTextToSpeech.LoadAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.LoadAsync": { "documentation": "Generates speech audio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.LoadAsync/param/0" } ], "returns": [ "@roblox/globaltype/AudioTextToSpeech.LoadAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#LoadAsync", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Pause/param/0": { "documentation": "Plays text as speech audio." }, "@roblox/globaltype/AudioTextToSpeech.Pause": { "documentation": "Pauses the AudioTextToSpeech object wherever its TimePosition is.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Pause", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Play/param/0": { "documentation": "Plays text as speech audio." }, "@roblox/globaltype/AudioTextToSpeech.Play": { "documentation": "Plays the AudioTextToSpeech from wherever its TimePosition is.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Play", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Unload/param/0": { "documentation": "Plays text as speech audio." }, "@roblox/globaltype/AudioTextToSpeech.Unload": { "documentation": "Unload the generated speech audio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Unload/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Unload", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Ended.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Ended.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.Ended.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Ended.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Ended.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.Ended.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Ended.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Ended.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.Ended.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Ended.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Ended.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Ended.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Ended": { "documentation": "Fires when the AudioTextToSpeech object has completed playback and paused.", "keys": { "Connect": "@roblox/globaltype/AudioTextToSpeech.Ended.Connect", "ConnectParallel": "@roblox/globaltype/AudioTextToSpeech.Ended.ConnectParallel", "Once": "@roblox/globaltype/AudioTextToSpeech.Ended.Once", "Wait": "@roblox/globaltype/AudioTextToSpeech.Ended.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Ended", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.Looped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Looped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.Looped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Looped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Looped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.Looped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Looped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Looped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.Looped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Looped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.Looped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.Looped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.Looped": { "documentation": "Fires when the AudioTextToSpeech object loops.", "keys": { "Connect": "@roblox/globaltype/AudioTextToSpeech.Looped.Connect", "ConnectParallel": "@roblox/globaltype/AudioTextToSpeech.Looped.ConnectParallel", "Once": "@roblox/globaltype/AudioTextToSpeech.Looped.Once", "Wait": "@roblox/globaltype/AudioTextToSpeech.Looped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#Looped", "code_sample": "" }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioTextToSpeech.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioTextToSpeech via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioTextToSpeech.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#WiringChanged", "code_sample": "" }, "@roblox/globaltype/GuiObject": { "documentation": "An abstract class for all 2D user interface objects.", "keys": { "Active": "@roblox/globaltype/GuiObject.Active", "AnchorPoint": "@roblox/globaltype/GuiObject.AnchorPoint", "AutomaticSize": "@roblox/globaltype/GuiObject.AutomaticSize", "BackgroundColor": "@roblox/globaltype/GuiObject.BackgroundColor", "BackgroundColor3": "@roblox/globaltype/GuiObject.BackgroundColor3", "BackgroundTransparency": "@roblox/globaltype/GuiObject.BackgroundTransparency", "BorderColor": "@roblox/globaltype/GuiObject.BorderColor", "BorderColor3": "@roblox/globaltype/GuiObject.BorderColor3", "BorderMode": "@roblox/globaltype/GuiObject.BorderMode", "BorderSizePixel": "@roblox/globaltype/GuiObject.BorderSizePixel", "ClipsDescendants": "@roblox/globaltype/GuiObject.ClipsDescendants", "Draggable": "@roblox/globaltype/GuiObject.Draggable", "GuiState": "@roblox/globaltype/GuiObject.GuiState", "Interactable": "@roblox/globaltype/GuiObject.Interactable", "LayoutOrder": "@roblox/globaltype/GuiObject.LayoutOrder", "NextSelectionDown": "@roblox/globaltype/GuiObject.NextSelectionDown", "NextSelectionLeft": "@roblox/globaltype/GuiObject.NextSelectionLeft", "NextSelectionRight": "@roblox/globaltype/GuiObject.NextSelectionRight", "NextSelectionUp": "@roblox/globaltype/GuiObject.NextSelectionUp", "Position": "@roblox/globaltype/GuiObject.Position", "Rotation": "@roblox/globaltype/GuiObject.Rotation", "Selectable": "@roblox/globaltype/GuiObject.Selectable", "SelectionImageObject": "@roblox/globaltype/GuiObject.SelectionImageObject", "SelectionOrder": "@roblox/globaltype/GuiObject.SelectionOrder", "Size": "@roblox/globaltype/GuiObject.Size", "SizeConstraint": "@roblox/globaltype/GuiObject.SizeConstraint", "Transparency": "@roblox/globaltype/GuiObject.Transparency", "Visible": "@roblox/globaltype/GuiObject.Visible", "ZIndex": "@roblox/globaltype/GuiObject.ZIndex", "TweenPosition": "@roblox/globaltype/GuiObject.TweenPosition", "TweenSize": "@roblox/globaltype/GuiObject.TweenSize", "TweenSizeAndPosition": "@roblox/globaltype/GuiObject.TweenSizeAndPosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject", "code_sample": "" }, "@roblox/globaltype/GuiObject.Active": { "documentation": "Determines whether this UI element sinks input.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Active", "code_sample": "-- Place this LocalScript within a TextButton (or ImageButton)\nlocal textButton = script.Parent\n\ntextButton.Text = \"Click me\"\ntextButton.Active = true\n\nlocal function onActivated()\n\t-- This acts like a debounce\n\ttextButton.Active = false\n\n\t-- Count backwards from 5\n\tfor i = 5, 1, -1 do\n\t\ttextButton.Text = \"Time: \" .. i\n\t\ttask.wait(1)\n\tend\n\ttextButton.Text = \"Click me\"\n\n\ttextButton.Active = true\nend\n\ntextButton.Activated:Connect(onActivated)" }, "@roblox/globaltype/GuiObject.AnchorPoint": { "documentation": "Determines the origin point of a GuiObject, relative to its absolute size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#AnchorPoint", "code_sample": "" }, "@roblox/globaltype/GuiObject.AutomaticSize": { "documentation": "Determines whether resizing occurs based on child content.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#AutomaticSize", "code_sample": "" }, "@roblox/globaltype/GuiObject.BackgroundColor": { "documentation": "Deprecated: This property is deprecated in favor of the Color3 property GuiObject.BackgroundColor3, which should be used in new work instead.
Determines the color of the GuiObject background.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BackgroundColor", "code_sample": "" }, "@roblox/globaltype/GuiObject.BackgroundColor3": { "documentation": "Determines the GuiObject background color.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BackgroundColor3", "code_sample": "-- Put this code in a LocalScript in a Frame\nlocal frame = script.Parent\n\nwhile true do\n\tfor hue = 0, 255, 4 do\n\t\t-- HSV = hue, saturation, value\n\t\t-- If we loop from 0 to 1 repeatedly, we get a rainbow!\n\t\tframe.BorderColor3 = Color3.fromHSV(hue / 256, 1, 1)\n\t\tframe.BackgroundColor3 = Color3.fromHSV(hue / 256, 0.5, 0.8)\n\t\ttask.wait()\n\tend\nend" }, "@roblox/globaltype/GuiObject.BackgroundTransparency": { "documentation": "Determines the transparency of the GuiObject background and border.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BackgroundTransparency", "code_sample": "" }, "@roblox/globaltype/GuiObject.BorderColor": { "documentation": "Deprecated: This property is deprecated in favor of the Color3 property BorderColor3, which should be used in new work instead.
Determines the color of the GuiObject border.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BorderColor", "code_sample": "" }, "@roblox/globaltype/GuiObject.BorderColor3": { "documentation": "Determines the color of the GuiObject border.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BorderColor3", "code_sample": "-- Put me inside some GuiObject, preferrably an ImageButton/TextButton\nlocal button = script.Parent\n\nlocal function onEnter()\n\tbutton.BorderSizePixel = 2\n\tbutton.BorderColor3 = Color3.new(1, 1, 0) -- Yellow\nend\n\nlocal function onLeave()\n\tbutton.BorderSizePixel = 1\n\tbutton.BorderColor3 = Color3.new(0, 0, 0) -- Black\nend\n\n-- Connect events\nbutton.MouseEnter:Connect(onEnter)\nbutton.MouseLeave:Connect(onLeave)\n-- Our default state is \"not hovered\"\nonLeave()" }, "@roblox/globaltype/GuiObject.BorderMode": { "documentation": "Determines in what manner the GuiObject border is laid out relative to its dimensions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BorderMode", "code_sample": "" }, "@roblox/globaltype/GuiObject.BorderSizePixel": { "documentation": "Determines the pixel width of the GuiObject border.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#BorderSizePixel", "code_sample": "-- Put me inside some GuiObject, preferrably an ImageButton/TextButton\nlocal button = script.Parent\n\nlocal function onEnter()\n\tbutton.BorderSizePixel = 2\n\tbutton.BorderColor3 = Color3.new(1, 1, 0) -- Yellow\nend\n\nlocal function onLeave()\n\tbutton.BorderSizePixel = 1\n\tbutton.BorderColor3 = Color3.new(0, 0, 0) -- Black\nend\n\n-- Connect events\nbutton.MouseEnter:Connect(onEnter)\nbutton.MouseLeave:Connect(onLeave)\n-- Our default state is \"not hovered\"\nonLeave()" }, "@roblox/globaltype/GuiObject.ClipsDescendants": { "documentation": "Determines if descendant GuiObjects outside of the bounds of a parent GUI element should render.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#ClipsDescendants", "code_sample": "" }, "@roblox/globaltype/GuiObject.Draggable": { "documentation": "Deprecated: This property is deprecated. Use UIDragDetector instead, as it supports more input types and can be better customized.
Determines whether a GuiObject (and its descendants) can be dragged around the screen.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Draggable", "code_sample": "" }, "@roblox/globaltype/GuiObject.GuiState": { "documentation": "Determines whether the player's mouse is being actively pressed on the GuiObject or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#GuiState", "code_sample": "" }, "@roblox/globaltype/GuiObject.Interactable": { "documentation": "Determines whether the GuiButton can be interacted with or not, or if the GuiState of the GuiObject is changing or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Interactable", "code_sample": "" }, "@roblox/globaltype/GuiObject.LayoutOrder": { "documentation": "Controls the sort order of the GuiObject when used with a UIGridStyleLayout.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#LayoutOrder", "code_sample": "" }, "@roblox/globaltype/GuiObject.NextSelectionDown": { "documentation": "Sets the GuiObject which will be selected when the gamepad selector is moved downward.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#NextSelectionDown", "code_sample": "" }, "@roblox/globaltype/GuiObject.NextSelectionLeft": { "documentation": "Sets the GuiObject which will be selected when the gamepad selector is moved to the left.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#NextSelectionLeft", "code_sample": "" }, "@roblox/globaltype/GuiObject.NextSelectionRight": { "documentation": "Sets the GuiObject which will be selected when the gamepad selector is moved to the right.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#NextSelectionRight", "code_sample": "" }, "@roblox/globaltype/GuiObject.NextSelectionUp": { "documentation": "Sets the GuiObject which will be selected when the gamepad selector is moved upward.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#NextSelectionUp", "code_sample": "" }, "@roblox/globaltype/GuiObject.Position": { "documentation": "Determines the pixel and scalar position of the GuiObject.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Position", "code_sample": "" }, "@roblox/globaltype/GuiObject.Rotation": { "documentation": "Determines the number of degrees by which the GuiObject is rotated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Rotation", "code_sample": "" }, "@roblox/globaltype/GuiObject.Selectable": { "documentation": "Determine whether the GuiObject can be selected by a gamepad.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Selectable", "code_sample": "local GuiService = game:GetService(\"GuiService\")\n\nlocal textBox = script.Parent\n\nlocal function gainFocus()\n\ttextBox.Selectable = true\n\tGuiService.SelectedObject = textBox\nend\n\nlocal function loseFocus(_enterPressed, _inputObject)\n\tGuiService.SelectedObject = nil\n\ttextBox.Selectable = false\nend\n\n-- The FocusLost and FocusGained event will fire because the textBox\n-- is of type TextBox\ntextBox.Focused:Connect(gainFocus)\ntextBox.FocusLost:Connect(loseFocus)" }, "@roblox/globaltype/GuiObject.SelectionImageObject": { "documentation": "Overrides the default selection adornment used for gamepads.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#SelectionImageObject", "code_sample": "" }, "@roblox/globaltype/GuiObject.SelectionOrder": { "documentation": "The order of GuiObjects selected by the gamepad UI selection.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#SelectionOrder", "code_sample": "" }, "@roblox/globaltype/GuiObject.Size": { "documentation": "Determines the pixel and scalar size of the GuiObject.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Size", "code_sample": "" }, "@roblox/globaltype/GuiObject.SizeConstraint": { "documentation": "Sets the Size axes that the GuiObject will be based on, relative to the size of its parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#SizeConstraint", "code_sample": "" }, "@roblox/globaltype/GuiObject.Transparency": { "documentation": "A mixed property of BackgroundTransparency and TextTransparency.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Transparency", "code_sample": "" }, "@roblox/globaltype/GuiObject.Visible": { "documentation": "Determines whether the GuiObject and its descendants will be rendered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#Visible", "code_sample": "local gui = script.Parent\nlocal window = gui:WaitForChild(\"Window\")\nlocal toggleButton = gui:WaitForChild(\"ToggleWindow\")\nlocal closeButton = window:WaitForChild(\"Close\")\n\nlocal function toggleWindowVisbility()\n\t-- Flip a boolean using the `not` keyword\n\twindow.Visible = not window.Visible\nend\n\ntoggleButton.Activated:Connect(toggleWindowVisbility)\ncloseButton.Activated:Connect(toggleWindowVisbility)" }, "@roblox/globaltype/GuiObject.ZIndex": { "documentation": "Determines the order in which a GuiObject renders relative to others.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#ZIndex", "code_sample": "" }, "@roblox/globaltype/GuiObject.TweenPosition/param/0": { "documentation": "An abstract class for all 2D user interface objects." }, "@roblox/globaltype/GuiObject.TweenPosition/param/1": { "documentation": "Where the GUI should move to." }, "@roblox/globaltype/GuiObject.TweenPosition/param/2": { "documentation": "The direction in which to ease the GUI to the endPosition." }, "@roblox/globaltype/GuiObject.TweenPosition/param/3": { "documentation": "The style in which to ease the GUI to the endPosition." }, "@roblox/globaltype/GuiObject.TweenPosition/param/4": { "documentation": "How long, in seconds, the tween should take to complete." }, "@roblox/globaltype/GuiObject.TweenPosition/param/5": { "documentation": "Whether the tween will override an in-progress tween." }, "@roblox/globaltype/GuiObject.TweenPosition/param/6": { "documentation": "A callback function to execute when the tween completes." }, "@roblox/globaltype/GuiObject.TweenPosition/return/0": { "documentation": "Whether the tween will play." }, "@roblox/globaltype/GuiObject.TweenPosition": { "documentation": "Smoothly moves a GUI to a new UDim2.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/0" }, { "name": "endPosition", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/1" }, { "name": "easingDirection", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/2" }, { "name": "easingStyle", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/3" }, { "name": "time", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/4" }, { "name": "override", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/5" }, { "name": "callback", "documentation": "@roblox/globaltype/GuiObject.TweenPosition/param/6" } ], "returns": [ "@roblox/globaltype/GuiObject.TweenPosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TweenPosition", "code_sample": "local START_POSITION = UDim2.new(0, 0, 0, 0)\nlocal GOAL_POSITION = UDim2.new(1, 0, 1, 0)\n\nlocal guiObject = script.Parent\n\nlocal function callback(state)\n\tif state == Enum.TweenStatus.Completed then\n\t\tprint(\"The tween completed uninterrupted\")\n\telseif state == Enum.TweenStatus.Canceled then\n\t\tprint(\"Another tween cancelled this one\")\n\tend\nend\n\n-- Initialize the GuiObject position, then start the tween:\nguiObject.Position = START_POSITION\n\nlocal willPlay = guiObject:TweenPosition(\n\tGOAL_POSITION, -- Final position the tween should reach\n\tEnum.EasingDirection.In, -- Direction of the easing\n\tEnum.EasingStyle.Sine, -- Kind of easing to apply\n\t2, -- Duration of the tween in seconds\n\ttrue, -- Whether in-progress tweens are interrupted\n\tcallback -- Function to be callled when on completion/cancelation\n)\n\nif willPlay then\n\tprint(\"The tween will play\")\nelse\n\tprint(\"The tween will not play\")\nend" }, "@roblox/globaltype/GuiObject.TweenSize/param/0": { "documentation": "An abstract class for all 2D user interface objects." }, "@roblox/globaltype/GuiObject.TweenSize/param/1": { "documentation": "The size that the GUI should resize." }, "@roblox/globaltype/GuiObject.TweenSize/param/2": { "documentation": "The direction in which to ease the GUI to the endSize." }, "@roblox/globaltype/GuiObject.TweenSize/param/3": { "documentation": "The style in which to ease the GUI to the endSize." }, "@roblox/globaltype/GuiObject.TweenSize/param/4": { "documentation": "How long, in seconds, the tween should take to complete." }, "@roblox/globaltype/GuiObject.TweenSize/param/5": { "documentation": "Whether the tween will override an in-progress tween." }, "@roblox/globaltype/GuiObject.TweenSize/param/6": { "documentation": "A callback function to execute when the tween completes." }, "@roblox/globaltype/GuiObject.TweenSize/return/0": { "documentation": "Whether the tween will play." }, "@roblox/globaltype/GuiObject.TweenSize": { "documentation": "Smoothly resizes a GuiObject to a new UDim2.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/0" }, { "name": "endSize", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/1" }, { "name": "easingDirection", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/2" }, { "name": "easingStyle", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/3" }, { "name": "time", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/4" }, { "name": "override", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/5" }, { "name": "callback", "documentation": "@roblox/globaltype/GuiObject.TweenSize/param/6" } ], "returns": [ "@roblox/globaltype/GuiObject.TweenSize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TweenSize", "code_sample": "local guiObject = script.Parent\n\nlocal function callback(didComplete)\n\tif didComplete then\n\t\tprint(\"The tween completed successfully\")\n\telse\n\t\tprint(\"The tween was cancelled\")\n\tend\nend\n\nlocal willTween = guiObject:TweenSize(\n\tUDim2.new(0.5, 0, 0.5, 0), -- endSize (required)\n\tEnum.EasingDirection.In, -- easingDirection (default Out)\n\tEnum.EasingStyle.Sine, -- easingStyle (default Quad)\n\t2, -- time (default: 1)\n\ttrue, -- should this tween override ones in-progress? (default: false)\n\tcallback -- a function to call when the tween completes (default: nil)\n)\n\nif willTween then\n\tprint(\"The GuiObject will tween\")\nelse\n\tprint(\"The GuiObject will not tween\")\nend" }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/0": { "documentation": "An abstract class for all 2D user interface objects." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/1": { "documentation": "The size that the GUI should resize." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/2": { "documentation": "Where the GUI should move to." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/3": { "documentation": "The direction in which to ease the GUI to the endSize and endPosition." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/4": { "documentation": "The style in which to ease the GUI to the endSize and endPosition." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/5": { "documentation": "How long, in seconds, the tween should take to complete." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/6": { "documentation": "Whether the tween will override an in-progress tween." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/7": { "documentation": "A callback function to execute when the tween completes." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition/return/0": { "documentation": "Whether the tween will play." }, "@roblox/globaltype/GuiObject.TweenSizeAndPosition": { "documentation": "Smoothly moves a GUI to a new size and position.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/0" }, { "name": "endSize", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/1" }, { "name": "endPosition", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/2" }, { "name": "easingDirection", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/3" }, { "name": "easingStyle", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/4" }, { "name": "time", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/5" }, { "name": "override", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/6" }, { "name": "callback", "documentation": "@roblox/globaltype/GuiObject.TweenSizeAndPosition/param/7" } ], "returns": [ "@roblox/globaltype/GuiObject.TweenSizeAndPosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TweenSizeAndPosition", "code_sample": "local frame = script.Parent.Frame\nframe:TweenSizeAndPosition(UDim2.new(0, 0, 0, 0), UDim2.new(0, 0, 0, 0))" }, "@roblox/globaltype/GuiObject.DragBegin.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragBegin.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.DragBegin.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragBegin.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.DragBegin.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragBegin.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragBegin.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.DragBegin.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragBegin.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.DragBegin.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragBegin.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragBegin.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.DragBegin.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragBegin.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.DragBegin.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragBegin.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragBegin.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragBegin.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragBegin": { "documentation": "Deprecated: This property is deprecated. Use UIDragDetector instead, as it supports more input types and can be better customized.
Fired when a player begins dragging the object.", "keys": { "Connect": "@roblox/globaltype/GuiObject.DragBegin.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.DragBegin.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.DragBegin.Once", "Wait": "@roblox/globaltype/GuiObject.DragBegin.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#DragBegin", "code_sample": "" }, "@roblox/globaltype/GuiObject.DragStopped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragStopped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.DragStopped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragStopped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.DragStopped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragStopped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragStopped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.DragStopped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragStopped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.DragStopped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragStopped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragStopped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.DragStopped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragStopped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.DragStopped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragStopped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.DragStopped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.DragStopped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.DragStopped": { "documentation": "Deprecated: This property is deprecated. Use UIDragDetector instead, as it supports more input types and can be better customized.
Fired when a player stops dragging the object.", "keys": { "Connect": "@roblox/globaltype/GuiObject.DragStopped.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.DragStopped.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.DragStopped.Once", "Wait": "@roblox/globaltype/GuiObject.DragStopped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#DragStopped", "code_sample": "script.Parent.DragStopped:Connect(function(x, Y)\n\tprint((\"The player stopped dragging the GuiObject at (%i, %i)\"):format(x, Y))\nend)" }, "@roblox/globaltype/GuiObject.InputBegan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputBegan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputBegan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputBegan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputBegan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputBegan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputBegan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputBegan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputBegan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputBegan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputBegan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputBegan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputBegan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputBegan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputBegan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputBegan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputBegan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputBegan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputBegan": { "documentation": "Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).", "keys": { "Connect": "@roblox/globaltype/GuiObject.InputBegan.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.InputBegan.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.InputBegan.Once", "Wait": "@roblox/globaltype/GuiObject.InputBegan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#InputBegan", "code_sample": "" }, "@roblox/globaltype/GuiObject.InputChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputChanged": { "documentation": "Fired when a user changes how they're interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).", "keys": { "Connect": "@roblox/globaltype/GuiObject.InputChanged.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.InputChanged.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.InputChanged.Once", "Wait": "@roblox/globaltype/GuiObject.InputChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#InputChanged", "code_sample": "" }, "@roblox/globaltype/GuiObject.InputEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.InputEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.InputEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.InputEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.InputEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.InputEnded": { "documentation": "Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc).", "keys": { "Connect": "@roblox/globaltype/GuiObject.InputEnded.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.InputEnded.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.InputEnded.Once", "Wait": "@roblox/globaltype/GuiObject.InputEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#InputEnded", "code_sample": "" }, "@roblox/globaltype/GuiObject.MouseEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseEnter": { "documentation": "Fires when a user moves their mouse into a GUI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.MouseEnter.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.MouseEnter.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.MouseEnter.Once", "Wait": "@roblox/globaltype/GuiObject.MouseEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#MouseEnter", "code_sample": "" }, "@roblox/globaltype/GuiObject.MouseLeave.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseLeave.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseLeave.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseLeave.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseLeave.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseLeave.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseLeave.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseLeave.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseLeave.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseLeave.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseLeave.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseLeave.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseLeave": { "documentation": "Fires when a user moves their mouse out of a GUI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.MouseLeave.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.MouseLeave.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.MouseLeave.Once", "Wait": "@roblox/globaltype/GuiObject.MouseLeave.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#MouseLeave", "code_sample": "" }, "@roblox/globaltype/GuiObject.MouseMoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseMoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseMoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseMoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseMoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseMoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseMoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseMoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseMoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseMoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseMoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseMoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseMoved": { "documentation": "Fires whenever a user moves their mouse while it is inside a GUI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.MouseMoved.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.MouseMoved.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.MouseMoved.Once", "Wait": "@roblox/globaltype/GuiObject.MouseMoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#MouseMoved", "code_sample": "" }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelBackward.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelBackward.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseWheelBackward.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelBackward.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelBackward.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelBackward": { "documentation": "Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.MouseWheelBackward.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.MouseWheelBackward.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.MouseWheelBackward.Once", "Wait": "@roblox/globaltype/GuiObject.MouseWheelBackward.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#MouseWheelBackward", "code_sample": "" }, "@roblox/globaltype/GuiObject.MouseWheelForward.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelForward.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseWheelForward.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelForward.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelForward.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseWheelForward.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelForward.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelForward.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.MouseWheelForward.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelForward.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.MouseWheelForward.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.MouseWheelForward.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.MouseWheelForward": { "documentation": "Fires when a user scrolls their mouse wheel forward when the mouse is over a GUI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.MouseWheelForward.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.MouseWheelForward.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.MouseWheelForward.Once", "Wait": "@roblox/globaltype/GuiObject.MouseWheelForward.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#MouseWheelForward", "code_sample": "" }, "@roblox/globaltype/GuiObject.SelectionGained.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionGained.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.SelectionGained.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionGained.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionGained.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.SelectionGained.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionGained.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionGained.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.SelectionGained.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionGained.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionGained.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionGained.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionGained": { "documentation": "Fired when the GuiObject is being focused on with the Gamepad selector.", "keys": { "Connect": "@roblox/globaltype/GuiObject.SelectionGained.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.SelectionGained.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.SelectionGained.Once", "Wait": "@roblox/globaltype/GuiObject.SelectionGained.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#SelectionGained", "code_sample": "local guiObject = script.Parent\n\nlocal function selectionGained()\n\tprint(\"The user has selected this button with a gamepad.\")\nend\n\nguiObject.SelectionGained:Connect(selectionGained)" }, "@roblox/globaltype/GuiObject.SelectionLost.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionLost.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.SelectionLost.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionLost.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionLost.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.SelectionLost.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionLost.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionLost.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.SelectionLost.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionLost.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.SelectionLost.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.SelectionLost.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.SelectionLost": { "documentation": "Fired when the Gamepad selector stops focusing on the GuiObject.", "keys": { "Connect": "@roblox/globaltype/GuiObject.SelectionLost.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.SelectionLost.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.SelectionLost.Once", "Wait": "@roblox/globaltype/GuiObject.SelectionLost.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#SelectionLost", "code_sample": "local guiObject = script.Parent\n\nlocal function selectionLost()\n\tprint(\"The user no longer has this selected with their gamepad.\")\nend\n\nguiObject.SelectionLost:Connect(selectionLost)" }, "@roblox/globaltype/GuiObject.TouchLongPress.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchLongPress.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchLongPress.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchLongPress.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchLongPress.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchLongPress.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchLongPress.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchLongPress.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchLongPress.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchLongPress.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchLongPress.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchLongPress.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchLongPress": { "documentation": "Fires when the player starts, continues and stops long-pressing the UI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.TouchLongPress.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.TouchLongPress.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.TouchLongPress.Once", "Wait": "@roblox/globaltype/GuiObject.TouchLongPress.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TouchLongPress", "code_sample": "" }, "@roblox/globaltype/GuiObject.TouchPan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchPan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchPan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchPan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchPan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchPan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchPan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPan": { "documentation": "Fires when the player moves their finger on the UI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.TouchPan.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.TouchPan.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.TouchPan.Once", "Wait": "@roblox/globaltype/GuiObject.TouchPan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TouchPan", "code_sample": "" }, "@roblox/globaltype/GuiObject.TouchPinch.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPinch.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchPinch.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPinch.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPinch.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchPinch.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPinch.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPinch.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchPinch.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPinch.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchPinch.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchPinch.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchPinch": { "documentation": "Fires when the player performs a pinch or pull gesture using two fingers on the UI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.TouchPinch.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.TouchPinch.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.TouchPinch.Once", "Wait": "@roblox/globaltype/GuiObject.TouchPinch.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TouchPinch", "code_sample": "local innerFrame = script.Parent\nlocal outerFrame = innerFrame.Parent\nouterFrame.BackgroundTransparency = 0.75\nouterFrame.Active = true\nouterFrame.Size = UDim2.new(1, 0, 1, 0)\nouterFrame.Position = UDim2.new(0, 0, 0, 0)\nouterFrame.AnchorPoint = Vector2.new(0, 0)\nouterFrame.ClipsDescendants = true\n\nlocal dragging = false\nlocal uiScale = Instance.new(\"UIScale\")\nuiScale.Parent = innerFrame\nlocal baseScale\n\nlocal function onTouchPinch(_touchPositions, scale, _velocity, state)\n\tif state == Enum.UserInputState.Begin and not dragging then\n\t\tdragging = true\n\t\tbaseScale = uiScale.Scale\n\t\touterFrame.BackgroundTransparency = 0.25\n\telseif state == Enum.UserInputState.Change then\n\t\tuiScale.Scale = baseScale * scale -- Notice the multiplication here\n\telseif state == Enum.UserInputState.End and dragging then\n\t\tdragging = false\n\t\touterFrame.BackgroundTransparency = 0.75\n\tend\nend\n\nouterFrame.TouchPinch:Connect(onTouchPinch)" }, "@roblox/globaltype/GuiObject.TouchRotate.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchRotate.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchRotate.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchRotate.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchRotate.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchRotate.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchRotate.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchRotate.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchRotate.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchRotate.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchRotate.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchRotate.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchRotate": { "documentation": "Fires when the player performs a rotation gesture using two fingers on the UI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.TouchRotate.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.TouchRotate.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.TouchRotate.Once", "Wait": "@roblox/globaltype/GuiObject.TouchRotate.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TouchRotate", "code_sample": "local innerFrame = script.Parent\nlocal outerFrame = innerFrame.Parent\nouterFrame.BackgroundTransparency = 0.75\nouterFrame.Active = true\nouterFrame.Size = UDim2.new(1, 0, 1, 0)\nouterFrame.Position = UDim2.new(0, 0, 0, 0)\nouterFrame.AnchorPoint = Vector2.new(0, 0)\nouterFrame.ClipsDescendants = true\n\nlocal dragging = false\nlocal baseRotation = innerFrame.Rotation\n\nlocal function onTouchRotate(_touchPositions, rotation, _velocity, state)\n\tif state == Enum.UserInputState.Begin and not dragging then\n\t\tdragging = true\n\t\tbaseRotation = innerFrame.Rotation\n\t\touterFrame.BackgroundTransparency = 0.25\n\telseif state == Enum.UserInputState.Change then\n\t\tinnerFrame.Rotation = baseRotation + rotation\n\telseif state == Enum.UserInputState.End and dragging then\n\t\tdragging = false\n\t\touterFrame.BackgroundTransparency = 0.75\n\tend\nend\n\nouterFrame.TouchRotate:Connect(onTouchRotate)" }, "@roblox/globaltype/GuiObject.TouchSwipe.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchSwipe.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchSwipe.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchSwipe.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchSwipe.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchSwipe.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchSwipe.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchSwipe.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchSwipe.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchSwipe.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchSwipe.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchSwipe.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchSwipe": { "documentation": "Fires when the player performs a swipe gesture on the UI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.TouchSwipe.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.TouchSwipe.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.TouchSwipe.Once", "Wait": "@roblox/globaltype/GuiObject.TouchSwipe.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TouchSwipe", "code_sample": "" }, "@roblox/globaltype/GuiObject.TouchTap.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchTap.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchTap.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchTap.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchTap.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchTap.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchTap.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchTap.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchTap.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchTap.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchTap.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchTap.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiObject.TouchTap.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchTap.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiObject.TouchTap.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchTap.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiObject.TouchTap.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiObject.TouchTap.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiObject.TouchTap": { "documentation": "Fires when the player performs a tap gesture on the UI element.", "keys": { "Connect": "@roblox/globaltype/GuiObject.TouchTap.Connect", "ConnectParallel": "@roblox/globaltype/GuiObject.TouchTap.ConnectParallel", "Once": "@roblox/globaltype/GuiObject.TouchTap.Once", "Wait": "@roblox/globaltype/GuiObject.TouchTap.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiObject#TouchTap", "code_sample": "local frame = script.Parent\nframe.Active = true\n\nlocal function onTouchTap()\n\t-- Toggle background transparency\n\tif frame.BackgroundTransparency > 0 then\n\t\tframe.BackgroundTransparency = 0\n\telse\n\t\tframe.BackgroundTransparency = 0.75\n\tend\nend\n\nframe.TouchTap:Connect(onTouchTap)" }, "@roblox/globaltype/CylindricalConstraint": { "documentation": "Constrains two attachments on two parts to have a relative linear and rotational motion.", "keys": { "AngularActuatorType": "@roblox/globaltype/CylindricalConstraint.AngularActuatorType", "AngularLimitsEnabled": "@roblox/globaltype/CylindricalConstraint.AngularLimitsEnabled", "AngularResponsiveness": "@roblox/globaltype/CylindricalConstraint.AngularResponsiveness", "AngularRestitution": "@roblox/globaltype/CylindricalConstraint.AngularRestitution", "AngularSpeed": "@roblox/globaltype/CylindricalConstraint.AngularSpeed", "AngularVelocity": "@roblox/globaltype/CylindricalConstraint.AngularVelocity", "CurrentAngle": "@roblox/globaltype/CylindricalConstraint.CurrentAngle", "InclinationAngle": "@roblox/globaltype/CylindricalConstraint.InclinationAngle", "LowerAngle": "@roblox/globaltype/CylindricalConstraint.LowerAngle", "MotorMaxAngularAcceleration": "@roblox/globaltype/CylindricalConstraint.MotorMaxAngularAcceleration", "MotorMaxTorque": "@roblox/globaltype/CylindricalConstraint.MotorMaxTorque", "RotationAxisVisible": "@roblox/globaltype/CylindricalConstraint.RotationAxisVisible", "ServoMaxTorque": "@roblox/globaltype/CylindricalConstraint.ServoMaxTorque", "SoftlockAngularServoUponReachingTarget": "@roblox/globaltype/CylindricalConstraint.SoftlockAngularServoUponReachingTarget", "TargetAngle": "@roblox/globaltype/CylindricalConstraint.TargetAngle", "UpperAngle": "@roblox/globaltype/CylindricalConstraint.UpperAngle", "WorldRotationAxis": "@roblox/globaltype/CylindricalConstraint.WorldRotationAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.AngularActuatorType": { "documentation": "Type of angular actuator.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#AngularActuatorType", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.AngularLimitsEnabled": { "documentation": "Enables the angular limits around the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#AngularLimitsEnabled", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.AngularResponsiveness": { "documentation": "Specifies the sharpness of the angular servo motor in reaching the TargetAngle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#AngularResponsiveness", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.AngularRestitution": { "documentation": "Restitution of the two limits, or how elastic they are.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#AngularRestitution", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.AngularSpeed": { "documentation": "Target angular speed. This value is unsigned as the servo will always move toward its target. In radians per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#AngularSpeed", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.AngularVelocity": { "documentation": "The target angular velocity of the motor in radians per second around the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#AngularVelocity", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.CurrentAngle": { "documentation": "Signed angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#CurrentAngle", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.InclinationAngle": { "documentation": "Direction of the rotation axis as an angle from the X axis in the XY plane of Attachment0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#InclinationAngle", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.LowerAngle": { "documentation": "Lower limit for the angle (in degrees) between the reference axis and the SecondaryAxis of Attachment1 around the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#LowerAngle", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.MotorMaxAngularAcceleration": { "documentation": "The maximum angular acceleration of the motor in radians per second squared.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#MotorMaxAngularAcceleration", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.MotorMaxTorque": { "documentation": "The maximum torque the motor can apply to achieve the target angular velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#MotorMaxTorque", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.RotationAxisVisible": { "documentation": "Enable the visibility of the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#RotationAxisVisible", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.ServoMaxTorque": { "documentation": "Maximum torque the servo motor can apply.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#ServoMaxTorque", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.SoftlockAngularServoUponReachingTarget": { "documentation": "Deprecated: This property should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#SoftlockAngularServoUponReachingTarget", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.TargetAngle": { "documentation": "Target angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#TargetAngle", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.UpperAngle": { "documentation": "Upper limit for the angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#UpperAngle", "code_sample": "" }, "@roblox/globaltype/CylindricalConstraint.WorldRotationAxis": { "documentation": "The unit vector direction of the rotation axis in world coordinates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CylindricalConstraint#WorldRotationAxis", "code_sample": "" }, "@roblox/globaltype/GuiBase2d": { "documentation": "An abstract class inherited by 2D GuiObjects.", "keys": { "AbsolutePosition": "@roblox/globaltype/GuiBase2d.AbsolutePosition", "AbsoluteRotation": "@roblox/globaltype/GuiBase2d.AbsoluteRotation", "AbsoluteSize": "@roblox/globaltype/GuiBase2d.AbsoluteSize", "AutoLocalize": "@roblox/globaltype/GuiBase2d.AutoLocalize", "Localize": "@roblox/globaltype/GuiBase2d.Localize", "RootLocalizationTable": "@roblox/globaltype/GuiBase2d.RootLocalizationTable", "SelectionBehaviorDown": "@roblox/globaltype/GuiBase2d.SelectionBehaviorDown", "SelectionBehaviorLeft": "@roblox/globaltype/GuiBase2d.SelectionBehaviorLeft", "SelectionBehaviorRight": "@roblox/globaltype/GuiBase2d.SelectionBehaviorRight", "SelectionBehaviorUp": "@roblox/globaltype/GuiBase2d.SelectionBehaviorUp", "SelectionGroup": "@roblox/globaltype/GuiBase2d.SelectionGroup" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.AbsolutePosition": { "documentation": "Describes the actual screen position of a GuiBase2d element, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#AbsolutePosition", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.AbsoluteRotation": { "documentation": "Describes the actual screen rotation of a GuiBase2d element, in degrees.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#AbsoluteRotation", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.AbsoluteSize": { "documentation": "Describes the actual screen size of a GuiBase2d element, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#AbsoluteSize", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.AutoLocalize": { "documentation": "When set to true, localization will be applied to this GuiBase2d and its descendants.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#AutoLocalize", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.Localize": { "documentation": "Deprecated: This item is deprecated. Do not use it for new work.
Automatically set to true when a localization table's LocalizationTable.Root targets this object, or an ancestor of this object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#Localize", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.RootLocalizationTable": { "documentation": "A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#RootLocalizationTable", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.SelectionBehaviorDown": { "documentation": "Customizes gamepad selection behavior in the down direction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#SelectionBehaviorDown", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.SelectionBehaviorLeft": { "documentation": "Customizes gamepad selection behavior in the left direction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#SelectionBehaviorLeft", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.SelectionBehaviorRight": { "documentation": "Customizes gamepad selection behavior in the right direction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#SelectionBehaviorRight", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.SelectionBehaviorUp": { "documentation": "Customizes gamepad selection behavior in the up direction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#SelectionBehaviorUp", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.SelectionGroup": { "documentation": "Allows customization of gamepad selection movement.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#SelectionGroup", "code_sample": "" }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiBase2d.SelectionChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiBase2d.SelectionChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiBase2d.SelectionChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiBase2d.SelectionChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiBase2d.SelectionChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiBase2d.SelectionChanged": { "documentation": "Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendant GuiObjects.", "keys": { "Connect": "@roblox/globaltype/GuiBase2d.SelectionChanged.Connect", "ConnectParallel": "@roblox/globaltype/GuiBase2d.SelectionChanged.ConnectParallel", "Once": "@roblox/globaltype/GuiBase2d.SelectionChanged.Once", "Wait": "@roblox/globaltype/GuiBase2d.SelectionChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase2d#SelectionChanged", "code_sample": "" }, "@roblox/globaltype/IntersectOperation": { "documentation": "Result of parts that have been intersected into a single solid model.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IntersectOperation", "code_sample": "" }, "@roblox/globaltype/ProcessInstancePhysicsService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ProcessInstancePhysicsService", "code_sample": "" }, "@roblox/globaltype/EditableMesh": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes.", "keys": { "FixedSize": "@roblox/globaltype/EditableMesh.FixedSize", "SkinningEnabled": "@roblox/globaltype/EditableMesh.SkinningEnabled", "AddBone": "@roblox/globaltype/EditableMesh.AddBone", "AddColor": "@roblox/globaltype/EditableMesh.AddColor", "AddNormal": "@roblox/globaltype/EditableMesh.AddNormal", "AddTriangle": "@roblox/globaltype/EditableMesh.AddTriangle", "AddUV": "@roblox/globaltype/EditableMesh.AddUV", "AddVertex": "@roblox/globaltype/EditableMesh.AddVertex", "Destroy": "@roblox/globaltype/EditableMesh.Destroy", "FindClosestPointOnSurface": "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface", "FindClosestVertex": "@roblox/globaltype/EditableMesh.FindClosestVertex", "FindVerticesWithinSphere": "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere", "GetAdjacentFaces": "@roblox/globaltype/EditableMesh.GetAdjacentFaces", "GetAdjacentVertices": "@roblox/globaltype/EditableMesh.GetAdjacentVertices", "GetBoneByName": "@roblox/globaltype/EditableMesh.GetBoneByName", "GetBoneCFrame": "@roblox/globaltype/EditableMesh.GetBoneCFrame", "GetBoneIsVirtual": "@roblox/globaltype/EditableMesh.GetBoneIsVirtual", "GetBoneName": "@roblox/globaltype/EditableMesh.GetBoneName", "GetBoneParent": "@roblox/globaltype/EditableMesh.GetBoneParent", "GetBones": "@roblox/globaltype/EditableMesh.GetBones", "GetCenter": "@roblox/globaltype/EditableMesh.GetCenter", "GetColor": "@roblox/globaltype/EditableMesh.GetColor", "GetColorAlpha": "@roblox/globaltype/EditableMesh.GetColorAlpha", "GetColors": "@roblox/globaltype/EditableMesh.GetColors", "GetFaceColors": "@roblox/globaltype/EditableMesh.GetFaceColors", "GetFaceNormals": "@roblox/globaltype/EditableMesh.GetFaceNormals", "GetFaces": "@roblox/globaltype/EditableMesh.GetFaces", "GetFacesWithAttribute": "@roblox/globaltype/EditableMesh.GetFacesWithAttribute", "GetFacesWithColor": "@roblox/globaltype/EditableMesh.GetFacesWithColor", "GetFacesWithNormal": "@roblox/globaltype/EditableMesh.GetFacesWithNormal", "GetFacesWithUV": "@roblox/globaltype/EditableMesh.GetFacesWithUV", "GetFaceUVs": "@roblox/globaltype/EditableMesh.GetFaceUVs", "GetFaceVertices": "@roblox/globaltype/EditableMesh.GetFaceVertices", "GetFacsCorrectivePose": "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose", "GetFacsCorrectivePoses": "@roblox/globaltype/EditableMesh.GetFacsCorrectivePoses", "GetFacsPose": "@roblox/globaltype/EditableMesh.GetFacsPose", "GetFacsPoses": "@roblox/globaltype/EditableMesh.GetFacsPoses", "GetNormal": "@roblox/globaltype/EditableMesh.GetNormal", "GetNormals": "@roblox/globaltype/EditableMesh.GetNormals", "GetPosition": "@roblox/globaltype/EditableMesh.GetPosition", "GetSize": "@roblox/globaltype/EditableMesh.GetSize", "GetUV": "@roblox/globaltype/EditableMesh.GetUV", "GetUVs": "@roblox/globaltype/EditableMesh.GetUVs", "GetVertexBones": "@roblox/globaltype/EditableMesh.GetVertexBones", "GetVertexBoneWeights": "@roblox/globaltype/EditableMesh.GetVertexBoneWeights", "GetVertexColors": "@roblox/globaltype/EditableMesh.GetVertexColors", "GetVertexFaceColor": "@roblox/globaltype/EditableMesh.GetVertexFaceColor", "GetVertexFaceNormal": "@roblox/globaltype/EditableMesh.GetVertexFaceNormal", "GetVertexFaces": "@roblox/globaltype/EditableMesh.GetVertexFaces", "GetVertexFaceUV": "@roblox/globaltype/EditableMesh.GetVertexFaceUV", "GetVertexNormals": "@roblox/globaltype/EditableMesh.GetVertexNormals", "GetVertexUVs": "@roblox/globaltype/EditableMesh.GetVertexUVs", "GetVertices": "@roblox/globaltype/EditableMesh.GetVertices", "GetVerticesWithAttribute": "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute", "GetVerticesWithColor": "@roblox/globaltype/EditableMesh.GetVerticesWithColor", "GetVerticesWithNormal": "@roblox/globaltype/EditableMesh.GetVerticesWithNormal", "GetVerticesWithUV": "@roblox/globaltype/EditableMesh.GetVerticesWithUV", "IdDebugString": "@roblox/globaltype/EditableMesh.IdDebugString", "MergeVertices": "@roblox/globaltype/EditableMesh.MergeVertices", "RaycastLocal": "@roblox/globaltype/EditableMesh.RaycastLocal", "RemoveBone": "@roblox/globaltype/EditableMesh.RemoveBone", "RemoveFace": "@roblox/globaltype/EditableMesh.RemoveFace", "RemoveUnused": "@roblox/globaltype/EditableMesh.RemoveUnused", "ResetNormal": "@roblox/globaltype/EditableMesh.ResetNormal", "SetBoneCFrame": "@roblox/globaltype/EditableMesh.SetBoneCFrame", "SetBoneIsVirtual": "@roblox/globaltype/EditableMesh.SetBoneIsVirtual", "SetBoneName": "@roblox/globaltype/EditableMesh.SetBoneName", "SetBoneParent": "@roblox/globaltype/EditableMesh.SetBoneParent", "SetColor": "@roblox/globaltype/EditableMesh.SetColor", "SetColorAlpha": "@roblox/globaltype/EditableMesh.SetColorAlpha", "SetFaceColors": "@roblox/globaltype/EditableMesh.SetFaceColors", "SetFaceNormals": "@roblox/globaltype/EditableMesh.SetFaceNormals", "SetFaceUVs": "@roblox/globaltype/EditableMesh.SetFaceUVs", "SetFaceVertices": "@roblox/globaltype/EditableMesh.SetFaceVertices", "SetFacsBonePose": "@roblox/globaltype/EditableMesh.SetFacsBonePose", "SetFacsCorrectivePose": "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose", "SetFacsPose": "@roblox/globaltype/EditableMesh.SetFacsPose", "SetNormal": "@roblox/globaltype/EditableMesh.SetNormal", "SetPosition": "@roblox/globaltype/EditableMesh.SetPosition", "SetUV": "@roblox/globaltype/EditableMesh.SetUV", "SetVertexBones": "@roblox/globaltype/EditableMesh.SetVertexBones", "SetVertexBoneWeights": "@roblox/globaltype/EditableMesh.SetVertexBoneWeights", "SetVertexFaceColor": "@roblox/globaltype/EditableMesh.SetVertexFaceColor", "SetVertexFaceNormal": "@roblox/globaltype/EditableMesh.SetVertexFaceNormal", "SetVertexFaceUV": "@roblox/globaltype/EditableMesh.SetVertexFaceUV", "Triangulate": "@roblox/globaltype/EditableMesh.Triangulate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh", "code_sample": "" }, "@roblox/globaltype/EditableMesh.FixedSize": { "documentation": "Returns true if a mesh is fixed-size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FixedSize", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SkinningEnabled": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SkinningEnabled", "code_sample": "" }, "@roblox/globaltype/EditableMesh.AddBone/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.AddBone/param/1": { "documentation": "Options table containing bone parameters: " }, "@roblox/globaltype/EditableMesh.AddBone/return/0": { "documentation": "Stable bone ID of the new bone." }, "@roblox/globaltype/EditableMesh.AddBone": { "documentation": "Adds a new bone and returns a stable bone ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.AddBone/param/0" }, { "name": "boneProperties", "documentation": "@roblox/globaltype/EditableMesh.AddBone/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.AddBone/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddBone", "code_sample": "" }, "@roblox/globaltype/EditableMesh.AddColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.AddColor/param/1": { "documentation": "The new color." }, "@roblox/globaltype/EditableMesh.AddColor/param/2": { "documentation": "The color alpha (transparency)." }, "@roblox/globaltype/EditableMesh.AddColor/return/0": { "documentation": "Stable color ID of the new color." }, "@roblox/globaltype/EditableMesh.AddColor": { "documentation": "Adds a new color to the geometry and returns a stable color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.AddColor/param/0" }, { "name": "color", "documentation": "@roblox/globaltype/EditableMesh.AddColor/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/EditableMesh.AddColor/param/2" } ], "returns": [ "@roblox/globaltype/EditableMesh.AddColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.AddNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.AddNormal/param/1": { "documentation": "The normal vector. If the normal value isn't specified, the normal will be automatically calculated." }, "@roblox/globaltype/EditableMesh.AddNormal/return/0": { "documentation": "Stable normal ID of the new normal." }, "@roblox/globaltype/EditableMesh.AddNormal": { "documentation": "Adds a new normal to the geometry and returns a stable normal ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.AddNormal/param/0" }, { "name": "normal", "documentation": "@roblox/globaltype/EditableMesh.AddNormal/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.AddNormal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.AddTriangle/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.AddTriangle/param/1": { "documentation": "ID of the first vertex of the triangle." }, "@roblox/globaltype/EditableMesh.AddTriangle/param/2": { "documentation": "ID of the second vertex of the triangle." }, "@roblox/globaltype/EditableMesh.AddTriangle/param/3": { "documentation": "ID of the third vertex of the triangle." }, "@roblox/globaltype/EditableMesh.AddTriangle/return/0": { "documentation": "Stable face ID of the new face." }, "@roblox/globaltype/EditableMesh.AddTriangle": { "documentation": "Adds a new triangle to the mesh and returns a stable face ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.AddTriangle/param/0" }, { "name": "vertexId0", "documentation": "@roblox/globaltype/EditableMesh.AddTriangle/param/1" }, { "name": "vertexId1", "documentation": "@roblox/globaltype/EditableMesh.AddTriangle/param/2" }, { "name": "vertexId2", "documentation": "@roblox/globaltype/EditableMesh.AddTriangle/param/3" } ], "returns": [ "@roblox/globaltype/EditableMesh.AddTriangle/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddTriangle", "code_sample": "" }, "@roblox/globaltype/EditableMesh.AddUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.AddUV/param/1": { "documentation": "The new UV coordinate." }, "@roblox/globaltype/EditableMesh.AddUV/return/0": { "documentation": "Stable UV ID of the new UV." }, "@roblox/globaltype/EditableMesh.AddUV": { "documentation": "Adds a new UV to the geometry and returns a stable UV ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.AddUV/param/0" }, { "name": "uv", "documentation": "@roblox/globaltype/EditableMesh.AddUV/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.AddUV/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.AddVertex/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.AddVertex/param/1": { "documentation": "Position in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.AddVertex/return/0": { "documentation": "Stable vertex ID of the new vertex." }, "@roblox/globaltype/EditableMesh.AddVertex": { "documentation": "Adds a new vertex to the geometry and returns a stable vertex ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.AddVertex/param/0" }, { "name": "p", "documentation": "@roblox/globaltype/EditableMesh.AddVertex/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.AddVertex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#AddVertex", "code_sample": "" }, "@roblox/globaltype/EditableMesh.Destroy/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.Destroy": { "documentation": "Destroys the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.Destroy/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Destroy", "code_sample": "" }, "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface/param/1": { "documentation": "Point position in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface/return/0": { "documentation": "Tuple of the face ID, point on the mesh in local object space, and the barycentric coordinate of the position within the face." }, "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface": { "documentation": "Finds the closest point on the mesh's surface.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface/param/0" }, { "name": "point", "documentation": "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.FindClosestPointOnSurface/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestPointOnSurface", "code_sample": "" }, "@roblox/globaltype/EditableMesh.FindClosestVertex/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.FindClosestVertex/param/1": { "documentation": "Point position in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.FindClosestVertex/return/0": { "documentation": "Closest stable vertex ID to the specified point in space." }, "@roblox/globaltype/EditableMesh.FindClosestVertex": { "documentation": "Finds the closest vertex to a specific point in space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.FindClosestVertex/param/0" }, { "name": "toThisPoint", "documentation": "@roblox/globaltype/EditableMesh.FindClosestVertex/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.FindClosestVertex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindClosestVertex", "code_sample": "" }, "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/param/1": { "documentation": "Center of the sphere in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/param/2": { "documentation": "Radius of the sphere." }, "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/return/0": { "documentation": "List of stable vertex IDs within the requested sphere." }, "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere": { "documentation": "Finds all vertices within a specific sphere.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/param/0" }, { "name": "center", "documentation": "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/param/1" }, { "name": "radius", "documentation": "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/param/2" } ], "returns": [ "@roblox/globaltype/EditableMesh.FindVerticesWithinSphere/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#FindVerticesWithinSphere", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetAdjacentFaces/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetAdjacentFaces/param/1": { "documentation": "" }, "@roblox/globaltype/EditableMesh.GetAdjacentFaces/return/0": { "documentation": "List of face IDs adjacent to the given face." }, "@roblox/globaltype/EditableMesh.GetAdjacentFaces": { "documentation": "Returns a list of faces adjacent to a given face.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetAdjacentFaces/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetAdjacentFaces/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetAdjacentFaces/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentFaces", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetAdjacentVertices/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetAdjacentVertices/param/1": { "documentation": "Vertex ID around which to get adjacent vertices." }, "@roblox/globaltype/EditableMesh.GetAdjacentVertices/return/0": { "documentation": "List of IDs of adjacent vertices around the given vertex ID." }, "@roblox/globaltype/EditableMesh.GetAdjacentVertices": { "documentation": "Returns a list of vertices adjacent to a given vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetAdjacentVertices/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetAdjacentVertices/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetAdjacentVertices/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetAdjacentVertices", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetBoneByName/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetBoneByName/param/1": { "documentation": "Bone name to search for." }, "@roblox/globaltype/EditableMesh.GetBoneByName/return/0": { "documentation": "Bone ID of the bone with the given name." }, "@roblox/globaltype/EditableMesh.GetBoneByName": { "documentation": "Finds the bone ID of the bone with the given name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetBoneByName/param/0" }, { "name": "boneName", "documentation": "@roblox/globaltype/EditableMesh.GetBoneByName/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetBoneByName/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneByName", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetBoneCFrame/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetBoneCFrame/param/1": { "documentation": "Bone ID for which to get the CFrame." }, "@roblox/globaltype/EditableMesh.GetBoneCFrame/return/0": { "documentation": "Initial CFrame of the bone in the bind pose of the mesh, in the mesh's local space." }, "@roblox/globaltype/EditableMesh.GetBoneCFrame": { "documentation": "Returns the initial CFrame of the bone in the bind pose of the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetBoneCFrame/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.GetBoneCFrame/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetBoneCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneCFrame", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetBoneIsVirtual/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetBoneIsVirtual/param/1": { "documentation": "Bone ID for which to get whether the bone is virtual." }, "@roblox/globaltype/EditableMesh.GetBoneIsVirtual/return/0": { "documentation": "Whether the bone with the given bone ID is virtual. Virtual bones can only be bound to a FaceControls instance." }, "@roblox/globaltype/EditableMesh.GetBoneIsVirtual": { "documentation": "Returns true if the bone is virtual.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetBoneIsVirtual/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.GetBoneIsVirtual/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetBoneIsVirtual/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneIsVirtual", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetBoneName/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetBoneName/param/1": { "documentation": "Bone ID for which to get the name." }, "@roblox/globaltype/EditableMesh.GetBoneName/return/0": { "documentation": "Name of the bone with the given bone ID." }, "@roblox/globaltype/EditableMesh.GetBoneName": { "documentation": "Returns the bone name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetBoneName/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.GetBoneName/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetBoneName/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneName", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetBoneParent/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetBoneParent/param/1": { "documentation": "Bone ID for which to get the parent." }, "@roblox/globaltype/EditableMesh.GetBoneParent/return/0": { "documentation": "Bone ID for the parent of the bone with the given bone ID. If there is no parent, returns 0." }, "@roblox/globaltype/EditableMesh.GetBoneParent": { "documentation": "Returns the parent bone ID, if any.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetBoneParent/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.GetBoneParent/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetBoneParent/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBoneParent", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetBones/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetBones/return/0": { "documentation": "List of stable bone IDs." }, "@roblox/globaltype/EditableMesh.GetBones": { "documentation": "Returns all bones of the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetBones/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetBones/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetBones", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetCenter/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetCenter/return/0": { "documentation": "Center of the bounding box of the EditableMesh." }, "@roblox/globaltype/EditableMesh.GetCenter": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetCenter/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetCenter/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetCenter", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetColor/param/1": { "documentation": "Color ID for which to get the color." }, "@roblox/globaltype/EditableMesh.GetColor/return/0": { "documentation": "Color for the requested stable color ID." }, "@roblox/globaltype/EditableMesh.GetColor": { "documentation": "Returns the color for the given color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetColor/param/0" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.GetColor/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetColorAlpha/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetColorAlpha/param/1": { "documentation": "Color ID for which to get the alpha." }, "@roblox/globaltype/EditableMesh.GetColorAlpha/return/0": { "documentation": "Color alpha at the request stable color ID." }, "@roblox/globaltype/EditableMesh.GetColorAlpha": { "documentation": "Returns the color alpha (transparency) at the given color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetColorAlpha/param/0" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.GetColorAlpha/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetColorAlpha/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColorAlpha", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetColors/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetColors/return/0": { "documentation": "List of stable color IDs." }, "@roblox/globaltype/EditableMesh.GetColors": { "documentation": "Returns all colors of the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetColors/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetColors/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetColors", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFaceColors/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFaceColors/param/1": { "documentation": "Face ID for which to get the color IDs." }, "@roblox/globaltype/EditableMesh.GetFaceColors/return/0": { "documentation": "List of color IDs used for the vertices on the given face." }, "@roblox/globaltype/EditableMesh.GetFaceColors": { "documentation": "Returns the face's color IDs for the vertices on the face.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFaceColors/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetFaceColors/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFaceColors/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceColors", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFaceNormals/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFaceNormals/param/1": { "documentation": "Face ID for which to get the normal IDs." }, "@roblox/globaltype/EditableMesh.GetFaceNormals/return/0": { "documentation": "List of normal IDs used for the vertices on the given face." }, "@roblox/globaltype/EditableMesh.GetFaceNormals": { "documentation": "Returns the face's normal IDs for the vertices on the face.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFaceNormals/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetFaceNormals/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFaceNormals/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceNormals", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFaces/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFaces/return/0": { "documentation": "List of stable face IDs." }, "@roblox/globaltype/EditableMesh.GetFaces": { "documentation": "Returns all faces of the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFaces/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFaces/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaces", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacesWithAttribute/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacesWithAttribute/param/1": { "documentation": "Attribute ID for which to find faces that use it." }, "@roblox/globaltype/EditableMesh.GetFacesWithAttribute/return/0": { "documentation": "List of face IDs which use the given attribute ID." }, "@roblox/globaltype/EditableMesh.GetFacesWithAttribute": { "documentation": "Deprecated:
Returns a list of faces that use a given attribute ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithAttribute/param/0" }, { "name": "id", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithAttribute/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacesWithAttribute/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithAttribute", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacesWithColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacesWithColor/param/1": { "documentation": "Color ID to find faces for." }, "@roblox/globaltype/EditableMesh.GetFacesWithColor/return/0": { "documentation": "List of face IDs that use the provided color ID." }, "@roblox/globaltype/EditableMesh.GetFacesWithColor": { "documentation": "Returns an array of face IDs that use the given color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithColor/param/0" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithColor/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacesWithColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacesWithNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacesWithNormal/param/1": { "documentation": "Normal ID to find faces for." }, "@roblox/globaltype/EditableMesh.GetFacesWithNormal/return/0": { "documentation": "List of face IDs that use the provided normal ID." }, "@roblox/globaltype/EditableMesh.GetFacesWithNormal": { "documentation": "Returns an array of face IDs that use the given normal ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithNormal/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithNormal/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacesWithNormal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacesWithUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacesWithUV/param/1": { "documentation": "UV ID to find faces for." }, "@roblox/globaltype/EditableMesh.GetFacesWithUV/return/0": { "documentation": "List of face IDs that use the provided UV ID." }, "@roblox/globaltype/EditableMesh.GetFacesWithUV": { "documentation": "Returns an array of face IDs that use the given UV ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithUV/param/0" }, { "name": "uvId", "documentation": "@roblox/globaltype/EditableMesh.GetFacesWithUV/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacesWithUV/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacesWithUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFaceUVs/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFaceUVs/param/1": { "documentation": "Face ID for which to get the UV IDs." }, "@roblox/globaltype/EditableMesh.GetFaceUVs/return/0": { "documentation": "List of UV IDs used for the vertices on the given face." }, "@roblox/globaltype/EditableMesh.GetFaceUVs": { "documentation": "Returns the face's UV IDs for the vertices on the face.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFaceUVs/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetFaceUVs/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFaceUVs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceUVs", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFaceVertices/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFaceVertices/param/1": { "documentation": "" }, "@roblox/globaltype/EditableMesh.GetFaceVertices/return/0": { "documentation": "List of vertex IDs around the given face." }, "@roblox/globaltype/EditableMesh.GetFaceVertices": { "documentation": "Returns the face's vertex IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFaceVertices/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetFaceVertices/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFaceVertices/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFaceVertices", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose/param/1": { "documentation": "Array or 2 or 3 FacsActionUnit values that specify a corrective pose." }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose/return/0": { "documentation": "Array of bone IDs and corresponding array of bone CFrames." }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose": { "documentation": "Returns bone IDs and bone CFrames for all bones in a specific FACS corrective pose.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose/param/0" }, { "name": "actions", "documentation": "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacsCorrectivePose/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePose", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePoses/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePoses/return/0": { "documentation": "Array of corrective poses. Each corrective pose is specified by a small array of 2 or 3 FacsActionUnit values." }, "@roblox/globaltype/EditableMesh.GetFacsCorrectivePoses": { "documentation": "Returns all FACS corrective poses that are in use.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacsCorrectivePoses/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacsCorrectivePoses/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsCorrectivePoses", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacsPose/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacsPose/param/1": { "documentation": "FACS action unit for which to get the pose." }, "@roblox/globaltype/EditableMesh.GetFacsPose/return/0": { "documentation": "Array of bone IDs and corresponding array of bone CFrame." }, "@roblox/globaltype/EditableMesh.GetFacsPose": { "documentation": "Returns bone IDs and bone CFrames for all bones in a specific FACS action unit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacsPose/param/0" }, { "name": "action", "documentation": "@roblox/globaltype/EditableMesh.GetFacsPose/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacsPose/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPose", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetFacsPoses/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetFacsPoses/return/0": { "documentation": "Array of FacsActionUnit, one for each FACS action unit that has a pose defined." }, "@roblox/globaltype/EditableMesh.GetFacsPoses": { "documentation": "Returns all FACS action units that have poses defined.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetFacsPoses/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetFacsPoses/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetFacsPoses", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetNormal/param/1": { "documentation": "Normal ID for which to get the normal vector." }, "@roblox/globaltype/EditableMesh.GetNormal/return/0": { "documentation": "Normal vector at the requested normal ID." }, "@roblox/globaltype/EditableMesh.GetNormal": { "documentation": "Returns the normal vector for the given normal ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetNormal/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/EditableMesh.GetNormal/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetNormal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetNormals/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetNormals/return/0": { "documentation": "List of stable normal IDs." }, "@roblox/globaltype/EditableMesh.GetNormals": { "documentation": "Returns all normals of the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetNormals/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetNormals/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetNormals", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetPosition/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetPosition/param/1": { "documentation": "Stable vertex ID for which to get the position." }, "@roblox/globaltype/EditableMesh.GetPosition/return/0": { "documentation": "Position of a vertex in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.GetPosition": { "documentation": "Gets the position of a vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetPosition/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetPosition/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetPosition/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetPosition", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetSize/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetSize/return/0": { "documentation": "Size of the EditableMesh." }, "@roblox/globaltype/EditableMesh.GetSize": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetSize/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetSize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetSize", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetUV/param/1": { "documentation": "UV ID for which to get the UV coordinate." }, "@roblox/globaltype/EditableMesh.GetUV/return/0": { "documentation": "UV coordinates at the requested UV ID." }, "@roblox/globaltype/EditableMesh.GetUV": { "documentation": "Returns UV coordinates at the given UV ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetUV/param/0" }, { "name": "uvId", "documentation": "@roblox/globaltype/EditableMesh.GetUV/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetUV/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetUVs/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetUVs/return/0": { "documentation": "List of stable UV IDs." }, "@roblox/globaltype/EditableMesh.GetUVs": { "documentation": "Returns all UVs of the mesh.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetUVs/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetUVs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetUVs", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexBones/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexBones/param/1": { "documentation": "Vertex ID for which to get the associated bones." }, "@roblox/globaltype/EditableMesh.GetVertexBones/return/0": { "documentation": "Bone IDs associated with the vertex for skinning." }, "@roblox/globaltype/EditableMesh.GetVertexBones": { "documentation": "Returns all bone IDs that are associated with the vertex for skinning.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexBones/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexBones/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexBones/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBones", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexBoneWeights/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexBoneWeights/param/1": { "documentation": "Vertex ID for which to get the associated bone weights." }, "@roblox/globaltype/EditableMesh.GetVertexBoneWeights/return/0": { "documentation": "Skinning blend weights for each bone that is associated with the vertex." }, "@roblox/globaltype/EditableMesh.GetVertexBoneWeights": { "documentation": "Returns skinning blend weights for each bone that is associated with the vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexBoneWeights/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexBoneWeights/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexBoneWeights/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexBoneWeights", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexColors/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexColors/param/1": { "documentation": "Stable vertex ID to find color IDs." }, "@roblox/globaltype/EditableMesh.GetVertexColors/return/0": { "documentation": "Array of color IDs of faces attached to the given vertex." }, "@roblox/globaltype/EditableMesh.GetVertexColors": { "documentation": "Returns the color IDs of the faces attached to the given vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexColors/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexColors/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexColors/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexColors", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexFaceColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexFaceColor/param/1": { "documentation": "Stable vertex ID." }, "@roblox/globaltype/EditableMesh.GetVertexFaceColor/param/2": { "documentation": "Stable face ID." }, "@roblox/globaltype/EditableMesh.GetVertexFaceColor/return/0": { "documentation": "Stable color ID of the vertex/face pair." }, "@roblox/globaltype/EditableMesh.GetVertexFaceColor": { "documentation": "Returns the color ID of a vertex/face pair.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceColor/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceColor/param/1" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceColor/param/2" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexFaceColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/param/1": { "documentation": "Stable vertex ID." }, "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/param/2": { "documentation": "Stable face ID." }, "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/return/0": { "documentation": "Stable normal ID of the vertex/face pair." }, "@roblox/globaltype/EditableMesh.GetVertexFaceNormal": { "documentation": "Returns the normal ID of a vertex/face pair.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/param/1" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/param/2" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexFaceNormal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexFaces/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexFaces/param/1": { "documentation": "Stable vertex ID to find faces for." }, "@roblox/globaltype/EditableMesh.GetVertexFaces/return/0": { "documentation": "Array of face IDs attached to the given vertex." }, "@roblox/globaltype/EditableMesh.GetVertexFaces": { "documentation": "Returns the face IDs of the faces attached to the given vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaces/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaces/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexFaces/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaces", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexFaceUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexFaceUV/param/1": { "documentation": "Stable vertex ID." }, "@roblox/globaltype/EditableMesh.GetVertexFaceUV/param/2": { "documentation": "Stable face ID." }, "@roblox/globaltype/EditableMesh.GetVertexFaceUV/return/0": { "documentation": "Stable UV ID of the vertex/face pair." }, "@roblox/globaltype/EditableMesh.GetVertexFaceUV": { "documentation": "Returns the UV ID of a vertex/face pair.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceUV/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceUV/param/1" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexFaceUV/param/2" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexFaceUV/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexFaceUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexNormals/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexNormals/param/1": { "documentation": "Stable vertex ID to find normal IDs." }, "@roblox/globaltype/EditableMesh.GetVertexNormals/return/0": { "documentation": "Array of normal IDs of faces attached to the given vertex." }, "@roblox/globaltype/EditableMesh.GetVertexNormals": { "documentation": "Returns the normal IDs of the faces attached to the given vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexNormals/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexNormals/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexNormals/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexNormals", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertexUVs/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertexUVs/param/1": { "documentation": "Stable vertex ID to find UV IDs." }, "@roblox/globaltype/EditableMesh.GetVertexUVs/return/0": { "documentation": "Array of UV IDs of faces attached to the given vertex." }, "@roblox/globaltype/EditableMesh.GetVertexUVs": { "documentation": "Returns the UV IDs of the faces attached to the given vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertexUVs/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.GetVertexUVs/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertexUVs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertexUVs", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVertices/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVertices/return/0": { "documentation": "List of stable vertex IDs." }, "@roblox/globaltype/EditableMesh.GetVertices": { "documentation": "Returns all vertices as a list of stable vertex IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVertices/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVertices/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVertices", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute/param/1": { "documentation": "Attribute ID for which to find vertices that use it." }, "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute/return/0": { "documentation": "List of vertex IDs which use the given attribute ID." }, "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute": { "documentation": "Deprecated:
Returns a list of vertices that use a given attribute ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute/param/0" }, { "name": "id", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVerticesWithAttribute/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithAttribute", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVerticesWithColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVerticesWithColor/param/1": { "documentation": "Color ID to find faces for." }, "@roblox/globaltype/EditableMesh.GetVerticesWithColor/return/0": { "documentation": "List of face IDs that use the provided color ID." }, "@roblox/globaltype/EditableMesh.GetVerticesWithColor": { "documentation": "Returns an array of vertex IDs that use the given color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithColor/param/0" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithColor/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVerticesWithColor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVerticesWithNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVerticesWithNormal/param/1": { "documentation": "Normal ID to find vertices for." }, "@roblox/globaltype/EditableMesh.GetVerticesWithNormal/return/0": { "documentation": "List of vertex IDs that use the provided normal ID." }, "@roblox/globaltype/EditableMesh.GetVerticesWithNormal": { "documentation": "Returns an array of vertex IDs that use the given normal ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithNormal/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithNormal/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVerticesWithNormal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.GetVerticesWithUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.GetVerticesWithUV/param/1": { "documentation": "UV ID to find vertices for." }, "@roblox/globaltype/EditableMesh.GetVerticesWithUV/return/0": { "documentation": "List of vertex IDs that use the provided UV ID." }, "@roblox/globaltype/EditableMesh.GetVerticesWithUV": { "documentation": "Returns an array of vertex IDs that use the given UV ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithUV/param/0" }, { "name": "uvId", "documentation": "@roblox/globaltype/EditableMesh.GetVerticesWithUV/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.GetVerticesWithUV/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#GetVerticesWithUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.IdDebugString/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.IdDebugString/param/1": { "documentation": "ID for which to return a debugging information string." }, "@roblox/globaltype/EditableMesh.IdDebugString/return/0": { "documentation": "String that describes the ID in human-readable format." }, "@roblox/globaltype/EditableMesh.IdDebugString": { "documentation": "Returns a string describing a stable ID, useful for debugging purposes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.IdDebugString/param/0" }, { "name": "id", "documentation": "@roblox/globaltype/EditableMesh.IdDebugString/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.IdDebugString/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#IdDebugString", "code_sample": "" }, "@roblox/globaltype/EditableMesh.MergeVertices/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.MergeVertices/param/1": { "documentation": "The distance at which the vertices are considered to touch each other." }, "@roblox/globaltype/EditableMesh.MergeVertices/return/0": { "documentation": "A mapping of old vertex ID to new vertex ID for vertices that have been merged." }, "@roblox/globaltype/EditableMesh.MergeVertices": { "documentation": "Merges vertices that touch together.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.MergeVertices/param/0" }, { "name": "mergeTolerance", "documentation": "@roblox/globaltype/EditableMesh.MergeVertices/param/1" } ], "returns": [ "@roblox/globaltype/EditableMesh.MergeVertices/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#MergeVertices", "code_sample": "" }, "@roblox/globaltype/EditableMesh.RaycastLocal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.RaycastLocal/param/1": { "documentation": "Origin of the ray in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.RaycastLocal/param/2": { "documentation": "Direction of the ray." }, "@roblox/globaltype/EditableMesh.RaycastLocal/return/0": { "documentation": "Tuple of the point of intersection, face ID, and barycentric coordinates." }, "@roblox/globaltype/EditableMesh.RaycastLocal": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.RaycastLocal/param/0" }, { "name": "origin", "documentation": "@roblox/globaltype/EditableMesh.RaycastLocal/param/1" }, { "name": "direction", "documentation": "@roblox/globaltype/EditableMesh.RaycastLocal/param/2" } ], "returns": [ "@roblox/globaltype/EditableMesh.RaycastLocal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RaycastLocal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.RemoveBone/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.RemoveBone/param/1": { "documentation": "" }, "@roblox/globaltype/EditableMesh.RemoveBone": { "documentation": "Removes a bone using its stable bone ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.RemoveBone/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.RemoveBone/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveBone", "code_sample": "" }, "@roblox/globaltype/EditableMesh.RemoveFace/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.RemoveFace/param/1": { "documentation": "" }, "@roblox/globaltype/EditableMesh.RemoveFace": { "documentation": "Removes a face using its stable face ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.RemoveFace/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.RemoveFace/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveFace", "code_sample": "" }, "@roblox/globaltype/EditableMesh.RemoveUnused/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.RemoveUnused/return/0": { "documentation": "All of the removed stable IDs." }, "@roblox/globaltype/EditableMesh.RemoveUnused": { "documentation": "Removes all unused vertices, normals, UVs, and colors, and returns the removed IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.RemoveUnused/param/0" } ], "returns": [ "@roblox/globaltype/EditableMesh.RemoveUnused/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#RemoveUnused", "code_sample": "" }, "@roblox/globaltype/EditableMesh.ResetNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.ResetNormal/param/1": { "documentation": "Stable normal ID to reset." }, "@roblox/globaltype/EditableMesh.ResetNormal": { "documentation": "Reset this normal ID to be automatically calculated.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.ResetNormal/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/EditableMesh.ResetNormal/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#ResetNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetBoneCFrame/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetBoneCFrame/param/1": { "documentation": "Bone ID for which to set the initial CFrame." }, "@roblox/globaltype/EditableMesh.SetBoneCFrame/param/2": { "documentation": "Initial CFrame for the bone in the mesh's bind pose, in the mesh's local space." }, "@roblox/globaltype/EditableMesh.SetBoneCFrame": { "documentation": "Set the initial CFrame for a bone in the mesh's bind pose.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetBoneCFrame/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.SetBoneCFrame/param/1" }, { "name": "cframe", "documentation": "@roblox/globaltype/EditableMesh.SetBoneCFrame/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneCFrame", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetBoneIsVirtual/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetBoneIsVirtual/param/1": { "documentation": "Bone ID for which to set whether the bone is virtual." }, "@roblox/globaltype/EditableMesh.SetBoneIsVirtual/param/2": { "documentation": "Whether the bone should be virtual." }, "@roblox/globaltype/EditableMesh.SetBoneIsVirtual": { "documentation": "Set whether a bone is virtual.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetBoneIsVirtual/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.SetBoneIsVirtual/param/1" }, { "name": "virtual", "documentation": "@roblox/globaltype/EditableMesh.SetBoneIsVirtual/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneIsVirtual", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetBoneName/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetBoneName/param/1": { "documentation": "Bone ID for which to set the name." }, "@roblox/globaltype/EditableMesh.SetBoneName/param/2": { "documentation": "Bone name to set." }, "@roblox/globaltype/EditableMesh.SetBoneName": { "documentation": "Sets the name for a bone.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetBoneName/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.SetBoneName/param/1" }, { "name": "name", "documentation": "@roblox/globaltype/EditableMesh.SetBoneName/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneName", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetBoneParent/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetBoneParent/param/1": { "documentation": "Bone ID for which to set the parent." }, "@roblox/globaltype/EditableMesh.SetBoneParent/param/2": { "documentation": "Parent bone ID." }, "@roblox/globaltype/EditableMesh.SetBoneParent": { "documentation": "Set a parent for a bone.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetBoneParent/param/0" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.SetBoneParent/param/1" }, { "name": "parentBoneId", "documentation": "@roblox/globaltype/EditableMesh.SetBoneParent/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetBoneParent", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetColor/param/1": { "documentation": "Stable color ID for which to set the color." }, "@roblox/globaltype/EditableMesh.SetColor/param/2": { "documentation": "Color to set." }, "@roblox/globaltype/EditableMesh.SetColor": { "documentation": "Sets the color for a color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetColor/param/0" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.SetColor/param/1" }, { "name": "color", "documentation": "@roblox/globaltype/EditableMesh.SetColor/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetColorAlpha/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetColorAlpha/param/1": { "documentation": "Stable color ID for which to set the color alpha." }, "@roblox/globaltype/EditableMesh.SetColorAlpha/param/2": { "documentation": "Alpha to set." }, "@roblox/globaltype/EditableMesh.SetColorAlpha": { "documentation": "Sets the color alpha (transparency) for a color ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetColorAlpha/param/0" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.SetColorAlpha/param/1" }, { "name": "alpha", "documentation": "@roblox/globaltype/EditableMesh.SetColorAlpha/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetColorAlpha", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFaceColors/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFaceColors/param/1": { "documentation": "Face ID for which to update the vertex colors." }, "@roblox/globaltype/EditableMesh.SetFaceColors/param/2": { "documentation": "List of new stable color IDs to use for the given face's vertices." }, "@roblox/globaltype/EditableMesh.SetFaceColors": { "documentation": "Sets the face's vertex colors to new color IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFaceColors/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetFaceColors/param/1" }, { "name": "ids", "documentation": "@roblox/globaltype/EditableMesh.SetFaceColors/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceColors", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFaceNormals/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFaceNormals/param/1": { "documentation": "Face ID for which to update the vertex normals." }, "@roblox/globaltype/EditableMesh.SetFaceNormals/param/2": { "documentation": "List of new stable normal IDs to use for the given face's vertices." }, "@roblox/globaltype/EditableMesh.SetFaceNormals": { "documentation": "Sets the face's vertex normals to new normal IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFaceNormals/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetFaceNormals/param/1" }, { "name": "ids", "documentation": "@roblox/globaltype/EditableMesh.SetFaceNormals/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceNormals", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFaceUVs/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFaceUVs/param/1": { "documentation": "Face ID for which to update the vertex UVs." }, "@roblox/globaltype/EditableMesh.SetFaceUVs/param/2": { "documentation": "List of new stable UV IDs to use for the given face's vertices." }, "@roblox/globaltype/EditableMesh.SetFaceUVs": { "documentation": "Sets the face's vertex UVs to new UV IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFaceUVs/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetFaceUVs/param/1" }, { "name": "ids", "documentation": "@roblox/globaltype/EditableMesh.SetFaceUVs/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceUVs", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFaceVertices/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFaceVertices/param/1": { "documentation": "Face ID for which to update the vertices." }, "@roblox/globaltype/EditableMesh.SetFaceVertices/param/2": { "documentation": "List of new stable vertex IDs to use for the given face." }, "@roblox/globaltype/EditableMesh.SetFaceVertices": { "documentation": "Sets the face's vertices to new vertex IDs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFaceVertices/param/0" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetFaceVertices/param/1" }, { "name": "ids", "documentation": "@roblox/globaltype/EditableMesh.SetFaceVertices/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFaceVertices", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/1": { "documentation": "FACS action unit for which to set the pose." }, "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/2": { "documentation": "Bone to set a CFrame for this pose." }, "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/3": { "documentation": "CFrame which transforms the bone from the initial bone CFrame in the bind pose of the mesh to the combined bone CFrame for this pose. All CFrames are in the mesh's local space." }, "@roblox/globaltype/EditableMesh.SetFacsBonePose": { "documentation": "Set CFrame for an individual bone in a specific FACS action unit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/0" }, { "name": "action", "documentation": "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/1" }, { "name": "boneId", "documentation": "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/2" }, { "name": "cframe", "documentation": "@roblox/globaltype/EditableMesh.SetFacsBonePose/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsBonePose", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/1": { "documentation": "Array or 2 or 3 FacsActionUnit values to apply as a corrective pose." }, "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/2": { "documentation": "Bones to set a CFrame for this pose." }, "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/3": { "documentation": "CFrame transforms for the bones in this corrective pose. Each bone CFrame transforms the bone from the initial bone CFrame in the bind pose of the mesh to the combined bone CFrame for this pose. All CFrames are in the mesh's local space." }, "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose": { "documentation": "Set pose for all bones in a specific FACS corrective pose.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/0" }, { "name": "actions", "documentation": "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/1" }, { "name": "boneIds", "documentation": "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/2" }, { "name": "cframes", "documentation": "@roblox/globaltype/EditableMesh.SetFacsCorrectivePose/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsCorrectivePose", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetFacsPose/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetFacsPose/param/1": { "documentation": "FACS action unit to set the pose for." }, "@roblox/globaltype/EditableMesh.SetFacsPose/param/2": { "documentation": "Bones for which to set a CFrame for this pose." }, "@roblox/globaltype/EditableMesh.SetFacsPose/param/3": { "documentation": "CFrame transforms for the bones in this pose. Each bone CFrame transforms the bone from the initial bone CFrame in the bind pose of the mesh to the combined bone CFrame for this pose. All CFrames are in the mesh's local space." }, "@roblox/globaltype/EditableMesh.SetFacsPose": { "documentation": "Set pose for all bones in a specific FACS action unit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetFacsPose/param/0" }, { "name": "action", "documentation": "@roblox/globaltype/EditableMesh.SetFacsPose/param/1" }, { "name": "boneIds", "documentation": "@roblox/globaltype/EditableMesh.SetFacsPose/param/2" }, { "name": "cframes", "documentation": "@roblox/globaltype/EditableMesh.SetFacsPose/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetFacsPose", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetNormal/param/1": { "documentation": "Stable normal ID for which to set the normal vector." }, "@roblox/globaltype/EditableMesh.SetNormal/param/2": { "documentation": "Normal vector to set." }, "@roblox/globaltype/EditableMesh.SetNormal": { "documentation": "Set the normal for a normal ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetNormal/param/0" }, { "name": "normalId", "documentation": "@roblox/globaltype/EditableMesh.SetNormal/param/1" }, { "name": "normal", "documentation": "@roblox/globaltype/EditableMesh.SetNormal/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetPosition/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetPosition/param/1": { "documentation": "Stable vertex ID of the vertex to position." }, "@roblox/globaltype/EditableMesh.SetPosition/param/2": { "documentation": "Position in the mesh's local object space." }, "@roblox/globaltype/EditableMesh.SetPosition": { "documentation": "Sets a vertex position in the mesh's local object space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetPosition/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.SetPosition/param/1" }, { "name": "p", "documentation": "@roblox/globaltype/EditableMesh.SetPosition/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetPosition", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetUV/param/1": { "documentation": "UV ID for which to set the UV coordinates." }, "@roblox/globaltype/EditableMesh.SetUV/param/2": { "documentation": "UV coordinates." }, "@roblox/globaltype/EditableMesh.SetUV": { "documentation": "Sets UV coordinates for a UV ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetUV/param/0" }, { "name": "uvId", "documentation": "@roblox/globaltype/EditableMesh.SetUV/param/1" }, { "name": "uv", "documentation": "@roblox/globaltype/EditableMesh.SetUV/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetVertexBones/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetVertexBones/param/1": { "documentation": "Vertex ID to set vertex skinning bones." }, "@roblox/globaltype/EditableMesh.SetVertexBones/param/2": { "documentation": "Bone IDs to use with this vertex for skinning." }, "@roblox/globaltype/EditableMesh.SetVertexBones": { "documentation": "Assign a list of bones with the vertex for skinning.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetVertexBones/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexBones/param/1" }, { "name": "boneIDs", "documentation": "@roblox/globaltype/EditableMesh.SetVertexBones/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBones", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetVertexBoneWeights/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetVertexBoneWeights/param/1": { "documentation": "Vertex ID on which to set skinning blend weights." }, "@roblox/globaltype/EditableMesh.SetVertexBoneWeights/param/2": { "documentation": "Skinning blend weights to set on the vertex." }, "@roblox/globaltype/EditableMesh.SetVertexBoneWeights": { "documentation": "Sets skinning blend weights for each bone associated with the vertex.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetVertexBoneWeights/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexBoneWeights/param/1" }, { "name": "boneWeights", "documentation": "@roblox/globaltype/EditableMesh.SetVertexBoneWeights/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexBoneWeights", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/1": { "documentation": "Stable vertex ID." }, "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/2": { "documentation": "Stable face ID." }, "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/3": { "documentation": "Stable color ID to set for the vertex/face pair." }, "@roblox/globaltype/EditableMesh.SetVertexFaceColor": { "documentation": "Sets the color ID of a vertex/face pair.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/1" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/2" }, { "name": "colorId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceColor/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceColor", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/1": { "documentation": "Stable vertex ID." }, "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/2": { "documentation": "Stable face ID." }, "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/3": { "documentation": "Stable normal ID to set for the vertex/face pair." }, "@roblox/globaltype/EditableMesh.SetVertexFaceNormal": { "documentation": "Sets the normal ID of a vertex/face pair.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/1" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/2" }, { "name": "normalId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceNormal/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceNormal", "code_sample": "" }, "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/1": { "documentation": "Stable vertex ID." }, "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/2": { "documentation": "Stable face ID." }, "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/3": { "documentation": "Stable UV ID to set for the vertex/face pair." }, "@roblox/globaltype/EditableMesh.SetVertexFaceUV": { "documentation": "Sets the UV ID of a vertex/face pair.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/0" }, { "name": "vertexId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/1" }, { "name": "faceId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/2" }, { "name": "uvId", "documentation": "@roblox/globaltype/EditableMesh.SetVertexFaceUV/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#SetVertexFaceUV", "code_sample": "" }, "@roblox/globaltype/EditableMesh.Triangulate/param/0": { "documentation": "Instance which allows for the runtime creation and manipulation of meshes." }, "@roblox/globaltype/EditableMesh.Triangulate": { "documentation": "Splits all faces on the mesh to be triangles.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/EditableMesh.Triangulate/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/EditableMesh#Triangulate", "code_sample": "" }, "@roblox/globaltype/AdGui": { "documentation": "", "keys": { "AdShape": "@roblox/globaltype/AdGui.AdShape", "EnableVideoAds": "@roblox/globaltype/AdGui.EnableVideoAds", "FallbackImage": "@roblox/globaltype/AdGui.FallbackImage", "Status": "@roblox/globaltype/AdGui.Status", "OnAdEvent": "@roblox/globaltype/AdGui.OnAdEvent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdGui", "code_sample": "" }, "@roblox/globaltype/AdGui.AdShape": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdGui#AdShape", "code_sample": "" }, "@roblox/globaltype/AdGui.EnableVideoAds": { "documentation": "Enables the AdGui to serve video ads.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdGui#EnableVideoAds", "code_sample": "" }, "@roblox/globaltype/AdGui.FallbackImage": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdGui#FallbackImage", "code_sample": "" }, "@roblox/globaltype/AdGui.Status": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdGui#Status", "code_sample": "" }, "@roblox/globaltype/AdGui.OnAdEvent/param/0": { "documentation": "Options table for the method: " }, "@roblox/globaltype/AdGui.OnAdEvent/return/0": { "documentation": "Whether the callback has successfully reacted to the event." }, "@roblox/globaltype/AdGui.OnAdEvent": { "documentation": "Used to react to the AdGui events.", "params": [ { "name": "eventInfo", "documentation": "@roblox/globaltype/AdGui.OnAdEvent/param/0" } ], "returns": [ "@roblox/globaltype/AdGui.OnAdEvent/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdGui#OnAdEvent", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService": { "documentation": "This service is used for interacting with ScriptDocument instances.", "keys": { "DeregisterAutocompleteCallback": "@roblox/globaltype/ScriptEditorService.DeregisterAutocompleteCallback", "DeregisterScriptAnalysisCallback": "@roblox/globaltype/ScriptEditorService.DeregisterScriptAnalysisCallback", "FindScriptDocument": "@roblox/globaltype/ScriptEditorService.FindScriptDocument", "GetEditorSource": "@roblox/globaltype/ScriptEditorService.GetEditorSource", "GetScriptDocuments": "@roblox/globaltype/ScriptEditorService.GetScriptDocuments", "OpenScriptDocumentAsync": "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync", "RegisterAutocompleteCallback": "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback", "RegisterScriptAnalysisCallback": "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback", "UpdateSourceAsync": "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService.DeregisterAutocompleteCallback/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.DeregisterAutocompleteCallback/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.DeregisterAutocompleteCallback": { "documentation": "Removes a previously registered callback with the name name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.DeregisterAutocompleteCallback/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/ScriptEditorService.DeregisterAutocompleteCallback/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#DeregisterAutocompleteCallback", "code_sample": "game.ScriptEditorService:DeregisterAutocompleteCallback(\"foo\")" }, "@roblox/globaltype/ScriptEditorService.DeregisterScriptAnalysisCallback/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.DeregisterScriptAnalysisCallback/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.DeregisterScriptAnalysisCallback": { "documentation": "Removes a previously registered callback with the name name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.DeregisterScriptAnalysisCallback/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/ScriptEditorService.DeregisterScriptAnalysisCallback/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#DeregisterScriptAnalysisCallback", "code_sample": "local ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nScriptEditorService:DeregisterScriptAnalysisCallback(\"foo\")" }, "@roblox/globaltype/ScriptEditorService.FindScriptDocument/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.FindScriptDocument/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.FindScriptDocument/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.FindScriptDocument": { "documentation": "Returns the open ScriptDocument corresponding to the given LuaSourceContainer, or nil if the given script is not open.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.FindScriptDocument/param/0" }, { "name": "script", "documentation": "@roblox/globaltype/ScriptEditorService.FindScriptDocument/param/1" } ], "returns": [ "@roblox/globaltype/ScriptEditorService.FindScriptDocument/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#FindScriptDocument", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal documents = ScriptEditorService:GetScriptDocuments()\nlocal scriptDocument\n-- Find the first open script document\nfor _, document in documents do\n\t-- The Command Bar can't be closed, so don't select it\n\tif not document:IsCommandBar() then\n\t\tscriptDocument = document\n\t\tbreak\n\tend\nend\n\nif scriptDocument then\n\tlocal success, err = scriptDocument:CloseAsync()\n\tif success then\n\t\tprint(`Closed {scriptDocument.Name}`)\n\telse\n\t\twarn(`Failed to close {scriptDocument.Name} because: {err}`)\n\tend\nelse\n\tprint(\"No open scripts\")\nend" }, "@roblox/globaltype/ScriptEditorService.GetEditorSource/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.GetEditorSource/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.GetEditorSource/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.GetEditorSource": { "documentation": "Returns the edit-time source for the given script.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.GetEditorSource/param/0" }, { "name": "script", "documentation": "@roblox/globaltype/ScriptEditorService.GetEditorSource/param/1" } ], "returns": [ "@roblox/globaltype/ScriptEditorService.GetEditorSource/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#GetEditorSource", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService.GetScriptDocuments/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.GetScriptDocuments/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.GetScriptDocuments": { "documentation": "Returns an array of the currently open script documents, including the command bar.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.GetScriptDocuments/param/0" } ], "returns": [ "@roblox/globaltype/ScriptEditorService.GetScriptDocuments/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#GetScriptDocuments", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nlocal scriptDocuments = ScriptEditorService:GetScriptDocuments()\nfor _, scriptDocument in scriptDocuments do\n\t-- Prints the name of each script\n\tif not scriptDocument:IsCommandBar() then\n\t\tprint(scriptDocument.Name)\n\tend\nend" }, "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync": { "documentation": "Requests that a Script Editor open the specified script. Returns (true, nil) if the request succeeds. Returns (false, string) if the request fails, with a string that describes the problem.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/param/0" }, { "name": "script", "documentation": "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/param/1" }, { "name": "options", "documentation": "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/param/2" } ], "returns": [ "@roblox/globaltype/ScriptEditorService.OpenScriptDocumentAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#OpenScriptDocumentAsync", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\nlocal Workspace = game:GetService(\"Workspace\")\n\nlocal newScript = Instance.new(\"Script\")\nnewScript.Parent = Workspace\n\nlocal success, err = ScriptEditorService:OpenScriptDocumentAsync(newScript)\nif success then\n\tprint(\"Opened script document\")\nelse\n\tprint(`Failed to open script document: {err}`)\nend" }, "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/3": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback": { "documentation": "Registers an autocomplete callback callbackFunction named name with priority priority.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/1" }, { "name": "priority", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/2" }, { "name": "callbackFunction", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterAutocompleteCallback/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#RegisterAutocompleteCallback", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/2": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/3": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback": { "documentation": "Registers a Script Analysis callback callbackFunction named name with priority.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/1" }, { "name": "priority", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/2" }, { "name": "callbackFunction", "documentation": "@roblox/globaltype/ScriptEditorService.RegisterScriptAnalysisCallback/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#RegisterScriptAnalysisCallback", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync/param/0": { "documentation": "This service is used for interacting with ScriptDocument instances." }, "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync/param/1": { "documentation": "Script instance to be updated." }, "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync/param/2": { "documentation": "The function to return new script content." }, "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync": { "documentation": "Generates new content from the old script and updates the script editor if it's open, or the Script instance if the script editor is closed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync/param/0" }, { "name": "script", "documentation": "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync/param/1" }, { "name": "callback", "documentation": "@roblox/globaltype/ScriptEditorService.UpdateSourceAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#UpdateSourceAsync", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange": { "documentation": "Fires just after a ScriptDocument changes.", "keys": { "Connect": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Connect", "ConnectParallel": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.ConnectParallel", "Once": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Once", "Wait": "@roblox/globaltype/ScriptEditorService.TextDocumentDidChange.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#TextDocumentDidChange", "code_sample": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose": { "documentation": "Fires just before a ScriptDocument object is destroyed, which happens right after the script editor closes.", "keys": { "Connect": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Connect", "ConnectParallel": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.ConnectParallel", "Once": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Once", "Wait": "@roblox/globaltype/ScriptEditorService.TextDocumentDidClose.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#TextDocumentDidClose", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nScriptEditorService.TextDocumentDidClose:Connect(function(scriptDocument)\n\tprint(\"Closed\", scriptDocument)\nend)" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen": { "documentation": "Fires just after a ScriptDocument object is created and parented to the service, which happens right after the script editor opens.", "keys": { "Connect": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Connect", "ConnectParallel": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.ConnectParallel", "Once": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Once", "Wait": "@roblox/globaltype/ScriptEditorService.TextDocumentDidOpen.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ScriptEditorService#TextDocumentDidOpen", "code_sample": "--!nocheck\n\n-- Run the following code in the Command Bar\n\nlocal ScriptEditorService = game:GetService(\"ScriptEditorService\")\n\nScriptEditorService.TextDocumentDidOpen:Connect(function(scriptDocument)\n\tprint(\"Opened\", scriptDocument)\nend)" }, "@roblox/globaltype/DataStoreGetOptions": { "documentation": "", "keys": { "UseCache": "@roblox/globaltype/DataStoreGetOptions.UseCache" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreGetOptions", "code_sample": "" }, "@roblox/globaltype/DataStoreGetOptions.UseCache": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreGetOptions#UseCache", "code_sample": "" }, "@roblox/globaltype/Keyframe": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback.", "keys": { "Time": "@roblox/globaltype/Keyframe.Time", "AddMarker": "@roblox/globaltype/Keyframe.AddMarker", "AddPose": "@roblox/globaltype/Keyframe.AddPose", "GetMarkers": "@roblox/globaltype/Keyframe.GetMarkers", "GetPoses": "@roblox/globaltype/Keyframe.GetPoses", "RemoveMarker": "@roblox/globaltype/Keyframe.RemoveMarker", "RemovePose": "@roblox/globaltype/Keyframe.RemovePose" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe", "code_sample": "" }, "@roblox/globaltype/Keyframe.Time": { "documentation": "The Keyframe time position (in seconds) in an animation. This determines the time at which the Poses inside the keyframe will be shown.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#Time", "code_sample": "local function getSequenceLength(keyframeSequence)\n\tlocal length = 0\n\tfor _, keyframe in pairs(keyframeSequence:GetKeyframes()) do\n\t\tif keyframe.Time > length then\n\t\t\tlength = keyframe.Time\n\t\tend\n\tend\n\treturn length\nend\n\nlocal keyframeSequence = Instance.new(\"KeyframeSequence\")\n\ngetSequenceLength(keyframeSequence)" }, "@roblox/globaltype/Keyframe.AddMarker/param/0": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback." }, "@roblox/globaltype/Keyframe.AddMarker/param/1": { "documentation": "The KeyframeMarker being parented to the Keyframe." }, "@roblox/globaltype/Keyframe.AddMarker": { "documentation": "Adds a KeyframeMarker to the Keyframe by parenting it to the keyframe.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Keyframe.AddMarker/param/0" }, { "name": "marker", "documentation": "@roblox/globaltype/Keyframe.AddMarker/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#AddMarker", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal marker = Instance.new(\"KeyframeMarker\")\nmarker.Name = \"FootStep\"\nmarker.Value = 100\n\nkeyframe:AddMarker(marker) --marker.Parent = keyframe\n\ntask.wait(2)\n\nkeyframe:RemoveMarker(marker) --marker.Parent = nil" }, "@roblox/globaltype/Keyframe.AddPose/param/0": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback." }, "@roblox/globaltype/Keyframe.AddPose/param/1": { "documentation": "The Pose to be added." }, "@roblox/globaltype/Keyframe.AddPose": { "documentation": "Adds a Pose to the Keyframe by parenting it to the keyframe.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Keyframe.AddPose/param/0" }, { "name": "pose", "documentation": "@roblox/globaltype/Keyframe.AddPose/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#AddPose", "code_sample": "" }, "@roblox/globaltype/Keyframe.GetMarkers/param/0": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback." }, "@roblox/globaltype/Keyframe.GetMarkers/return/0": { "documentation": "An array containing all KeyframeMarkers that have been added to the Keyframe." }, "@roblox/globaltype/Keyframe.GetMarkers": { "documentation": "Returns an array containing all KeyframeMarkers that have been added to the Keyframe.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Keyframe.GetMarkers/param/0" } ], "returns": [ "@roblox/globaltype/Keyframe.GetMarkers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#GetMarkers", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal marker1 = Instance.new(\"KeyframeMarker\")\nmarker1.Name = \"FootStep\"\nmarker1.Value = 100\n\nlocal marker2 = Instance.new(\"KeyframeMarker\")\nmarker2.Name = \"Wave\"\nmarker2.Value = 100\n\nkeyframe:AddMarker(marker1) --marker.Parent = keyframe\nkeyframe:AddMarker(marker2) --marker.Parent = keyframe\n\nlocal markers = keyframe:GetMarkers()\nfor _, marker in pairs(markers) do\n\tprint(marker.Name)\nend" }, "@roblox/globaltype/Keyframe.GetPoses/param/0": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback." }, "@roblox/globaltype/Keyframe.GetPoses/return/0": { "documentation": "An array of Poses." }, "@roblox/globaltype/Keyframe.GetPoses": { "documentation": "Returns an array containing all Poses that have been added to a Keyframe.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Keyframe.GetPoses/param/0" } ], "returns": [ "@roblox/globaltype/Keyframe.GetPoses/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#GetPoses", "code_sample": "" }, "@roblox/globaltype/Keyframe.RemoveMarker/param/0": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback." }, "@roblox/globaltype/Keyframe.RemoveMarker/param/1": { "documentation": "The marker being removed from the Keyframe." }, "@roblox/globaltype/Keyframe.RemoveMarker": { "documentation": "Removes a KeyframeMarker from the Keyframe by settings its Instance.Parent to nil.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Keyframe.RemoveMarker/param/0" }, { "name": "marker", "documentation": "@roblox/globaltype/Keyframe.RemoveMarker/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#RemoveMarker", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal marker = Instance.new(\"KeyframeMarker\")\nmarker.Name = \"FootStep\"\nmarker.Value = 100\n\nkeyframe:AddMarker(marker) --marker.Parent = keyframe\n\ntask.wait(2)\n\nkeyframe:RemoveMarker(marker) --marker.Parent = nil" }, "@roblox/globaltype/Keyframe.RemovePose/param/0": { "documentation": "A Keyframe holds the Poses applied to joints in a Model at a given point of time in an animation. Keyframes are interpolated between during animation playback." }, "@roblox/globaltype/Keyframe.RemovePose/param/1": { "documentation": "The Pose to be removed." }, "@roblox/globaltype/Keyframe.RemovePose": { "documentation": "Removes a Pose from the Keyframe by setting its Instance.Parent to nil.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Keyframe.RemovePose/param/0" }, { "name": "pose", "documentation": "@roblox/globaltype/Keyframe.RemovePose/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Keyframe#RemovePose", "code_sample": "local keyframe = Instance.new(\"Keyframe\")\nkeyframe.Parent = workspace\n\nlocal pose = Instance.new(\"Pose\")\npose.EasingStyle = Enum.PoseEasingStyle.Cubic\npose.EasingDirection = Enum.PoseEasingDirection.Out\n\nlocal pose2 = Instance.new(\"Pose\")\npose2.EasingStyle = Enum.PoseEasingStyle.Cubic\npose2.EasingDirection = Enum.PoseEasingDirection.Out\n\nkeyframe:AddPose(pose) -- pose.Parent = keyframe\n\ntask.wait(2)\n\nkeyframe:RemovePose(pose) -- pose.Parent = nil\n\ntask.wait(2)\n\nkeyframe:AddPose(pose) -- pose.Parent = keyframe\n\ntask.wait(2)\n\npose:AddSubPose(pose2) -- pose2.Parent = pose\n\ntask.wait(2)\n\npose:RemoveSubPose(pose2) -- pose2.Parent = nil" }, "@roblox/globaltype/Hole": { "documentation": "Deprecated: A Hole is an unused type of surface joint. It should not be used in new work.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Hole", "code_sample": "" }, "@roblox/globaltype/AdPortal": { "documentation": "", "keys": { "PortalInvalidReason": "@roblox/globaltype/AdPortal.PortalInvalidReason", "Status": "@roblox/globaltype/AdPortal.Status" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdPortal", "code_sample": "" }, "@roblox/globaltype/AdPortal.PortalInvalidReason": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdPortal#PortalInvalidReason", "code_sample": "" }, "@roblox/globaltype/AdPortal.Status": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdPortal#Status", "code_sample": "" }, "@roblox/globaltype/Object": { "documentation": "Object is the base class for all classes in the Roblox class hierarchy.", "keys": { "ClassName": "@roblox/globaltype/Object.ClassName", "className": "@roblox/globaltype/Object.className", "GetPropertyChangedSignal": "@roblox/globaltype/Object.GetPropertyChangedSignal", "IsA": "@roblox/globaltype/Object.IsA", "isA": "@roblox/globaltype/Object.isA" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object", "code_sample": "" }, "@roblox/globaltype/Object.ClassName": { "documentation": "A read-only string representing the class this Object belongs to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object#ClassName", "code_sample": "" }, "@roblox/globaltype/Object.className": { "documentation": "Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object#className", "code_sample": "" }, "@roblox/globaltype/Object.GetPropertyChangedSignal/param/0": { "documentation": "Object is the base class for all classes in the Roblox class hierarchy." }, "@roblox/globaltype/Object.GetPropertyChangedSignal/param/1": { "documentation": "The property to connect to." }, "@roblox/globaltype/Object.GetPropertyChangedSignal/return/0": { "documentation": "A signal that fires whenever the property changes." }, "@roblox/globaltype/Object.GetPropertyChangedSignal": { "documentation": "Get an event that fires when a given property of the object changes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.GetPropertyChangedSignal/param/0" }, { "name": "property", "documentation": "@roblox/globaltype/Object.GetPropertyChangedSignal/param/1" } ], "returns": [ "@roblox/globaltype/Object.GetPropertyChangedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object#GetPropertyChangedSignal", "code_sample": "local part = Instance.new(\"Part\")\n\nlocal currentColor = part.BrickColor\n\nlocal function onBrickColorChanged()\n\tlocal newColor = part.BrickColor\n\tprint(\"Color changed from\", currentColor.Name, \"to\", newColor.Name)\n\tcurrentColor = newColor\nend\npart:GetPropertyChangedSignal(\"BrickColor\"):Connect(onBrickColorChanged)\n\npart.BrickColor = BrickColor.new(\"Really red\")\npart.BrickColor = BrickColor.new(\"Really blue\")" }, "@roblox/globaltype/Object.IsA/param/0": { "documentation": "Object is the base class for all classes in the Roblox class hierarchy." }, "@roblox/globaltype/Object.IsA/param/1": { "documentation": "The class against which the Object's class will be checked. Case-sensitive." }, "@roblox/globaltype/Object.IsA/return/0": { "documentation": "Describes whether the Object's class matched or is a subclass of the given class." }, "@roblox/globaltype/Object.IsA": { "documentation": "Returns true if an object's class matches or inherits from a given class.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.IsA/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/Object.IsA/param/1" } ], "returns": [ "@roblox/globaltype/Object.IsA/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object#IsA", "code_sample": "local Workspace = game:GetService(\"Workspace\")\n\nprint(Workspace:IsA(\"Workspace\")) -- true\nprint(Workspace:IsA(\"BasePart\")) -- false\nprint(Workspace:IsA(\"Instance\")) -- true" }, "@roblox/globaltype/Object.isA/param/0": { "documentation": "Object is the base class for all classes in the Roblox class hierarchy." }, "@roblox/globaltype/Object.isA/param/1": { "documentation": "" }, "@roblox/globaltype/Object.isA/return/0": { "documentation": "" }, "@roblox/globaltype/Object.isA": { "documentation": "Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.isA/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/Object.isA/param/1" } ], "returns": [ "@roblox/globaltype/Object.isA/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object#isA", "code_sample": "" }, "@roblox/globaltype/Object.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Object.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Object.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Object.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Object.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Object.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Object.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Object.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Object.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Object.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Object.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Object.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Object.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Object.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Object.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Object.Changed": { "documentation": "Fires immediately after a property of the object changes, with some limitations.", "keys": { "Connect": "@roblox/globaltype/Object.Changed.Connect", "ConnectParallel": "@roblox/globaltype/Object.Changed.ConnectParallel", "Once": "@roblox/globaltype/Object.Changed.Once", "Wait": "@roblox/globaltype/Object.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Object#Changed", "code_sample": "-- Demonstrate the Changed event by creating a Part\nlocal part = Instance.new(\"Part\")\npart.Changed:Connect(print)\n-- This fires Changed with \"Transparency\"\npart.Transparency = 0.5\n-- Similarly, this fires Changed with \"Number\"\npart.Name = \"SomePart\"\n-- Since changing BrickColor will also change other\n-- properties at the same time, this line fires Changed\n-- with \"BrickColor\", \"Color3\" and \"Color3uint16\".\npart.BrickColor = BrickColor.Red()\n\n-- A NumberValue holds a double-precision floating-point number\nlocal vNumber = Instance.new(\"NumberValue\")\nvNumber.Changed:Connect(print)\n-- This fires Changed with 123.456 (not \"Value\")\nvNumber.Value = 123.456\n-- This does not fire Changed\nvNumber.Name = \"SomeNumber\"\n\n-- A StringValue stores one string\nlocal vString = Instance.new(\"StringValue\")\nvString.Changed:Connect(print)\n-- This fires Changed with \"Hello\" (not \"Value\")\nvString.Value = \"Hello\"" }, "@roblox/globaltype/PlayerViewService": { "documentation": "Provides a way to get additional information about a player's view.", "keys": { "GetDeviceCameraCFrame": "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerViewService", "code_sample": "" }, "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame/param/0": { "documentation": "Provides a way to get additional information about a player's view." }, "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame/param/1": { "documentation": "The player for which to get the device camera CFrame." }, "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame/return/0": { "documentation": "The world space CFrame looking at the player's character, or a CFrame.identity (see description)." }, "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame": { "documentation": "Returns a world space CFrame looking at the player's character.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame/param/1" } ], "returns": [ "@roblox/globaltype/PlayerViewService.GetDeviceCameraCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlayerViewService#GetDeviceCameraCFrame", "code_sample": "local PlayerViewService = game:GetService(\"PlayerViewService\")\nlocal RunService = game:GetService(\"RunService\")\nlocal Workspace = game:GetService(\"Workspace\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal camera = Workspace.CurrentCamera\n\nlocal function updatePictureInPictureCamera()\n\tcamera.CFrame = PlayerViewService:GetDeviceCameraCFrame(player)\nend\n\nRunService:BindToRenderStep(\n\t\"PictureInPictureCamera\",\n\tEnum.RenderPriority.Camera.Value + 1,\n\tupdatePictureInPictureCamera\n)" }, "@roblox/globaltype/Light": { "documentation": "Light is a root class for dynamic lighting related objects.", "keys": { "Brightness": "@roblox/globaltype/Light.Brightness", "Color": "@roblox/globaltype/Light.Color", "Enabled": "@roblox/globaltype/Light.Enabled", "Shadows": "@roblox/globaltype/Light.Shadows" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Light", "code_sample": "" }, "@roblox/globaltype/Light.Brightness": { "documentation": "Sets how bright the emitted light is, defaults to 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Light#Brightness", "code_sample": "" }, "@roblox/globaltype/Light.Color": { "documentation": "The color of the emitted light.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Light#Color", "code_sample": "" }, "@roblox/globaltype/Light.Enabled": { "documentation": "If set to true, light will be emitted from the source object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Light#Enabled", "code_sample": "" }, "@roblox/globaltype/Light.Shadows": { "documentation": "If set to true, will project shadows if light is blocked by an obstacle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Light#Shadows", "code_sample": "" }, "@roblox/globaltype/BevelMesh": { "documentation": "Deprecated: This object serves no purpose other than being an abstract class that BlockMesh and CylinderMesh inherit from. Note non-character beveled parts were removed in 2013. Developers looking for beveled edges are required to use either UnionOperations or MeshParts.
An abstract class that BlockMesh and CylinderMesh inherit from.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BevelMesh", "code_sample": "" }, "@roblox/globaltype/FaceInstance": { "documentation": "An abstract class from which the Decal and Texture classes inherit.", "keys": { "Face": "@roblox/globaltype/FaceInstance.Face" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceInstance", "code_sample": "" }, "@roblox/globaltype/FaceInstance.Face": { "documentation": "Sets which face of the parent BasePart the object appears on.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceInstance#Face", "code_sample": "" }, "@roblox/globaltype/UniversalConstraint": { "documentation": "Ensures two axes on two bodies remain perpendicular.", "keys": { "LimitsEnabled": "@roblox/globaltype/UniversalConstraint.LimitsEnabled", "MaxAngle": "@roblox/globaltype/UniversalConstraint.MaxAngle", "Radius": "@roblox/globaltype/UniversalConstraint.Radius", "Restitution": "@roblox/globaltype/UniversalConstraint.Restitution" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UniversalConstraint", "code_sample": "" }, "@roblox/globaltype/UniversalConstraint.LimitsEnabled": { "documentation": "Determines whether the angular motion of attachments' primary axes is limited.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UniversalConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/UniversalConstraint.MaxAngle": { "documentation": "The max angle, in degrees, of the constraint's limiting cone.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UniversalConstraint#MaxAngle", "code_sample": "" }, "@roblox/globaltype/UniversalConstraint.Radius": { "documentation": "The constraint's visualization radius.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UniversalConstraint#Radius", "code_sample": "" }, "@roblox/globaltype/UniversalConstraint.Restitution": { "documentation": "The restitution coefficient of the cone constraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UniversalConstraint#Restitution", "code_sample": "" }, "@roblox/globaltype/StudioService": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system.", "keys": { "ActiveScript": "@roblox/globaltype/StudioService.ActiveScript", "DraggerSolveConstraints": "@roblox/globaltype/StudioService.DraggerSolveConstraints", "DrawConstraintsOnTop": "@roblox/globaltype/StudioService.DrawConstraintsOnTop", "GridSize": "@roblox/globaltype/StudioService.GridSize", "RotateIncrement": "@roblox/globaltype/StudioService.RotateIncrement", "Secrets": "@roblox/globaltype/StudioService.Secrets", "ShowConstraintDetails": "@roblox/globaltype/StudioService.ShowConstraintDetails", "ShowWeldDetails": "@roblox/globaltype/StudioService.ShowWeldDetails", "StudioLocaleId": "@roblox/globaltype/StudioService.StudioLocaleId", "UseLocalSpace": "@roblox/globaltype/StudioService.UseLocalSpace", "GetClassIcon": "@roblox/globaltype/StudioService.GetClassIcon", "GetUserId": "@roblox/globaltype/StudioService.GetUserId", "GizmoRaycast": "@roblox/globaltype/StudioService.GizmoRaycast", "PromptImportFileAsync": "@roblox/globaltype/StudioService.PromptImportFileAsync", "PromptImportFile": "@roblox/globaltype/StudioService.PromptImportFile", "PromptImportFilesAsync": "@roblox/globaltype/StudioService.PromptImportFilesAsync", "PromptImportFiles": "@roblox/globaltype/StudioService.PromptImportFiles" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService", "code_sample": "" }, "@roblox/globaltype/StudioService.ActiveScript": { "documentation": "Reflects the LuaSourceContainer currently being edited (if any).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#ActiveScript", "code_sample": "" }, "@roblox/globaltype/StudioService.DraggerSolveConstraints": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#DraggerSolveConstraints", "code_sample": "" }, "@roblox/globaltype/StudioService.DrawConstraintsOnTop": { "documentation": "Deprecated: This property is deprecated; constraints can no longer be drawn \"on top\" of other objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#DrawConstraintsOnTop", "code_sample": "" }, "@roblox/globaltype/StudioService.GridSize": { "documentation": "Determines the distance in studs by which Studio's drag and move tools move objects each tick.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#GridSize", "code_sample": "" }, "@roblox/globaltype/StudioService.RotateIncrement": { "documentation": "Determines the degrees by which Studio's rotation tool will rotate selected objects each tick.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#RotateIncrement", "code_sample": "" }, "@roblox/globaltype/StudioService.Secrets": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#Secrets", "code_sample": "" }, "@roblox/globaltype/StudioService.ShowConstraintDetails": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#ShowConstraintDetails", "code_sample": "" }, "@roblox/globaltype/StudioService.ShowWeldDetails": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#ShowWeldDetails", "code_sample": "" }, "@roblox/globaltype/StudioService.StudioLocaleId": { "documentation": "The locale currently in-use by Studio, e.g. en_US.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#StudioLocaleId", "code_sample": "" }, "@roblox/globaltype/StudioService.UseLocalSpace": { "documentation": "Determines whether Studio tools will use local space of an object or global space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#UseLocalSpace", "code_sample": "" }, "@roblox/globaltype/StudioService.GetClassIcon/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.GetClassIcon/param/1": { "documentation": "" }, "@roblox/globaltype/StudioService.GetClassIcon/return/0": { "documentation": "" }, "@roblox/globaltype/StudioService.GetClassIcon": { "documentation": "Provides a dictionary that allows the display of a class' Explorer window icon.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.GetClassIcon/param/0" }, { "name": "className", "documentation": "@roblox/globaltype/StudioService.GetClassIcon/param/1" } ], "returns": [ "@roblox/globaltype/StudioService.GetClassIcon/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#GetClassIcon", "code_sample": "" }, "@roblox/globaltype/StudioService.GetUserId/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.GetUserId/return/0": { "documentation": "" }, "@roblox/globaltype/StudioService.GetUserId": { "documentation": "Returns the Studio user's userId if they're logged in, otherwise returns 0.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.GetUserId/param/0" } ], "returns": [ "@roblox/globaltype/StudioService.GetUserId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#GetUserId", "code_sample": "-- Can only be used in a plugin\nlocal StudioService = game:GetService(\"StudioService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal loggedInUserId = StudioService:GetUserId()\nlocal loggedInUserName = Players:GetNameFromUserIdAsync(loggedInUserId)\nprint(\"Hello,\", loggedInUserName)" }, "@roblox/globaltype/StudioService.GizmoRaycast/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.GizmoRaycast/param/1": { "documentation": "" }, "@roblox/globaltype/StudioService.GizmoRaycast/param/2": { "documentation": "" }, "@roblox/globaltype/StudioService.GizmoRaycast/param/3": { "documentation": "" }, "@roblox/globaltype/StudioService.GizmoRaycast/return/0": { "documentation": "" }, "@roblox/globaltype/StudioService.GizmoRaycast": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.GizmoRaycast/param/0" }, { "name": "origin", "documentation": "@roblox/globaltype/StudioService.GizmoRaycast/param/1" }, { "name": "direction", "documentation": "@roblox/globaltype/StudioService.GizmoRaycast/param/2" }, { "name": "raycastParams", "documentation": "@roblox/globaltype/StudioService.GizmoRaycast/param/3" } ], "returns": [ "@roblox/globaltype/StudioService.GizmoRaycast/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#GizmoRaycast", "code_sample": "" }, "@roblox/globaltype/StudioService.PromptImportFileAsync/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.PromptImportFileAsync/param/1": { "documentation": "A list of file types that the user is allowed to select. File types are formatted without a period. For example, {\"jpg\", \"png\"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is nil and allows the user to select any file type." }, "@roblox/globaltype/StudioService.PromptImportFileAsync/return/0": { "documentation": "The imported File. Returns nil if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes)." }, "@roblox/globaltype/StudioService.PromptImportFileAsync": { "documentation": "Prompts the current Studio user to select one file to add as a File.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.PromptImportFileAsync/param/0" }, { "name": "fileTypeFilter", "documentation": "@roblox/globaltype/StudioService.PromptImportFileAsync/param/1" } ], "returns": [ "@roblox/globaltype/StudioService.PromptImportFileAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFileAsync", "code_sample": "" }, "@roblox/globaltype/StudioService.PromptImportFile/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.PromptImportFile/param/1": { "documentation": "A list of file types that the user is allowed to select. File types are formatted without a period. For example, {\"jpg\", \"png\"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is nil and allows the user to select any file type." }, "@roblox/globaltype/StudioService.PromptImportFile/return/0": { "documentation": "The imported File. Returns nil if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes)." }, "@roblox/globaltype/StudioService.PromptImportFile": { "documentation": "Deprecated:
Prompts the current Studio user to select one file to add as a File.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.PromptImportFile/param/0" }, { "name": "fileTypeFilter", "documentation": "@roblox/globaltype/StudioService.PromptImportFile/param/1" } ], "returns": [ "@roblox/globaltype/StudioService.PromptImportFile/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFile", "code_sample": "" }, "@roblox/globaltype/StudioService.PromptImportFilesAsync/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.PromptImportFilesAsync/param/1": { "documentation": "A list of file types that the user is allowed to select. File types are formatted without a period. For example, {\"jpg\", \"png\"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is nil and allows the user to select any file type." }, "@roblox/globaltype/StudioService.PromptImportFilesAsync/return/0": { "documentation": "The imported Files. Returns an empty list if no files were selected. Returns nil if the user selected one or more files that were too large (FileSize greater than 100 megabytes)." }, "@roblox/globaltype/StudioService.PromptImportFilesAsync": { "documentation": "Prompts the current Studio user to select files to add as Files.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.PromptImportFilesAsync/param/0" }, { "name": "fileTypeFilter", "documentation": "@roblox/globaltype/StudioService.PromptImportFilesAsync/param/1" } ], "returns": [ "@roblox/globaltype/StudioService.PromptImportFilesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFilesAsync", "code_sample": "" }, "@roblox/globaltype/StudioService.PromptImportFiles/param/0": { "documentation": "Provides access to configuration of Roblox Studio and allows importing files from the user's file system." }, "@roblox/globaltype/StudioService.PromptImportFiles/param/1": { "documentation": "A list of file types that the user is allowed to select. File types are formatted without a period. For example, {\"jpg\", \"png\"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is nil and allows the user to select any file type." }, "@roblox/globaltype/StudioService.PromptImportFiles/return/0": { "documentation": "The imported Files. Returns an empty list if no files were selected. Returns nil if the user selected one or more files that were too large (FileSize greater than 100 megabytes)." }, "@roblox/globaltype/StudioService.PromptImportFiles": { "documentation": "Deprecated:
Prompts the current Studio user to select files to add as Files.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StudioService.PromptImportFiles/param/0" }, { "name": "fileTypeFilter", "documentation": "@roblox/globaltype/StudioService.PromptImportFiles/param/1" } ], "returns": [ "@roblox/globaltype/StudioService.PromptImportFiles/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StudioService#PromptImportFiles", "code_sample": "" }, "@roblox/globaltype/TextChatMessageProperties": { "documentation": "Overrides TextChatMessage properties when returned by callbacks defined in TextChatService.OnIncomingMessage or TextChannel.OnIncomingMessage.", "keys": { "PrefixText": "@roblox/globaltype/TextChatMessageProperties.PrefixText", "Text": "@roblox/globaltype/TextChatMessageProperties.Text", "Translation": "@roblox/globaltype/TextChatMessageProperties.Translation" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessageProperties", "code_sample": "" }, "@roblox/globaltype/TextChatMessageProperties.PrefixText": { "documentation": "The TextChatMessage.PrefixText to override.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessageProperties#PrefixText", "code_sample": "" }, "@roblox/globaltype/TextChatMessageProperties.Text": { "documentation": "The TextChatMessage.Text to override.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessageProperties#Text", "code_sample": "" }, "@roblox/globaltype/TextChatMessageProperties.Translation": { "documentation": "The TextChatMessage.Translation to override.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatMessageProperties#Translation", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput": { "documentation": "Produces audio streams from physical devices, such as microphones.", "keys": { "AccessType": "@roblox/globaltype/AudioDeviceInput.AccessType", "Active": "@roblox/globaltype/AudioDeviceInput.Active", "IsReady": "@roblox/globaltype/AudioDeviceInput.IsReady", "Muted": "@roblox/globaltype/AudioDeviceInput.Muted", "MutedByLocalUser": "@roblox/globaltype/AudioDeviceInput.MutedByLocalUser", "Player": "@roblox/globaltype/AudioDeviceInput.Player", "Volume": "@roblox/globaltype/AudioDeviceInput.Volume", "GetConnectedWires": "@roblox/globaltype/AudioDeviceInput.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioDeviceInput.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioDeviceInput.GetOutputPins", "GetUserIdAccessList": "@roblox/globaltype/AudioDeviceInput.GetUserIdAccessList", "SetUserIdAccessList": "@roblox/globaltype/AudioDeviceInput.SetUserIdAccessList" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.AccessType": { "documentation": "Determines whether the list of user IDs provided to SetUserIdAccessList is treated as an allow-list or deny-list.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#AccessType", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.Active": { "documentation": "Controls whether the physical device is actively recording.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#Active", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.IsReady": { "documentation": "Denotes whether this AudioDeviceInput is ready to produce sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#IsReady", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.Muted": { "documentation": "Controls whether this AudioDeviceInput is muted.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#Muted", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.MutedByLocalUser": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#MutedByLocalUser", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.Player": { "documentation": "Determines whose device is producing sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#Player", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.Volume": { "documentation": "Volume level which is multiplied onto the output audio stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#Volume", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.GetConnectedWires/param/0": { "documentation": "Produces audio streams from physical devices, such as microphones." }, "@roblox/globaltype/AudioDeviceInput.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioDeviceInput.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioDeviceInput.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.GetInputPins/param/0": { "documentation": "Produces audio streams from physical devices, such as microphones." }, "@roblox/globaltype/AudioDeviceInput.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioDeviceInput.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.GetOutputPins/param/0": { "documentation": "Produces audio streams from physical devices, such as microphones." }, "@roblox/globaltype/AudioDeviceInput.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioDeviceInput.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.GetUserIdAccessList/param/0": { "documentation": "Produces audio streams from physical devices, such as microphones." }, "@roblox/globaltype/AudioDeviceInput.GetUserIdAccessList/return/0": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.GetUserIdAccessList": { "documentation": "Returns a list of user IDs that are either permitted to hear or blocked from hearing this AudioDeviceInput.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.GetUserIdAccessList/param/0" } ], "returns": [ "@roblox/globaltype/AudioDeviceInput.GetUserIdAccessList/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetUserIdAccessList", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.SetUserIdAccessList/param/0": { "documentation": "Produces audio streams from physical devices, such as microphones." }, "@roblox/globaltype/AudioDeviceInput.SetUserIdAccessList/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.SetUserIdAccessList": { "documentation": "Sets a list of user IDs that are either permitted to hear or blocked from hearing this AudioDeviceInput.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.SetUserIdAccessList/param/0" }, { "name": "userIds", "documentation": "@roblox/globaltype/AudioDeviceInput.SetUserIdAccessList/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#SetUserIdAccessList", "code_sample": "" }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioDeviceInput.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioDeviceInput.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioDeviceInput via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioDeviceInput.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioDeviceInput.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#WiringChanged", "code_sample": "" }, "@roblox/globaltype/DataStorePages": { "documentation": "A Pages object that allows iteration through OrderedDataStore key/value pairs.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStorePages", "code_sample": "" }, "@roblox/globaltype/Dialog": { "documentation": "Creates NPC billboard-style dialog bubbles.", "keys": { "BehaviorType": "@roblox/globaltype/Dialog.BehaviorType", "ConversationDistance": "@roblox/globaltype/Dialog.ConversationDistance", "GoodbyeChoiceActive": "@roblox/globaltype/Dialog.GoodbyeChoiceActive", "GoodbyeDialog": "@roblox/globaltype/Dialog.GoodbyeDialog", "InitialPrompt": "@roblox/globaltype/Dialog.InitialPrompt", "InUse": "@roblox/globaltype/Dialog.InUse", "Purpose": "@roblox/globaltype/Dialog.Purpose", "Tone": "@roblox/globaltype/Dialog.Tone", "TriggerDistance": "@roblox/globaltype/Dialog.TriggerDistance", "TriggerOffset": "@roblox/globaltype/Dialog.TriggerOffset", "GetCurrentPlayers": "@roblox/globaltype/Dialog.GetCurrentPlayers" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog", "code_sample": "" }, "@roblox/globaltype/Dialog.BehaviorType": { "documentation": "Sets whether the Dialog can be used by multiple players at once.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#BehaviorType", "code_sample": "" }, "@roblox/globaltype/Dialog.ConversationDistance": { "documentation": "The furthest distance that a player can be from the Dialog's parent to start a conversation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#ConversationDistance", "code_sample": "" }, "@roblox/globaltype/Dialog.GoodbyeChoiceActive": { "documentation": "Toggles whether the goodbye option will be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#GoodbyeChoiceActive", "code_sample": "" }, "@roblox/globaltype/Dialog.GoodbyeDialog": { "documentation": "Sets the sentence that the dialog will show to the player when the chat ends.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#GoodbyeDialog", "code_sample": "" }, "@roblox/globaltype/Dialog.InitialPrompt": { "documentation": "Sets the first sentence that the dialog will show to the player, once a chat is commenced.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#InitialPrompt", "code_sample": "" }, "@roblox/globaltype/Dialog.InUse": { "documentation": "If true, this dialog is being used by at least one player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#InUse", "code_sample": "" }, "@roblox/globaltype/Dialog.Purpose": { "documentation": "Sets the icon that the initial dialog displays.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#Purpose", "code_sample": "" }, "@roblox/globaltype/Dialog.Tone": { "documentation": "Sets the color of the NPC's speech bubble.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#Tone", "code_sample": "" }, "@roblox/globaltype/Dialog.TriggerDistance": { "documentation": "Sets the maximum distance that a dialog can be triggered from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#TriggerDistance", "code_sample": "" }, "@roblox/globaltype/Dialog.TriggerOffset": { "documentation": "Sets the offset of the dialog relative to the dialog's parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#TriggerOffset", "code_sample": "" }, "@roblox/globaltype/Dialog.GetCurrentPlayers/param/0": { "documentation": "Creates NPC billboard-style dialog bubbles." }, "@roblox/globaltype/Dialog.GetCurrentPlayers/return/0": { "documentation": "" }, "@roblox/globaltype/Dialog.GetCurrentPlayers": { "documentation": "Returns a list of players currently using the Dialog.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dialog.GetCurrentPlayers/param/0" } ], "returns": [ "@roblox/globaltype/Dialog.GetCurrentPlayers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#GetCurrentPlayers", "code_sample": "local dialog = script.Parent\n\nlocal function onChoiceSelected(_player, _choice)\n\tlocal currentPlayers = dialog:GetCurrentPlayers()\n\tprint(\"The current players in the dialog:\")\n\tfor _, player in ipairs(currentPlayers) do\n\t\tprint(player)\n\tend\nend\n\ndialog.DialogChoiceSelected:Connect(onChoiceSelected)" }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Dialog.DialogChoiceSelected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Dialog.DialogChoiceSelected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Dialog.DialogChoiceSelected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Dialog.DialogChoiceSelected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Dialog.DialogChoiceSelected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Dialog.DialogChoiceSelected": { "documentation": "Fired when a player chooses something to say, through a Dialog instance.", "keys": { "Connect": "@roblox/globaltype/Dialog.DialogChoiceSelected.Connect", "ConnectParallel": "@roblox/globaltype/Dialog.DialogChoiceSelected.ConnectParallel", "Once": "@roblox/globaltype/Dialog.DialogChoiceSelected.Once", "Wait": "@roblox/globaltype/Dialog.DialogChoiceSelected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Dialog#DialogChoiceSelected", "code_sample": "" }, "@roblox/globaltype/LocalizationService": { "documentation": "Handles automated translation.", "keys": { "RobloxLocaleId": "@roblox/globaltype/LocalizationService.RobloxLocaleId", "SystemLocaleId": "@roblox/globaltype/LocalizationService.SystemLocaleId", "GetCorescriptLocalizations": "@roblox/globaltype/LocalizationService.GetCorescriptLocalizations", "GetCountryRegionForPlayerAsync": "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync", "GetTableEntries": "@roblox/globaltype/LocalizationService.GetTableEntries", "GetTranslatorForLocaleAsync": "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync", "GetTranslatorForPlayer": "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer", "GetTranslatorForPlayerAsync": "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService", "code_sample": "" }, "@roblox/globaltype/LocalizationService.RobloxLocaleId": { "documentation": "The locale ID used for localizing core and internal features.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#RobloxLocaleId", "code_sample": "" }, "@roblox/globaltype/LocalizationService.SystemLocaleId": { "documentation": "The locale ID that the local player has set for their operating system.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#SystemLocaleId", "code_sample": "" }, "@roblox/globaltype/LocalizationService.GetCorescriptLocalizations/param/0": { "documentation": "Handles automated translation." }, "@roblox/globaltype/LocalizationService.GetCorescriptLocalizations/return/0": { "documentation": "" }, "@roblox/globaltype/LocalizationService.GetCorescriptLocalizations": { "documentation": "Returns a list of LocalizationTable objects used for localizing core scripts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationService.GetCorescriptLocalizations/param/0" } ], "returns": [ "@roblox/globaltype/LocalizationService.GetCorescriptLocalizations/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetCorescriptLocalizations", "code_sample": "" }, "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync/param/0": { "documentation": "Handles automated translation." }, "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync/param/1": { "documentation": "The player that you are getting country/region information for." }, "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync/return/0": { "documentation": "A string indicating the country/region code of a player." }, "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync": { "documentation": "Returns country/region code string according to player's client IP geolocation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync/param/1" } ], "returns": [ "@roblox/globaltype/LocalizationService.GetCountryRegionForPlayerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetCountryRegionForPlayerAsync", "code_sample": "" }, "@roblox/globaltype/LocalizationService.GetTableEntries/param/0": { "documentation": "Handles automated translation." }, "@roblox/globaltype/LocalizationService.GetTableEntries/param/1": { "documentation": "" }, "@roblox/globaltype/LocalizationService.GetTableEntries/return/0": { "documentation": "An array of arrays, where each array is in the same format as described in LocalizationTable:GetEntries()." }, "@roblox/globaltype/LocalizationService.GetTableEntries": { "documentation": "Gets all entries used for automated localization.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationService.GetTableEntries/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/LocalizationService.GetTableEntries/param/1" } ], "returns": [ "@roblox/globaltype/LocalizationService.GetTableEntries/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetTableEntries", "code_sample": "" }, "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync/param/0": { "documentation": "Handles automated translation." }, "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync/param/1": { "documentation": "A Roblox supported language or locale code." }, "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync/return/0": { "documentation": "The Translator instance for the specified locale." }, "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync": { "documentation": "Yields until the cloud LocalizationTable for the argument locale has been loaded - if available. Returns a Translator instance to be used for translations for the provided locale.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync/param/0" }, { "name": "locale", "documentation": "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync/param/1" } ], "returns": [ "@roblox/globaltype/LocalizationService.GetTranslatorForLocaleAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetTranslatorForLocaleAsync", "code_sample": "local LocalizationService = game:GetService(\"LocalizationService\")\n\nlocal textLabel = script.Parent\n\nlocal success, translator = pcall(function()\n\treturn LocalizationService:GetTranslatorForLocaleAsync(\"fr\")\nend)\n\nif success then\n\tlocal result = translator:Translate(textLabel, \"Hello World!\")\n\tprint(\"Hello in French: \" .. result)\nelse\n\tprint(\"GetTranslatorForLocaleAsync failed: \" .. translator)\nend" }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer/param/0": { "documentation": "Handles automated translation." }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer/param/1": { "documentation": "The Player that you are getting the Translator for." }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer/return/0": { "documentation": "The Translator instance for the specified locale." }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer": { "documentation": "Returns a Translator to be used for translations using the locale data loaded.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer/param/1" } ], "returns": [ "@roblox/globaltype/LocalizationService.GetTranslatorForPlayer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetTranslatorForPlayer", "code_sample": "local LocalizationService = game:GetService(\"LocalizationService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal textLabel = script.Parent\n\nlocal success, translator = pcall(function()\n\treturn LocalizationService:GetTranslatorForPlayerAsync(Players.LocalPlayer)\nend)\n\nif success then\n\tlocal result = translator:Translate(textLabel, \"Hello World!\")\n\tprint(result)\nelse\n\tprint(\"GetTranslatorForPlayerAsync failed: \" .. translator)\nend" }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync/param/0": { "documentation": "Handles automated translation." }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync/param/1": { "documentation": "The Player that you are getting the Translator for." }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync/return/0": { "documentation": "The Translator instance for the specified locale." }, "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync": { "documentation": "Yields until the cloud LocalizationTable for the player's locale has been loaded - if available. Returns a Translator instance to be used for translations for the provided locale.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync/param/1" } ], "returns": [ "@roblox/globaltype/LocalizationService.GetTranslatorForPlayerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LocalizationService#GetTranslatorForPlayerAsync", "code_sample": "local LocalizationService = game:GetService(\"LocalizationService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal textLabel = script.Parent\n\nlocal success, translator = pcall(function()\n\treturn LocalizationService:GetTranslatorForPlayerAsync(Players.LocalPlayer)\nend)\n\nif success then\n\tlocal result = translator:Translate(textLabel, \"Hello World!\")\n\tprint(result)\nelse\n\tprint(\"GetTranslatorForPlayerAsync failed: \" .. translator)\nend" }, "@roblox/globaltype/StartupMessageService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StartupMessageService", "code_sample": "" }, "@roblox/globaltype/UserInputService": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events.", "keys": { "AccelerometerEnabled": "@roblox/globaltype/UserInputService.AccelerometerEnabled", "GamepadEnabled": "@roblox/globaltype/UserInputService.GamepadEnabled", "GyroscopeEnabled": "@roblox/globaltype/UserInputService.GyroscopeEnabled", "KeyboardEnabled": "@roblox/globaltype/UserInputService.KeyboardEnabled", "ModalEnabled": "@roblox/globaltype/UserInputService.ModalEnabled", "MouseBehavior": "@roblox/globaltype/UserInputService.MouseBehavior", "MouseDeltaSensitivity": "@roblox/globaltype/UserInputService.MouseDeltaSensitivity", "MouseEnabled": "@roblox/globaltype/UserInputService.MouseEnabled", "MouseIcon": "@roblox/globaltype/UserInputService.MouseIcon", "MouseIconContent": "@roblox/globaltype/UserInputService.MouseIconContent", "MouseIconEnabled": "@roblox/globaltype/UserInputService.MouseIconEnabled", "OnScreenKeyboardPosition": "@roblox/globaltype/UserInputService.OnScreenKeyboardPosition", "OnScreenKeyboardSize": "@roblox/globaltype/UserInputService.OnScreenKeyboardSize", "OnScreenKeyboardVisible": "@roblox/globaltype/UserInputService.OnScreenKeyboardVisible", "PreferredInput": "@roblox/globaltype/UserInputService.PreferredInput", "TouchEnabled": "@roblox/globaltype/UserInputService.TouchEnabled", "TouchScreenEnabled": "@roblox/globaltype/UserInputService.TouchScreenEnabled", "UserHeadCFrame": "@roblox/globaltype/UserInputService.UserHeadCFrame", "VREnabled": "@roblox/globaltype/UserInputService.VREnabled", "GamepadSupports": "@roblox/globaltype/UserInputService.GamepadSupports", "GetConnectedGamepads": "@roblox/globaltype/UserInputService.GetConnectedGamepads", "GetDeviceAcceleration": "@roblox/globaltype/UserInputService.GetDeviceAcceleration", "GetDeviceGravity": "@roblox/globaltype/UserInputService.GetDeviceGravity", "GetDeviceRotation": "@roblox/globaltype/UserInputService.GetDeviceRotation", "GetFocusedTextBox": "@roblox/globaltype/UserInputService.GetFocusedTextBox", "GetGamepadConnected": "@roblox/globaltype/UserInputService.GetGamepadConnected", "GetGamepadState": "@roblox/globaltype/UserInputService.GetGamepadState", "GetImageForKeyCode": "@roblox/globaltype/UserInputService.GetImageForKeyCode", "GetKeysPressed": "@roblox/globaltype/UserInputService.GetKeysPressed", "GetLastInputType": "@roblox/globaltype/UserInputService.GetLastInputType", "GetMouseButtonsPressed": "@roblox/globaltype/UserInputService.GetMouseButtonsPressed", "GetMouseDelta": "@roblox/globaltype/UserInputService.GetMouseDelta", "GetMouseLocation": "@roblox/globaltype/UserInputService.GetMouseLocation", "GetNavigationGamepads": "@roblox/globaltype/UserInputService.GetNavigationGamepads", "GetStringForKeyCode": "@roblox/globaltype/UserInputService.GetStringForKeyCode", "GetSupportedGamepadKeyCodes": "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes", "GetUserCFrame": "@roblox/globaltype/UserInputService.GetUserCFrame", "IsGamepadButtonDown": "@roblox/globaltype/UserInputService.IsGamepadButtonDown", "IsKeyDown": "@roblox/globaltype/UserInputService.IsKeyDown", "IsMouseButtonPressed": "@roblox/globaltype/UserInputService.IsMouseButtonPressed", "IsNavigationGamepad": "@roblox/globaltype/UserInputService.IsNavigationGamepad", "RecenterUserHeadCFrame": "@roblox/globaltype/UserInputService.RecenterUserHeadCFrame", "SetNavigationGamepad": "@roblox/globaltype/UserInputService.SetNavigationGamepad" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService", "code_sample": "" }, "@roblox/globaltype/UserInputService.AccelerometerEnabled": { "documentation": "Describes whether the user's device has an accelerometer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#AccelerometerEnabled", "code_sample": "local Workspace = game:GetService(\"Workspace\")\nlocal UserInputService = game:GetService(\"UserInputService\")\n\nlocal ball = script.Parent:WaitForChild(\"Ball\")\nlocal mass = ball:GetMass()\nlocal gravityForce = ball:WaitForChild(\"GravityForce\")\n\nlocal function moveBall(gravity)\n\tgravityForce.Force = gravity.Position * Workspace.Gravity * mass\nend\n\nif UserInputService.AccelerometerEnabled then\n\tUserInputService.DeviceGravityChanged:Connect(moveBall)\nend" }, "@roblox/globaltype/UserInputService.GamepadEnabled": { "documentation": "Describes whether the user's device has an available gamepad.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.GyroscopeEnabled": { "documentation": "Describes whether the user's device has a gyroscope.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GyroscopeEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.KeyboardEnabled": { "documentation": "Describes whether the user's device has a keyboard available.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#KeyboardEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.ModalEnabled": { "documentation": "Deprecated: This item has been superseded by GuiService.TouchControlsEnabled which should be used in all new work.
Toggles whether Roblox's mobile controls are hidden on mobile devices.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#ModalEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.MouseBehavior": { "documentation": "Determines whether the user's mouse can be moved freely or is locked.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseBehavior", "code_sample": "" }, "@roblox/globaltype/UserInputService.MouseDeltaSensitivity": { "documentation": "Scales the delta (change) output of the user's Mouse.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseDeltaSensitivity", "code_sample": "" }, "@roblox/globaltype/UserInputService.MouseEnabled": { "documentation": "Describes whether the user's device has a mouse available.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.MouseIcon": { "documentation": "The content ID of the image for the user's mouse icon.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIcon", "code_sample": "" }, "@roblox/globaltype/UserInputService.MouseIconContent": { "documentation": "The content ID of the image for the user's mouse icon. Only supports asset URIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIconContent", "code_sample": "" }, "@roblox/globaltype/UserInputService.MouseIconEnabled": { "documentation": "Determines whether the mouse icon is visible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIconEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.OnScreenKeyboardPosition": { "documentation": "Determines the position of the on-screen keyboard.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#OnScreenKeyboardPosition", "code_sample": "" }, "@roblox/globaltype/UserInputService.OnScreenKeyboardSize": { "documentation": "Determines the size of the on-screen keyboard.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#OnScreenKeyboardSize", "code_sample": "" }, "@roblox/globaltype/UserInputService.OnScreenKeyboardVisible": { "documentation": "Describes whether an on-screen keyboard is currently visible on the user's screen.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#OnScreenKeyboardVisible", "code_sample": "" }, "@roblox/globaltype/UserInputService.PreferredInput": { "documentation": "Queries the primary input type a player is using, based on anticipated user behavior.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#PreferredInput", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchEnabled": { "documentation": "Describes whether the user's device has a touch screen available.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchScreenEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchScreenEnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.UserHeadCFrame": { "documentation": "Deprecated: This item has been superseded by UserInputService:GetUserCFrame() which should be used in all new work.
Describes the orientation and position of a user's head, if they are actively using a virtual reality headset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#UserHeadCFrame", "code_sample": "" }, "@roblox/globaltype/UserInputService.VREnabled": { "documentation": "Indicates whether the user is using a virtual reality headset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#VREnabled", "code_sample": "" }, "@roblox/globaltype/UserInputService.GamepadSupports/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GamepadSupports/param/1": { "documentation": "The UserInputType of the gamepad." }, "@roblox/globaltype/UserInputService.GamepadSupports/param/2": { "documentation": "The KeyCode of the button in question." }, "@roblox/globaltype/UserInputService.GamepadSupports/return/0": { "documentation": "Whether the given gamepad supports a button corresponding with the given KeyCode." }, "@roblox/globaltype/UserInputService.GamepadSupports": { "documentation": "Returns whether the given UserInputType gamepad supports a button corresponding with the given KeyCode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadSupports/param/0" }, { "name": "gamepadNum", "documentation": "@roblox/globaltype/UserInputService.GamepadSupports/param/1" }, { "name": "gamepadKeyCode", "documentation": "@roblox/globaltype/UserInputService.GamepadSupports/param/2" } ], "returns": [ "@roblox/globaltype/UserInputService.GamepadSupports/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadSupports", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetConnectedGamepads/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetConnectedGamepads/return/0": { "documentation": "An array of UserInputTypes corresponding with the gamepads connected to the user's device." }, "@roblox/globaltype/UserInputService.GetConnectedGamepads": { "documentation": "Returns an array of UserInputType gamepads currently connected.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetConnectedGamepads/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetConnectedGamepads/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetConnectedGamepads", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetDeviceAcceleration/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetDeviceAcceleration/return/0": { "documentation": "" }, "@roblox/globaltype/UserInputService.GetDeviceAcceleration": { "documentation": "Returns an InputObject that describes the device's current acceleration.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetDeviceAcceleration/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetDeviceAcceleration/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceAcceleration", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetDeviceGravity/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetDeviceGravity/return/0": { "documentation": "" }, "@roblox/globaltype/UserInputService.GetDeviceGravity": { "documentation": "Returns an InputObject describing the device's current gravity vector.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetDeviceGravity/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetDeviceGravity/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceGravity", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetDeviceRotation/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetDeviceRotation/return/0": { "documentation": "A tuple containing two properties: The delta describing the amount of rotation that last happened, and the CFrame of the device's current rotation relative to its default reference frame." }, "@roblox/globaltype/UserInputService.GetDeviceRotation": { "documentation": "Returns an InputObject and a CFrame describing the device's current rotation vector.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetDeviceRotation/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetDeviceRotation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetDeviceRotation", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetFocusedTextBox/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetFocusedTextBox/return/0": { "documentation": "" }, "@roblox/globaltype/UserInputService.GetFocusedTextBox": { "documentation": "Returns the TextBox the client is currently focused on.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetFocusedTextBox/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetFocusedTextBox/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetFocusedTextBox", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetGamepadConnected/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetGamepadConnected/param/1": { "documentation": "The UserInputType of the gamepad in question." }, "@roblox/globaltype/UserInputService.GetGamepadConnected/return/0": { "documentation": "Whether a gamepad associated with UserInputType is connected." }, "@roblox/globaltype/UserInputService.GetGamepadConnected": { "documentation": "Returns whether a gamepad with the given UserInputType is connected.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetGamepadConnected/param/0" }, { "name": "gamepadNum", "documentation": "@roblox/globaltype/UserInputService.GetGamepadConnected/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.GetGamepadConnected/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadConnected", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetGamepadState/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetGamepadState/param/1": { "documentation": "The UserInputType corresponding with the gamepad in question." }, "@roblox/globaltype/UserInputService.GetGamepadState/return/0": { "documentation": "An array of InputObjects representing the current state of all available inputs for the given gamepad." }, "@roblox/globaltype/UserInputService.GetGamepadState": { "documentation": "Returns an array of InputObjects for all available inputs on the given gamepad, representing each input's last input state.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetGamepadState/param/0" }, { "name": "gamepadNum", "documentation": "@roblox/globaltype/UserInputService.GetGamepadState/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.GetGamepadState/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetGamepadState", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetImageForKeyCode/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetImageForKeyCode/param/1": { "documentation": "The KeyCode for which to fetch the associated image." }, "@roblox/globaltype/UserInputService.GetImageForKeyCode/return/0": { "documentation": "The returned image asset ID." }, "@roblox/globaltype/UserInputService.GetImageForKeyCode": { "documentation": "Returns an image for the requested KeyCode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetImageForKeyCode/param/0" }, { "name": "keyCode", "documentation": "@roblox/globaltype/UserInputService.GetImageForKeyCode/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.GetImageForKeyCode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetImageForKeyCode", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\n\nlocal imageLabel = script.Parent\nlocal key = Enum.KeyCode.ButtonA\n\nlocal mappedIconImage = UserInputService:GetImageForKeyCode(key)\nimageLabel.Image = mappedIconImage" }, "@roblox/globaltype/UserInputService.GetKeysPressed/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetKeysPressed/return/0": { "documentation": "An array of InputObjects associated with the keys currently being pressed." }, "@roblox/globaltype/UserInputService.GetKeysPressed": { "documentation": "Returns an array of InputObjects associated with the keys currently being pressed down.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetKeysPressed/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetKeysPressed/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetKeysPressed", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetLastInputType/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetLastInputType/return/0": { "documentation": "The UserInputType associated with the user's most recent input." }, "@roblox/globaltype/UserInputService.GetLastInputType": { "documentation": "Returns the UserInputType associated with the user's most recent input.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetLastInputType/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetLastInputType/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetLastInputType", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\n\nif UserInputService:GetLastInputType() == Enum.UserInputType.Keyboard then\n\tprint(\"Most recent input was keyboard!\")\nend" }, "@roblox/globaltype/UserInputService.GetMouseButtonsPressed/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetMouseButtonsPressed/return/0": { "documentation": "An array of InputObjects corresponding to the mouse buttons currently being currently held down." }, "@roblox/globaltype/UserInputService.GetMouseButtonsPressed": { "documentation": "Returns an array of InputObjects associated with the mouse buttons currently being held down.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetMouseButtonsPressed/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetMouseButtonsPressed/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseButtonsPressed", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\n\nUserInputService.InputBegan:Connect(function(input, gameProcessedEvent)\n\t-- Return an array of the pressed mouse buttons\n\tlocal buttonsPressed = UserInputService:GetMouseButtonsPressed()\n\n\tlocal m1, m2 = false, false\n\tfor _, button in buttonsPressed do\n\t\tif button.UserInputType == Enum.UserInputType.MouseButton1 then\n\t\t\tprint(\"MouseButton1 pressed!\")\n\t\t\tm1 = true\n\t\tend\n\n\t\tif button.UserInputType == Enum.UserInputType.MouseButton2 then\n\t\t\tprint(\"MouseButton2 pressed!\")\n\t\t\tm2 = true\n\t\tend\n\n\t\tif m1 and m2 then\n\t\t\tprint(\"Both mouse buttons pressed!\")\n\t\tend\n\tend\nend)" }, "@roblox/globaltype/UserInputService.GetMouseDelta/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetMouseDelta/return/0": { "documentation": "Change in movement of the mouse." }, "@roblox/globaltype/UserInputService.GetMouseDelta": { "documentation": "Returns the change, in pixels, of the position of the player's Mouse in the last rendered frame. Only works if the mouse is locked.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetMouseDelta/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetMouseDelta/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseDelta", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetMouseLocation/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetMouseLocation/return/0": { "documentation": "A Vector2 representing the current screen location of the mouse, in pixels." }, "@roblox/globaltype/UserInputService.GetMouseLocation": { "documentation": "Returns the current screen location of the player's Mouse relative to the top-left corner of the screen.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetMouseLocation/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetMouseLocation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetMouseLocation", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetNavigationGamepads/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetNavigationGamepads/return/0": { "documentation": "An array of UserInputTypes that can be used for navigation, in descending order of priority." }, "@roblox/globaltype/UserInputService.GetNavigationGamepads": { "documentation": "Returns an array of gamepads connected and enabled for GuiObject navigation in descending order of priority.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetNavigationGamepads/param/0" } ], "returns": [ "@roblox/globaltype/UserInputService.GetNavigationGamepads/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetNavigationGamepads", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetStringForKeyCode/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetStringForKeyCode/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GetStringForKeyCode/return/0": { "documentation": "" }, "@roblox/globaltype/UserInputService.GetStringForKeyCode": { "documentation": "Returns a string representing a key the user should press in order to input a given KeyCode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetStringForKeyCode/param/0" }, { "name": "keyCode", "documentation": "@roblox/globaltype/UserInputService.GetStringForKeyCode/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.GetStringForKeyCode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetStringForKeyCode", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes/param/1": { "documentation": "The UserInputType of the gamepad." }, "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes/return/0": { "documentation": "An array of KeyCodes supported by the given gamepad." }, "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes": { "documentation": "Returns an array of KeyCodes that the gamepad associated with the given UserInputType supports.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes/param/0" }, { "name": "gamepadNum", "documentation": "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.GetSupportedGamepadKeyCodes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetSupportedGamepadKeyCodes", "code_sample": "" }, "@roblox/globaltype/UserInputService.GetUserCFrame/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.GetUserCFrame/param/1": { "documentation": "The UserCFrame corresponding to the VR device." }, "@roblox/globaltype/UserInputService.GetUserCFrame/return/0": { "documentation": "A CFrame describing the position and orientation of the specified VR device." }, "@roblox/globaltype/UserInputService.GetUserCFrame": { "documentation": "Deprecated:
Returns a CFrame describing the position and orientation of a specified virtual reality device.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GetUserCFrame/param/0" }, { "name": "type", "documentation": "@roblox/globaltype/UserInputService.GetUserCFrame/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.GetUserCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GetUserCFrame", "code_sample": "local VRService = game:GetService(\"VRService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.CharacterAdded:Wait()\nlocal head = character:WaitForChild(\"Head\")\n\nlocal function TrackHead(inputType, value)\n\tif inputType == Enum.UserCFrame.Head then\n\t\thead.CFrame = value\n\tend\nend\n\nif VRService.VREnabled then\n\t-- Set the initial CFrame\n\thead.CFrame = VRService:GetUserCFrame(Enum.UserCFrame.Head)\n\n\t-- Track VR headset movement and mirror for character's head\n\tVRService.UserCFrameChanged:Connect(TrackHead)\nend" }, "@roblox/globaltype/UserInputService.IsGamepadButtonDown/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.IsGamepadButtonDown/param/1": { "documentation": "The UserInputType of the given gamepad." }, "@roblox/globaltype/UserInputService.IsGamepadButtonDown/param/2": { "documentation": "The KeyCode of the specified gamepad button." }, "@roblox/globaltype/UserInputService.IsGamepadButtonDown/return/0": { "documentation": "Whether the specified button on the given gamepad is pressed is pressed." }, "@roblox/globaltype/UserInputService.IsGamepadButtonDown": { "documentation": "Determines whether a particular button is pressed on a gamepad.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.IsGamepadButtonDown/param/0" }, { "name": "gamepadNum", "documentation": "@roblox/globaltype/UserInputService.IsGamepadButtonDown/param/1" }, { "name": "gamepadKeyCode", "documentation": "@roblox/globaltype/UserInputService.IsGamepadButtonDown/param/2" } ], "returns": [ "@roblox/globaltype/UserInputService.IsGamepadButtonDown/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsGamepadButtonDown", "code_sample": "" }, "@roblox/globaltype/UserInputService.IsKeyDown/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.IsKeyDown/param/1": { "documentation": "The KeyCode of the key." }, "@roblox/globaltype/UserInputService.IsKeyDown/return/0": { "documentation": "Whether the specified key is being held down." }, "@roblox/globaltype/UserInputService.IsKeyDown": { "documentation": "Returns whether the given key is currently held down.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.IsKeyDown/param/0" }, { "name": "keyCode", "documentation": "@roblox/globaltype/UserInputService.IsKeyDown/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.IsKeyDown/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsKeyDown", "code_sample": "" }, "@roblox/globaltype/UserInputService.IsMouseButtonPressed/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.IsMouseButtonPressed/param/1": { "documentation": "The UserInputType of the mouse button." }, "@roblox/globaltype/UserInputService.IsMouseButtonPressed/return/0": { "documentation": "Whether the given mouse button is currently held down." }, "@roblox/globaltype/UserInputService.IsMouseButtonPressed": { "documentation": "Returns whether the given mouse button is currently held down.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.IsMouseButtonPressed/param/0" }, { "name": "mouseButton", "documentation": "@roblox/globaltype/UserInputService.IsMouseButtonPressed/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.IsMouseButtonPressed/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsMouseButtonPressed", "code_sample": "" }, "@roblox/globaltype/UserInputService.IsNavigationGamepad/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.IsNavigationGamepad/param/1": { "documentation": "The UserInputType of the specified gamepad." }, "@roblox/globaltype/UserInputService.IsNavigationGamepad/return/0": { "documentation": "Whether the specified gamepad is a navigation gamepad." }, "@roblox/globaltype/UserInputService.IsNavigationGamepad": { "documentation": "Returns true if the specified gamepad is allowed to control navigation and selection GuiObjects.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.IsNavigationGamepad/param/0" }, { "name": "gamepadEnum", "documentation": "@roblox/globaltype/UserInputService.IsNavigationGamepad/param/1" } ], "returns": [ "@roblox/globaltype/UserInputService.IsNavigationGamepad/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#IsNavigationGamepad", "code_sample": "" }, "@roblox/globaltype/UserInputService.RecenterUserHeadCFrame/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.RecenterUserHeadCFrame": { "documentation": "Recenters the CFrame of the VR headset to the current orientation of the headset worn by the user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.RecenterUserHeadCFrame/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#RecenterUserHeadCFrame", "code_sample": "" }, "@roblox/globaltype/UserInputService.SetNavigationGamepad/param/0": { "documentation": "UserInputService is primarily used to detect the input types available on a user's device, as well as detect input events." }, "@roblox/globaltype/UserInputService.SetNavigationGamepad/param/1": { "documentation": "The UserInputType of the specified gamepad." }, "@roblox/globaltype/UserInputService.SetNavigationGamepad/param/2": { "documentation": "Whether the specified gamepad can move the GUI navigator." }, "@roblox/globaltype/UserInputService.SetNavigationGamepad": { "documentation": "Sets whether or not the specified gamepad can move the GuiObject navigator.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.SetNavigationGamepad/param/0" }, { "name": "gamepadEnum", "documentation": "@roblox/globaltype/UserInputService.SetNavigationGamepad/param/1" }, { "name": "enabled", "documentation": "@roblox/globaltype/UserInputService.SetNavigationGamepad/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#SetNavigationGamepad", "code_sample": "" }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceAccelerationChanged": { "documentation": "Fires when a user moves a device that has an accelerometer.", "keys": { "Connect": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Once", "Wait": "@roblox/globaltype/UserInputService.DeviceAccelerationChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#DeviceAccelerationChanged", "code_sample": "" }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceGravityChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceGravityChanged": { "documentation": "Fires when the force of gravity changes on a device that has an enabled accelerometer.", "keys": { "Connect": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.DeviceGravityChanged.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Once", "Wait": "@roblox/globaltype/UserInputService.DeviceGravityChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#DeviceGravityChanged", "code_sample": "local Workspace = game:GetService(\"Workspace\")\nlocal UserInputService = game:GetService(\"UserInputService\")\n\nlocal ball = script.Parent:WaitForChild(\"Ball\")\nlocal mass = ball:GetMass()\nlocal gravityForce = ball:WaitForChild(\"GravityForce\")\n\nlocal function moveBall(gravity)\n\tgravityForce.Force = gravity.Position * Workspace.Gravity * mass\nend\n\nif UserInputService.AccelerometerEnabled then\n\tUserInputService.DeviceGravityChanged:Connect(moveBall)\nend" }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.DeviceRotationChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.DeviceRotationChanged": { "documentation": "Fires when a user rotates a device that has a gyroscope.", "keys": { "Connect": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.DeviceRotationChanged.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Once", "Wait": "@roblox/globaltype/UserInputService.DeviceRotationChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#DeviceRotationChanged", "code_sample": "" }, "@roblox/globaltype/UserInputService.GamepadConnected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadConnected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GamepadConnected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadConnected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadConnected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GamepadConnected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadConnected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadConnected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GamepadConnected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadConnected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadConnected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadConnected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadConnected": { "documentation": "Fires when a gamepad is connected to the client.", "keys": { "Connect": "@roblox/globaltype/UserInputService.GamepadConnected.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.GamepadConnected.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.GamepadConnected.Once", "Wait": "@roblox/globaltype/UserInputService.GamepadConnected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadConnected", "code_sample": "" }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadDisconnected.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadDisconnected.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GamepadDisconnected.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.GamepadDisconnected.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.GamepadDisconnected.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.GamepadDisconnected": { "documentation": "Fires when a gamepad is disconnected from the client.", "keys": { "Connect": "@roblox/globaltype/UserInputService.GamepadDisconnected.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.GamepadDisconnected.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.GamepadDisconnected.Once", "Wait": "@roblox/globaltype/UserInputService.GamepadDisconnected.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#GamepadDisconnected", "code_sample": "" }, "@roblox/globaltype/UserInputService.InputBegan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputBegan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputBegan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputBegan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputBegan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputBegan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputBegan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputBegan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputBegan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputBegan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputBegan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputBegan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputBegan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputBegan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputBegan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputBegan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputBegan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputBegan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputBegan": { "documentation": "Fires when a user begins interacting with an input device such as a mouse or gamepad.", "keys": { "Connect": "@roblox/globaltype/UserInputService.InputBegan.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.InputBegan.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.InputBegan.Once", "Wait": "@roblox/globaltype/UserInputService.InputBegan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#InputBegan", "code_sample": "" }, "@roblox/globaltype/UserInputService.InputChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputChanged": { "documentation": "Fires when a user changes how they're interacting with an input device such as a mouse or gamepad.", "keys": { "Connect": "@roblox/globaltype/UserInputService.InputChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.InputChanged.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.InputChanged.Once", "Wait": "@roblox/globaltype/UserInputService.InputChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#InputChanged", "code_sample": "" }, "@roblox/globaltype/UserInputService.InputEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.InputEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.InputEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.InputEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.InputEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.InputEnded": { "documentation": "Fires when a user stops interacting with an input device such as a mouse or gamepad.", "keys": { "Connect": "@roblox/globaltype/UserInputService.InputEnded.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.InputEnded.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.InputEnded.Once", "Wait": "@roblox/globaltype/UserInputService.InputEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#InputEnded", "code_sample": "" }, "@roblox/globaltype/UserInputService.JumpRequest.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.JumpRequest.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.JumpRequest.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.JumpRequest.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.JumpRequest.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.JumpRequest.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.JumpRequest.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.JumpRequest.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.JumpRequest.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.JumpRequest.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.JumpRequest.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.JumpRequest.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.JumpRequest": { "documentation": "Fires whenever the client makes a request for their character to jump.", "keys": { "Connect": "@roblox/globaltype/UserInputService.JumpRequest.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.JumpRequest.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.JumpRequest.Once", "Wait": "@roblox/globaltype/UserInputService.JumpRequest.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#JumpRequest", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.Character or player.CharacterAdded:Wait()\nlocal humanoid = character:WaitForChild(\"Humanoid\")\n\nhumanoid:SetStateEnabled(Enum.HumanoidStateType.Jumping, false)\n\nlocal processJumpRequest = false\n\nlocal COOLDOWN_TIME = 0.5\n\nlocal function jumpRequest()\n\tif processJumpRequest == false then\n\t\tprocessJumpRequest = true\n\t\t-- Process custom jump request\n\t\tprint(\"Jump requested!\")\n\t\t-- Reset debounce variable after cooldown\n\t\ttask.wait(COOLDOWN_TIME)\n\t\tprocessJumpRequest = false\n\tend\nend\n\nUserInputService.JumpRequest:Connect(jumpRequest)" }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.LastInputTypeChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.LastInputTypeChanged": { "documentation": "Fires whenever the client's UserInputType is changed.", "keys": { "Connect": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.LastInputTypeChanged.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Once", "Wait": "@roblox/globaltype/UserInputService.LastInputTypeChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#LastInputTypeChanged", "code_sample": "" }, "@roblox/globaltype/UserInputService.PointerAction.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.PointerAction.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.PointerAction.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.PointerAction.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.PointerAction.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.PointerAction.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.PointerAction.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.PointerAction.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.PointerAction.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.PointerAction.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.PointerAction.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.PointerAction.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.PointerAction.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.PointerAction.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.PointerAction.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.PointerAction.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.PointerAction.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.PointerAction.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.PointerAction": { "documentation": "Fires when the user performs a specific pointer action.", "keys": { "Connect": "@roblox/globaltype/UserInputService.PointerAction.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.PointerAction.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.PointerAction.Once", "Wait": "@roblox/globaltype/UserInputService.PointerAction.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#PointerAction", "code_sample": "" }, "@roblox/globaltype/UserInputService.TextBoxFocused.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocused.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TextBoxFocused.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocused.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocused.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TextBoxFocused.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocused.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocused.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TextBoxFocused.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocused.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocused.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocused.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocused": { "documentation": "Fires when the client focuses on a TextBox.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TextBoxFocused.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TextBoxFocused.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TextBoxFocused.Once", "Wait": "@roblox/globaltype/UserInputService.TextBoxFocused.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TextBoxFocused", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\n\nlocal function textBoxFocused(textBox)\n\ttextBox.BackgroundTransparency = 0\nend\n\nlocal function textBoxFocusReleased(textBox)\n\ttextBox.BackgroundTransparency = 0.5\nend\n\nUserInputService.TextBoxFocused:Connect(textBoxFocused)\nUserInputService.TextBoxFocusReleased:Connect(textBoxFocusReleased)" }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TextBoxFocusReleased": { "documentation": "Fires when the client loses focus on a TextBox.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Once", "Wait": "@roblox/globaltype/UserInputService.TextBoxFocusReleased.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TextBoxFocusReleased", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\n\nlocal function textBoxFocused(textBox)\n\ttextBox.BackgroundTransparency = 0\nend\n\nlocal function textBoxFocusReleased(textBox)\n\ttextBox.BackgroundTransparency = 0.5\nend\n\nUserInputService.TextBoxFocused:Connect(textBoxFocused)\nUserInputService.TextBoxFocusReleased:Connect(textBoxFocusReleased)" }, "@roblox/globaltype/UserInputService.TouchDrag.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchDrag.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchDrag.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchDrag.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchDrag.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchDrag.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchDrag.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchDrag.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchDrag.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchDrag.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchDrag.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchDrag.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchDrag": { "documentation": "Fires when the user drags on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchDrag.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchDrag.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchDrag.Once", "Wait": "@roblox/globaltype/UserInputService.TouchDrag.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchDrag", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchEnded": { "documentation": "Fires when a user releases their finger from the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchEnded.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchEnded.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchEnded.Once", "Wait": "@roblox/globaltype/UserInputService.TouchEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchEnded", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchLongPress.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchLongPress.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchLongPress.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchLongPress.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchLongPress.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchLongPress.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchLongPress.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchLongPress.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchLongPress.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchLongPress.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchLongPress.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchLongPress.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchLongPress": { "documentation": "Fires when a user holds at least one finger for a short amount of time on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchLongPress.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchLongPress.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchLongPress.Once", "Wait": "@roblox/globaltype/UserInputService.TouchLongPress.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchLongPress", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchMoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchMoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchMoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchMoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchMoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchMoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchMoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchMoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchMoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchMoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchMoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchMoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchMoved": { "documentation": "Fires when a user moves their finger on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchMoved.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchMoved.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchMoved.Once", "Wait": "@roblox/globaltype/UserInputService.TouchMoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchMoved", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchPan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchPan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchPan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchPan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchPan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchPan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchPan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPan": { "documentation": "Fires when the user drags at least one finger on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchPan.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchPan.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchPan.Once", "Wait": "@roblox/globaltype/UserInputService.TouchPan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchPan", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchPinch.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPinch.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchPinch.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPinch.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPinch.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchPinch.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPinch.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPinch.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchPinch.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPinch.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchPinch.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchPinch.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchPinch": { "documentation": "Fires when a user performs a pinch gesture on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchPinch.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchPinch.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchPinch.Once", "Wait": "@roblox/globaltype/UserInputService.TouchPinch.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchPinch", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchRotate.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchRotate.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchRotate.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchRotate.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchRotate.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchRotate.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchRotate.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchRotate.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchRotate.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchRotate.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchRotate.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchRotate.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchRotate": { "documentation": "Fires when a user rotates two fingers on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchRotate.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchRotate.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchRotate.Once", "Wait": "@roblox/globaltype/UserInputService.TouchRotate.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchRotate", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchStarted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchStarted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchStarted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchStarted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchStarted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchStarted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchStarted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchStarted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchStarted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchStarted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchStarted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchStarted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchStarted": { "documentation": "Fires when a user places their finger on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchStarted.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchStarted.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchStarted.Once", "Wait": "@roblox/globaltype/UserInputService.TouchStarted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchStarted", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchSwipe.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchSwipe.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchSwipe.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchSwipe.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchSwipe.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchSwipe.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchSwipe.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchSwipe.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchSwipe.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchSwipe.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchSwipe.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchSwipe.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchSwipe": { "documentation": "Fires on a TouchEnabled device when a user places their finger(s) down on the screen, pans across the screen, and lifts their finger(s) off with a certain speed of movement.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchSwipe.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchSwipe.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchSwipe.Once", "Wait": "@roblox/globaltype/UserInputService.TouchSwipe.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchSwipe", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchTap.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTap.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchTap.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTap.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchTap.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTap.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTap.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchTap.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTap.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchTap.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTap.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTap.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchTap.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTap.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchTap.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTap.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTap.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTap.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTap": { "documentation": "Fires when a user taps their finger on the screen of a TouchEnabled device.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchTap.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchTap.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchTap.Once", "Wait": "@roblox/globaltype/UserInputService.TouchTap.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchTap", "code_sample": "" }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTapInWorld.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTapInWorld.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchTapInWorld.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.TouchTapInWorld.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.TouchTapInWorld.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.TouchTapInWorld": { "documentation": "Fires when a user taps their finger on the screen of a TouchEnabled device and the tap location is in the 3D world.", "keys": { "Connect": "@roblox/globaltype/UserInputService.TouchTapInWorld.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.TouchTapInWorld.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.TouchTapInWorld.Once", "Wait": "@roblox/globaltype/UserInputService.TouchTapInWorld.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#TouchTapInWorld", "code_sample": "" }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.UserCFrameChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.UserCFrameChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.UserCFrameChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.UserCFrameChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.UserCFrameChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.UserCFrameChanged": { "documentation": "Deprecated:
Fires when the CFrame of a specified Virtual Reality device changes.", "keys": { "Connect": "@roblox/globaltype/UserInputService.UserCFrameChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.UserCFrameChanged.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.UserCFrameChanged.Once", "Wait": "@roblox/globaltype/UserInputService.UserCFrameChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#UserCFrameChanged", "code_sample": "local VRService = game:GetService(\"VRService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal character = player.CharacterAdded:Wait()\nlocal head = character:WaitForChild(\"Head\")\n\nlocal function TrackHead(inputType, value)\n\tif inputType == Enum.UserCFrame.Head then\n\t\thead.CFrame = value\n\tend\nend\n\nif VRService.VREnabled then\n\t-- Set the initial CFrame\n\thead.CFrame = VRService:GetUserCFrame(Enum.UserCFrame.Head)\n\n\t-- Track VR headset movement and mirror for character's head\n\tVRService.UserCFrameChanged:Connect(TrackHead)\nend" }, "@roblox/globaltype/UserInputService.WindowFocused.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocused.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.WindowFocused.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocused.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocused.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.WindowFocused.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocused.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocused.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.WindowFocused.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocused.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocused.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocused.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocused": { "documentation": "Fires when the window of the Roblox client gains focus on the user's screen.", "keys": { "Connect": "@roblox/globaltype/UserInputService.WindowFocused.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.WindowFocused.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.WindowFocused.Once", "Wait": "@roblox/globaltype/UserInputService.WindowFocused.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#WindowFocused", "code_sample": "" }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocusReleased.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocusReleased.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.WindowFocusReleased.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserInputService.WindowFocusReleased.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserInputService.WindowFocusReleased.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserInputService.WindowFocusReleased": { "documentation": "Fires when the window of the Roblox client loses focus on the user's screen.", "keys": { "Connect": "@roblox/globaltype/UserInputService.WindowFocusReleased.Connect", "ConnectParallel": "@roblox/globaltype/UserInputService.WindowFocusReleased.ConnectParallel", "Once": "@roblox/globaltype/UserInputService.WindowFocusReleased.Once", "Wait": "@roblox/globaltype/UserInputService.WindowFocusReleased.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserInputService#WindowFocusReleased", "code_sample": "local UserInputService = game:GetService(\"UserInputService\")\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\n\nlocal awayEvent = ReplicatedStorage:WaitForChild(\"AwayEvent\")\n\nlocal function focusGained()\n\tawayEvent:FireServer(false)\nend\n\nlocal function focusReleased()\n\tawayEvent:FireServer(true)\nend\n\nUserInputService.WindowFocused:Connect(focusGained)\nUserInputService.WindowFocusReleased:Connect(focusReleased)" }, "@roblox/globaltype/VelocityMotor": { "documentation": "", "keys": { "CurrentAngle": "@roblox/globaltype/VelocityMotor.CurrentAngle", "DesiredAngle": "@roblox/globaltype/VelocityMotor.DesiredAngle", "Hole": "@roblox/globaltype/VelocityMotor.Hole", "MaxVelocity": "@roblox/globaltype/VelocityMotor.MaxVelocity" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VelocityMotor", "code_sample": "" }, "@roblox/globaltype/VelocityMotor.CurrentAngle": { "documentation": "Displays the angle that the motor is at in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VelocityMotor#CurrentAngle", "code_sample": "" }, "@roblox/globaltype/VelocityMotor.DesiredAngle": { "documentation": "The desired angle to be reached. The motor will attempt to reach this angle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VelocityMotor#DesiredAngle", "code_sample": "" }, "@roblox/globaltype/VelocityMotor.Hole": { "documentation": "The Hole linked to this VelocityMotor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VelocityMotor#Hole", "code_sample": "" }, "@roblox/globaltype/VelocityMotor.MaxVelocity": { "documentation": "The maximum amount of velocity able to be reached.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VelocityMotor#MaxVelocity", "code_sample": "" }, "@roblox/globaltype/UserGameSettings": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character.", "keys": { "AllTutorialsDisabled": "@roblox/globaltype/UserGameSettings.AllTutorialsDisabled", "BadgeVisible": "@roblox/globaltype/UserGameSettings.BadgeVisible", "CameraMode": "@roblox/globaltype/UserGameSettings.CameraMode", "ChatVisible": "@roblox/globaltype/UserGameSettings.ChatVisible", "ComputerCameraMovementMode": "@roblox/globaltype/UserGameSettings.ComputerCameraMovementMode", "ComputerMovementMode": "@roblox/globaltype/UserGameSettings.ComputerMovementMode", "ControlMode": "@roblox/globaltype/UserGameSettings.ControlMode", "Fullscreen": "@roblox/globaltype/UserGameSettings.Fullscreen", "GamepadCameraSensitivity": "@roblox/globaltype/UserGameSettings.GamepadCameraSensitivity", "GraphicsOptimizationMode": "@roblox/globaltype/UserGameSettings.GraphicsOptimizationMode", "GraphicsQualityLevel": "@roblox/globaltype/UserGameSettings.GraphicsQualityLevel", "HasEverUsedVR": "@roblox/globaltype/UserGameSettings.HasEverUsedVR", "MasterVolume": "@roblox/globaltype/UserGameSettings.MasterVolume", "MasterVolumeStudio": "@roblox/globaltype/UserGameSettings.MasterVolumeStudio", "MaxQualityEnabled": "@roblox/globaltype/UserGameSettings.MaxQualityEnabled", "MouseSensitivity": "@roblox/globaltype/UserGameSettings.MouseSensitivity", "OnboardingsCompleted": "@roblox/globaltype/UserGameSettings.OnboardingsCompleted", "PartyVoiceVolume": "@roblox/globaltype/UserGameSettings.PartyVoiceVolume", "PeoplePageLayout": "@roblox/globaltype/UserGameSettings.PeoplePageLayout", "PlayerListVisible": "@roblox/globaltype/UserGameSettings.PlayerListVisible", "PlayerNamesEnabled": "@roblox/globaltype/UserGameSettings.PlayerNamesEnabled", "RCCProfilerRecordFrameRate": "@roblox/globaltype/UserGameSettings.RCCProfilerRecordFrameRate", "RCCProfilerRecordTimeFrame": "@roblox/globaltype/UserGameSettings.RCCProfilerRecordTimeFrame", "RotationType": "@roblox/globaltype/UserGameSettings.RotationType", "SavedQualityLevel": "@roblox/globaltype/UserGameSettings.SavedQualityLevel", "StartMaximized": "@roblox/globaltype/UserGameSettings.StartMaximized", "StartScreenPosition": "@roblox/globaltype/UserGameSettings.StartScreenPosition", "StartScreenSize": "@roblox/globaltype/UserGameSettings.StartScreenSize", "TouchCameraMovementMode": "@roblox/globaltype/UserGameSettings.TouchCameraMovementMode", "TouchMovementMode": "@roblox/globaltype/UserGameSettings.TouchMovementMode", "UsedCoreGuiIsVisibleToggle": "@roblox/globaltype/UserGameSettings.UsedCoreGuiIsVisibleToggle", "UsedCustomGuiIsVisibleToggle": "@roblox/globaltype/UserGameSettings.UsedCustomGuiIsVisibleToggle", "UsedHideHudShortcut": "@roblox/globaltype/UserGameSettings.UsedHideHudShortcut", "VignetteEnabled": "@roblox/globaltype/UserGameSettings.VignetteEnabled", "VREnabled": "@roblox/globaltype/UserGameSettings.VREnabled", "VRRotationIntensity": "@roblox/globaltype/UserGameSettings.VRRotationIntensity", "VRSmoothRotationEnabled": "@roblox/globaltype/UserGameSettings.VRSmoothRotationEnabled", "GetCameraYInvertValue": "@roblox/globaltype/UserGameSettings.GetCameraYInvertValue", "GetOnboardingCompleted": "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted", "InFullScreen": "@roblox/globaltype/UserGameSettings.InFullScreen", "InStudioMode": "@roblox/globaltype/UserGameSettings.InStudioMode", "SetCameraYInvertVisible": "@roblox/globaltype/UserGameSettings.SetCameraYInvertVisible", "SetGamepadCameraSensitivityVisible": "@roblox/globaltype/UserGameSettings.SetGamepadCameraSensitivityVisible", "SetOnboardingCompleted": "@roblox/globaltype/UserGameSettings.SetOnboardingCompleted" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.AllTutorialsDisabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#AllTutorialsDisabled", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.BadgeVisible": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#BadgeVisible", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.CameraMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#CameraMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.ChatVisible": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#ChatVisible", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.ComputerCameraMovementMode": { "documentation": "The camera movement mode currently in-use by the client on desktop.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#ComputerCameraMovementMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.ComputerMovementMode": { "documentation": "The type of controls being used by the client on desktop.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#ComputerMovementMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.ControlMode": { "documentation": "Toggles whether or not the client can use the Mouse Lock Switch mode.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#ControlMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.Fullscreen": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#Fullscreen", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.GamepadCameraSensitivity": { "documentation": "Describes how sensitive the camera is when using a gamepad.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#GamepadCameraSensitivity", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.GraphicsOptimizationMode": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#GraphicsOptimizationMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.GraphicsQualityLevel": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#GraphicsQualityLevel", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.HasEverUsedVR": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#HasEverUsedVR", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.MasterVolume": { "documentation": "A float between 0 and 1 representing the volume of the game's client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#MasterVolume", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.MasterVolumeStudio": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#MasterVolumeStudio", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.MaxQualityEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#MaxQualityEnabled", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.MouseSensitivity": { "documentation": "A float between 0 and 4 representing the sensitivity of the client's camera sensitivity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#MouseSensitivity", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.OnboardingsCompleted": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#OnboardingsCompleted", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.PartyVoiceVolume": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#PartyVoiceVolume", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.PeoplePageLayout": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#PeoplePageLayout", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.PlayerListVisible": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#PlayerListVisible", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.PlayerNamesEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#PlayerNamesEnabled", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.RCCProfilerRecordFrameRate": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RCCProfilerRecordFrameRate", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.RCCProfilerRecordTimeFrame": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RCCProfilerRecordTimeFrame", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.RotationType": { "documentation": "Controls how the client's character is rotated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#RotationType", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.SavedQualityLevel": { "documentation": "The graphics quality level set by the client.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#SavedQualityLevel", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.StartMaximized": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#StartMaximized", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.StartScreenPosition": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#StartScreenPosition", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.StartScreenSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#StartScreenSize", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.TouchCameraMovementMode": { "documentation": "The camera type in-use by the client while on a mobile device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#TouchCameraMovementMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.TouchMovementMode": { "documentation": "The type of controls being used by the client on a mobile device.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#TouchMovementMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.UsedCoreGuiIsVisibleToggle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#UsedCoreGuiIsVisibleToggle", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.UsedCustomGuiIsVisibleToggle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#UsedCustomGuiIsVisibleToggle", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.UsedHideHudShortcut": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#UsedHideHudShortcut", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.VignetteEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VignetteEnabled", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.VREnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VREnabled", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.VRRotationIntensity": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VRRotationIntensity", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.VRSmoothRotationEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#VRSmoothRotationEnabled", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.GetCameraYInvertValue/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.GetCameraYInvertValue/return/0": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.GetCameraYInvertValue": { "documentation": "Returns the camera's Y-invert value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.GetCameraYInvertValue/param/0" } ], "returns": [ "@roblox/globaltype/UserGameSettings.GetCameraYInvertValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#GetCameraYInvertValue", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted/param/1": { "documentation": "The onboarding ID to inquire about." }, "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted/return/0": { "documentation": "Whether or not the onboarding in particular has been completed yet." }, "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted": { "documentation": "Checks if onboarding has been completed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted/param/0" }, { "name": "onboardingId", "documentation": "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted/param/1" } ], "returns": [ "@roblox/globaltype/UserGameSettings.GetOnboardingCompleted/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#GetOnboardingCompleted", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.InFullScreen/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.InFullScreen/return/0": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.InFullScreen": { "documentation": "Returns true if the user's Roblox window is in full screen mode.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.InFullScreen/param/0" } ], "returns": [ "@roblox/globaltype/UserGameSettings.InFullScreen/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#InFullScreen", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.InStudioMode/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.InStudioMode/return/0": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.InStudioMode": { "documentation": "Returns true if the client's game session is in Roblox Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.InStudioMode/param/0" } ], "returns": [ "@roblox/globaltype/UserGameSettings.InStudioMode/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#InStudioMode", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.SetCameraYInvertVisible/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.SetCameraYInvertVisible": { "documentation": "If called, Roblox toggles the menu option to invert the user's camera y axis.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.SetCameraYInvertVisible/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#SetCameraYInvertVisible", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.SetGamepadCameraSensitivityVisible/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.SetGamepadCameraSensitivityVisible": { "documentation": "If called, Roblox toggles the menu option to control the camera sensitivity with gamepads.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.SetGamepadCameraSensitivityVisible/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#SetGamepadCameraSensitivityVisible", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.SetOnboardingCompleted/param/0": { "documentation": "The UserGameSettings is a singleton class found inside of the UserSettings singleton. It holds various persistent settings relating to how the user wants to control their camera, and their character." }, "@roblox/globaltype/UserGameSettings.SetOnboardingCompleted/param/1": { "documentation": "The onboarding ID to set as completed." }, "@roblox/globaltype/UserGameSettings.SetOnboardingCompleted": { "documentation": "Sets onboarding as completed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.SetOnboardingCompleted/param/0" }, { "name": "onboardingId", "documentation": "@roblox/globaltype/UserGameSettings.SetOnboardingCompleted/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#SetOnboardingCompleted", "code_sample": "" }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.FullscreenChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.FullscreenChanged": { "documentation": "Fires if the user's full screen mode is changed.", "keys": { "Connect": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserGameSettings.FullscreenChanged.ConnectParallel", "Once": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Once", "Wait": "@roblox/globaltype/UserGameSettings.FullscreenChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#FullscreenChanged", "code_sample": "local gameSettings = UserSettings().GameSettings\n\nlocal function checkFullScreenMode()\n\tlocal inFullscreen = gameSettings:InFullScreen()\n\tif inFullscreen then\n\t\tprint(\"Full Screen mode enabled!\")\n\telse\n\t\tprint(\"Full Screen mode disabled!\")\n\tend\nend\n\ncheckFullScreenMode()\ngameSettings.FullscreenChanged:Connect(checkFullScreenMode)" }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UserGameSettings.StudioModeChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UserGameSettings.StudioModeChanged": { "documentation": "Fired when the user's client switches between Studio mode and in-game mode. This gets fired periodically in Roblox Studio when a session starts.", "keys": { "Connect": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Connect", "ConnectParallel": "@roblox/globaltype/UserGameSettings.StudioModeChanged.ConnectParallel", "Once": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Once", "Wait": "@roblox/globaltype/UserGameSettings.StudioModeChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserGameSettings#StudioModeChanged", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataEnumItem": { "documentation": "Contains information about a specific EnumItem embedded within an Enum.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataEnumItem", "code_sample": "" }, "@roblox/globaltype/CaptureService": { "documentation": "A service which provides control over screenshot and video capture features.", "keys": { "CaptureScreenshot": "@roblox/globaltype/CaptureService.CaptureScreenshot", "PromptCaptureGalleryPermissionAsync": "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync", "PromptSaveCapturesToGallery": "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery", "PromptShareCapture": "@roblox/globaltype/CaptureService.PromptShareCapture", "ReadCapturesFromGalleryAsync": "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync", "StartVideoCaptureAsync": "@roblox/globaltype/CaptureService.StartVideoCaptureAsync", "StopVideoCapture": "@roblox/globaltype/CaptureService.StopVideoCapture", "TakeScreenshotCaptureAsync": "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync", "UploadCaptureAsync": "@roblox/globaltype/CaptureService.UploadCaptureAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService", "code_sample": "" }, "@roblox/globaltype/CaptureService.CaptureScreenshot/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.CaptureScreenshot/param/1": { "documentation": "A callback function that is called with the contentId of the new capture once it is ready." }, "@roblox/globaltype/CaptureService.CaptureScreenshot": { "documentation": "Takes a screenshot and provides a temporary contentId to identify it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureScreenshot/param/0" }, { "name": "onCaptureReady", "documentation": "@roblox/globaltype/CaptureService.CaptureScreenshot/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureScreenshot", "code_sample": "" }, "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync/param/1": { "documentation": "An CaptureGalleryPermission representing the type of access for which the user will be prompted." }, "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync/return/0": { "documentation": "A boolean representing whether or not the user has allowed access to their captures." }, "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync/param/0" }, { "name": "captureGalleryPermission", "documentation": "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync/param/1" } ], "returns": [ "@roblox/globaltype/CaptureService.PromptCaptureGalleryPermissionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptCaptureGalleryPermissionAsync", "code_sample": "" }, "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery/param/1": { "documentation": "An array of content IDs and/or Capture objects." }, "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery/param/2": { "documentation": "A callback function that will be invoked with a dictionary mapping each contentId and/or Capture object to a boolean indicating if the user accepted saving that capture." }, "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery": { "documentation": "Prompts the user to save specified captures to their gallery.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery/param/0" }, { "name": "captures", "documentation": "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery/param/1" }, { "name": "resultCallback", "documentation": "@roblox/globaltype/CaptureService.PromptSaveCapturesToGallery/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery", "code_sample": "" }, "@roblox/globaltype/CaptureService.PromptShareCapture/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.PromptShareCapture/param/1": { "documentation": "A Content containing a contentId or Capture object." }, "@roblox/globaltype/CaptureService.PromptShareCapture/param/2": { "documentation": "An optional string to include as launch data in the invite link." }, "@roblox/globaltype/CaptureService.PromptShareCapture/param/3": { "documentation": "An optional callback function invoked if the user accepts sharing." }, "@roblox/globaltype/CaptureService.PromptShareCapture/param/4": { "documentation": "An optional callback function invoked if the user denies sharing." }, "@roblox/globaltype/CaptureService.PromptShareCapture": { "documentation": "Prompts the user to share a specified capture.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.PromptShareCapture/param/0" }, { "name": "captureContent", "documentation": "@roblox/globaltype/CaptureService.PromptShareCapture/param/1" }, { "name": "launchData", "documentation": "@roblox/globaltype/CaptureService.PromptShareCapture/param/2" }, { "name": "onAcceptedCallback", "documentation": "@roblox/globaltype/CaptureService.PromptShareCapture/param/3" }, { "name": "onDeniedCallback", "documentation": "@roblox/globaltype/CaptureService.PromptShareCapture/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture", "code_sample": "" }, "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync/param/1": { "documentation": "An array of CaptureType." }, "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync/return/0": { "documentation": "Tuple of (result: ReadCapturesFromGalleryResult, capturesPages: CapturesPages)" }, "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync/param/0" }, { "name": "captureTypeFilters", "documentation": "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync/param/1" } ], "returns": [ "@roblox/globaltype/CaptureService.ReadCapturesFromGalleryAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#ReadCapturesFromGalleryAsync", "code_sample": "" }, "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/param/1": { "documentation": "A callback function that is called on video capture completion with a VideoCaptureResult and, if successful, a VideoCapture." }, "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/param/2": { "documentation": "" }, "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/return/0": { "documentation": "" }, "@roblox/globaltype/CaptureService.StartVideoCaptureAsync": { "documentation": "Initiates a video capture recording.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/param/0" }, { "name": "onCaptureReady", "documentation": "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/param/1" }, { "name": "captureParams", "documentation": "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/param/2" } ], "returns": [ "@roblox/globaltype/CaptureService.StartVideoCaptureAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync", "code_sample": "" }, "@roblox/globaltype/CaptureService.StopVideoCapture/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.StopVideoCapture": { "documentation": "Ends a video capture initiated by StartVideoCaptureAsync().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.StopVideoCapture/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#StopVideoCapture", "code_sample": "" }, "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync/param/1": { "documentation": "A callback function that is called on screenshot capture completion with a ScreenshotCaptureResult and, if successful, a ScreenshotCapture." }, "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync/param/2": { "documentation": "A dictionary that modifies capture behavior." }, "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync": { "documentation": "Initiates a screenshot capture.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync/param/0" }, { "name": "onCaptureReady", "documentation": "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync/param/1" }, { "name": "captureParams", "documentation": "@roblox/globaltype/CaptureService.TakeScreenshotCaptureAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeScreenshotCaptureAsync", "code_sample": "" }, "@roblox/globaltype/CaptureService.UploadCaptureAsync/param/0": { "documentation": "A service which provides control over screenshot and video capture features." }, "@roblox/globaltype/CaptureService.UploadCaptureAsync/param/1": { "documentation": "a capture object of type Capture" }, "@roblox/globaltype/CaptureService.UploadCaptureAsync/return/0": { "documentation": "Tuple of (result: UploadCaptureResult, assetId: number)" }, "@roblox/globaltype/CaptureService.UploadCaptureAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.UploadCaptureAsync/param/0" }, { "name": "capture", "documentation": "@roblox/globaltype/CaptureService.UploadCaptureAsync/param/1" } ], "returns": [ "@roblox/globaltype/CaptureService.UploadCaptureAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#UploadCaptureAsync", "code_sample": "" }, "@roblox/globaltype/CaptureService.CaptureBegan.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureBegan.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureBegan.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureBegan.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureBegan.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureBegan.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureBegan.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureBegan.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureBegan.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureBegan.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureBegan.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureBegan.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureBegan": { "documentation": "Fires immediately before a capture begins.", "keys": { "Connect": "@roblox/globaltype/CaptureService.CaptureBegan.Connect", "ConnectParallel": "@roblox/globaltype/CaptureService.CaptureBegan.ConnectParallel", "Once": "@roblox/globaltype/CaptureService.CaptureBegan.Once", "Wait": "@roblox/globaltype/CaptureService.CaptureBegan.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureBegan", "code_sample": "" }, "@roblox/globaltype/CaptureService.CaptureEnded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureEnded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureEnded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureEnded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureEnded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureEnded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureEnded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureEnded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureEnded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureEnded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureEnded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureEnded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureEnded": { "documentation": "Fires after a capture finishes.", "keys": { "Connect": "@roblox/globaltype/CaptureService.CaptureEnded.Connect", "ConnectParallel": "@roblox/globaltype/CaptureService.CaptureEnded.ConnectParallel", "Once": "@roblox/globaltype/CaptureService.CaptureEnded.Once", "Wait": "@roblox/globaltype/CaptureService.CaptureEnded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureEnded", "code_sample": "" }, "@roblox/globaltype/CaptureService.CaptureSaved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureSaved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureSaved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureSaved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureSaved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureSaved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureSaved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureSaved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.CaptureSaved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureSaved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.CaptureSaved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.CaptureSaved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CaptureService.CaptureSaved": { "documentation": "Deprecated: This event has been superseded by the UserCaptureSaved event.", "keys": { "Connect": "@roblox/globaltype/CaptureService.CaptureSaved.Connect", "ConnectParallel": "@roblox/globaltype/CaptureService.CaptureSaved.ConnectParallel", "Once": "@roblox/globaltype/CaptureService.CaptureSaved.Once", "Wait": "@roblox/globaltype/CaptureService.CaptureSaved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#CaptureSaved", "code_sample": "" }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.UserCaptureSaved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.UserCaptureSaved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.UserCaptureSaved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/CaptureService.UserCaptureSaved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CaptureService.UserCaptureSaved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/CaptureService.UserCaptureSaved": { "documentation": "Fires when the user saves a capture.", "keys": { "Connect": "@roblox/globaltype/CaptureService.UserCaptureSaved.Connect", "ConnectParallel": "@roblox/globaltype/CaptureService.UserCaptureSaved.ConnectParallel", "Once": "@roblox/globaltype/CaptureService.UserCaptureSaved.Once", "Wait": "@roblox/globaltype/CaptureService.UserCaptureSaved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CaptureService#UserCaptureSaved", "code_sample": "" }, "@roblox/globaltype/KeyframeSequence": { "documentation": "This object stores all of the Keyframes and other data for the animation.", "keys": { "AuthoredHipHeight": "@roblox/globaltype/KeyframeSequence.AuthoredHipHeight", "AddKeyframe": "@roblox/globaltype/KeyframeSequence.AddKeyframe", "GetKeyframes": "@roblox/globaltype/KeyframeSequence.GetKeyframes", "RemoveKeyframe": "@roblox/globaltype/KeyframeSequence.RemoveKeyframe" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence", "code_sample": "local function getSequenceLength(keyframeSequence)\n\tlocal length = 0\n\tfor _, keyframe in pairs(keyframeSequence:GetKeyframes()) do\n\t\tif keyframe.Time > length then\n\t\t\tlength = keyframe.Time\n\t\tend\n\tend\n\treturn length\nend\n\nlocal keyframeSequence = Instance.new(\"KeyframeSequence\")\n\ngetSequenceLength(keyframeSequence)" }, "@roblox/globaltype/KeyframeSequence.AuthoredHipHeight": { "documentation": "Contains the hip height of the Humanoid of the model that was used to author this KeyframeSequence.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#AuthoredHipHeight", "code_sample": "" }, "@roblox/globaltype/KeyframeSequence.AddKeyframe/param/0": { "documentation": "This object stores all of the Keyframes and other data for the animation." }, "@roblox/globaltype/KeyframeSequence.AddKeyframe/param/1": { "documentation": "The Keyframe to be added." }, "@roblox/globaltype/KeyframeSequence.AddKeyframe": { "documentation": "Adds a Keyframe to the KeyframeSequence by parenting it to the KeyframeSequence.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequence.AddKeyframe/param/0" }, { "name": "keyframe", "documentation": "@roblox/globaltype/KeyframeSequence.AddKeyframe/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#AddKeyframe", "code_sample": "-- Create the sequence\nlocal keyframeSequence = Instance.new(\"KeyframeSequence\")\nkeyframeSequence.Loop = false\nkeyframeSequence.Priority = Enum.AnimationPriority.Action\n\n-- Create a keyframe\nlocal keyframe = Instance.new(\"Keyframe\")\nkeyframe.Time = 0\n\n-- Create sample poses\nlocal rootPose = Instance.new(\"Pose\")\nrootPose.Name = \"HumanoidRootPart\"\nrootPose.Weight = 0\nlocal lowerTorsoPose = Instance.new(\"Pose\")\nlowerTorsoPose.Name = \"LowerTorso\"\nlowerTorsoPose.Weight = 1\n\n-- Set the sequence hierarchy\nrootPose:AddSubPose(lowerTorsoPose)\nkeyframe:AddPose(rootPose)\nkeyframeSequence:AddKeyframe(keyframe)\n\n-- Parent the sequence\nkeyframeSequence.Parent = workspace" }, "@roblox/globaltype/KeyframeSequence.GetKeyframes/param/0": { "documentation": "This object stores all of the Keyframes and other data for the animation." }, "@roblox/globaltype/KeyframeSequence.GetKeyframes/return/0": { "documentation": "An array of Keyframes." }, "@roblox/globaltype/KeyframeSequence.GetKeyframes": { "documentation": "Returns an array that contains all Keyframes contained in a KeyframeSequence.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequence.GetKeyframes/param/0" } ], "returns": [ "@roblox/globaltype/KeyframeSequence.GetKeyframes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#GetKeyframes", "code_sample": "local function getSequenceLength(keyframeSequence)\n\tlocal length = 0\n\tfor _, keyframe in pairs(keyframeSequence:GetKeyframes()) do\n\t\tif keyframe.Time > length then\n\t\t\tlength = keyframe.Time\n\t\tend\n\tend\n\treturn length\nend\n\nlocal keyframeSequence = Instance.new(\"KeyframeSequence\")\n\ngetSequenceLength(keyframeSequence)" }, "@roblox/globaltype/KeyframeSequence.RemoveKeyframe/param/0": { "documentation": "This object stores all of the Keyframes and other data for the animation." }, "@roblox/globaltype/KeyframeSequence.RemoveKeyframe/param/1": { "documentation": "The Keyframe to be removed." }, "@roblox/globaltype/KeyframeSequence.RemoveKeyframe": { "documentation": "This method removes a Keyframe from the KeyframeSequence by setting its parent to nil.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/KeyframeSequence.RemoveKeyframe/param/0" }, { "name": "keyframe", "documentation": "@roblox/globaltype/KeyframeSequence.RemoveKeyframe/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/KeyframeSequence#RemoveKeyframe", "code_sample": "local keyframeSequence = Instance.new(\"KeyframeSequence\")\nkeyframeSequence.Parent = workspace\n\nlocal keyframe = Instance.new(\"Keyframe\")\n\nkeyframeSequence:AddKeyframe(keyframe)\n\ntask.wait(2)\n\nkeyframeSequence:RemoveKeyframe(keyframe)" }, "@roblox/globaltype/Hat": { "documentation": "Deprecated: This class has been superseded by the Accessory class. Do not use it for new work.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Hat", "code_sample": "" }, "@roblox/globaltype/VideoCaptureService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoCaptureService", "code_sample": "" }, "@roblox/globaltype/Glue": { "documentation": "Deprecated: This joint type has been deprecated and should not be used in new work.
Glue is a type of joint that can break when enough force is applied.", "keys": { "F0": "@roblox/globaltype/Glue.F0", "F1": "@roblox/globaltype/Glue.F1", "F2": "@roblox/globaltype/Glue.F2", "F3": "@roblox/globaltype/Glue.F3" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Glue", "code_sample": "" }, "@roblox/globaltype/Glue.F0": { "documentation": "Determines the face of a Glue.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Glue#F0", "code_sample": "" }, "@roblox/globaltype/Glue.F1": { "documentation": "Determines the face of a Glue.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Glue#F1", "code_sample": "" }, "@roblox/globaltype/Glue.F2": { "documentation": "Determines the face of a Glue.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Glue#F2", "code_sample": "" }, "@roblox/globaltype/Glue.F3": { "documentation": "Determines the face of a Glue.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Glue#F3", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyInfo": { "documentation": "An object specifying information about a particular version of the key.", "keys": { "CreatedTime": "@roblox/globaltype/DataStoreKeyInfo.CreatedTime", "UpdatedTime": "@roblox/globaltype/DataStoreKeyInfo.UpdatedTime", "Version": "@roblox/globaltype/DataStoreKeyInfo.Version", "GetMetadata": "@roblox/globaltype/DataStoreKeyInfo.GetMetadata", "GetUserIds": "@roblox/globaltype/DataStoreKeyInfo.GetUserIds" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyInfo", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyInfo.CreatedTime": { "documentation": "The date and time the object was created.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyInfo#CreatedTime", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyInfo.UpdatedTime": { "documentation": "The date and time the object was last updated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyInfo#UpdatedTime", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyInfo.Version": { "documentation": "Uniquely identifies the version of the object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyInfo#Version", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyInfo.GetMetadata/param/0": { "documentation": "An object specifying information about a particular version of the key." }, "@roblox/globaltype/DataStoreKeyInfo.GetMetadata/return/0": { "documentation": "Metadata associated with the key." }, "@roblox/globaltype/DataStoreKeyInfo.GetMetadata": { "documentation": "Returns the metadata associated with the object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreKeyInfo.GetMetadata/param/0" } ], "returns": [ "@roblox/globaltype/DataStoreKeyInfo.GetMetadata/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyInfo#GetMetadata", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyInfo.GetUserIds/param/0": { "documentation": "An object specifying information about a particular version of the key." }, "@roblox/globaltype/DataStoreKeyInfo.GetUserIds/return/0": { "documentation": "An array of UserIds associated with the object." }, "@roblox/globaltype/DataStoreKeyInfo.GetUserIds": { "documentation": "An array of UserIds tagged with a key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreKeyInfo.GetUserIds/param/0" } ], "returns": [ "@roblox/globaltype/DataStoreKeyInfo.GetUserIds/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyInfo#GetUserIds", "code_sample": "" }, "@roblox/globaltype/GroupService": { "documentation": "GroupService is a service that allows developers to fetch information about a Roblox group from within a game.", "keys": { "GetAlliesAsync": "@roblox/globaltype/GroupService.GetAlliesAsync", "GetEnemiesAsync": "@roblox/globaltype/GroupService.GetEnemiesAsync", "GetGroupInfoAsync": "@roblox/globaltype/GroupService.GetGroupInfoAsync", "GetGroupsAsync": "@roblox/globaltype/GroupService.GetGroupsAsync", "PromptJoinAsync": "@roblox/globaltype/GroupService.PromptJoinAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroupService", "code_sample": "" }, "@roblox/globaltype/GroupService.GetAlliesAsync/param/0": { "documentation": "GroupService is a service that allows developers to fetch information about a Roblox group from within a game." }, "@roblox/globaltype/GroupService.GetAlliesAsync/param/1": { "documentation": "The group's ID." }, "@roblox/globaltype/GroupService.GetAlliesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/GroupService.GetAlliesAsync": { "documentation": "Returns a StandardPages object including information on all of the specified group's allies.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GroupService.GetAlliesAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/GroupService.GetAlliesAsync/param/1" } ], "returns": [ "@roblox/globaltype/GroupService.GetAlliesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroupService#GetAlliesAsync", "code_sample": "" }, "@roblox/globaltype/GroupService.GetEnemiesAsync/param/0": { "documentation": "GroupService is a service that allows developers to fetch information about a Roblox group from within a game." }, "@roblox/globaltype/GroupService.GetEnemiesAsync/param/1": { "documentation": "The group's ID." }, "@roblox/globaltype/GroupService.GetEnemiesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/GroupService.GetEnemiesAsync": { "documentation": "Returns a StandardPages object including information on all of the specified group's enemies.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GroupService.GetEnemiesAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/GroupService.GetEnemiesAsync/param/1" } ], "returns": [ "@roblox/globaltype/GroupService.GetEnemiesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroupService#GetEnemiesAsync", "code_sample": "" }, "@roblox/globaltype/GroupService.GetGroupInfoAsync/param/0": { "documentation": "GroupService is a service that allows developers to fetch information about a Roblox group from within a game." }, "@roblox/globaltype/GroupService.GetGroupInfoAsync/param/1": { "documentation": "The group ID of the group." }, "@roblox/globaltype/GroupService.GetGroupInfoAsync/return/0": { "documentation": "A dictionary of information about the group." }, "@roblox/globaltype/GroupService.GetGroupInfoAsync": { "documentation": "Returns a table containing information about the given group.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GroupService.GetGroupInfoAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/GroupService.GetGroupInfoAsync/param/1" } ], "returns": [ "@roblox/globaltype/GroupService.GetGroupInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroupService#GetGroupInfoAsync", "code_sample": "local GroupService = game:GetService(\"GroupService\")\n\nlocal GROUP_ID = 377251\n\nlocal group = GroupService:GetGroupInfoAsync(GROUP_ID)\n\nprint(group.Name .. \" has the following roles:\")\nfor _, role in ipairs(group.Roles) do\n\tprint(\"Rank \" .. role.Rank .. \": \" .. role.Name)\nend" }, "@roblox/globaltype/GroupService.GetGroupsAsync/param/0": { "documentation": "GroupService is a service that allows developers to fetch information about a Roblox group from within a game." }, "@roblox/globaltype/GroupService.GetGroupsAsync/param/1": { "documentation": "The Player.UserId of the user." }, "@roblox/globaltype/GroupService.GetGroupsAsync/return/0": { "documentation": "An array of dictionaries containing information on the group's the Player is a member of." }, "@roblox/globaltype/GroupService.GetGroupsAsync": { "documentation": "Returns a list of tables containing information on all of the groups a given player is a member of.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GroupService.GetGroupsAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/GroupService.GetGroupsAsync/param/1" } ], "returns": [ "@roblox/globaltype/GroupService.GetGroupsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroupService#GetGroupsAsync", "code_sample": "local GroupService = game:GetService(\"GroupService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal function playerAdded(player)\n\t-- load a list of info on all groups the player is a member of\n\tlocal groups = GroupService:GetGroupsAsync(player.UserId)\n\n\tfor _, groupInfo in pairs(groups) do\n\t\tfor key, value in pairs(groupInfo) do\n\t\t\tprint(key .. \": \" .. tostring(value))\n\t\tend\n\n\t\tprint(\"--\")\n\tend\nend\n\nPlayers.PlayerAdded:Connect(playerAdded)\n\n-- go through existing players\nfor _, player in pairs(Players:GetPlayers()) do\n\tplayerAdded(player)\nend" }, "@roblox/globaltype/GroupService.PromptJoinAsync/param/0": { "documentation": "GroupService is a service that allows developers to fetch information about a Roblox group from within a game." }, "@roblox/globaltype/GroupService.PromptJoinAsync/param/1": { "documentation": "ID of the group to prompt the player to join. This must be a valid group ID." }, "@roblox/globaltype/GroupService.PromptJoinAsync/return/0": { "documentation": "GroupMembershipStatus indicating the player's group membership status after the prompt is closed. If the player closes the prompt without joining, this will return GroupMembershipStatus.None or their previous status if they were already a member." }, "@roblox/globaltype/GroupService.PromptJoinAsync": { "documentation": "Prompts the local Player to join a specified Roblox group via a native modal.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GroupService.PromptJoinAsync/param/0" }, { "name": "groupId", "documentation": "@roblox/globaltype/GroupService.PromptJoinAsync/param/1" } ], "returns": [ "@roblox/globaltype/GroupService.PromptJoinAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroupService#PromptJoinAsync", "code_sample": "local GroupService = game:GetService(\"GroupService\")\n\nlocal GROUP_ID = 377251\n\n-- This should be done in a script running on the client\nlocal success, result = pcall(function()\n return GroupService:PromptJoinAsync(GROUP_ID)\nend)\n\nif success then\n if result == Enum.GroupMembershipStatus.Joined then\n print(\"Player joined the group!\")\n elseif result == Enum.GroupMembershipStatus.JoinRequestPending then\n print(\"Join request sent\")\n elseif result == Enum.GroupMembershipStatus.AlreadyMember then\n print(\"Already a member\")\n else\n print(\"Did not join or not eligible\")\n end\nelse\n warn(\"Prompt failed:\", result)\nend" }, "@roblox/globaltype/AudioFilter": { "documentation": "Adjusts the frequency content of audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioFilter.Bypass", "FilterType": "@roblox/globaltype/AudioFilter.FilterType", "Frequency": "@roblox/globaltype/AudioFilter.Frequency", "Gain": "@roblox/globaltype/AudioFilter.Gain", "Q": "@roblox/globaltype/AudioFilter.Q", "GetConnectedWires": "@roblox/globaltype/AudioFilter.GetConnectedWires", "GetGainAt": "@roblox/globaltype/AudioFilter.GetGainAt", "GetInputPins": "@roblox/globaltype/AudioFilter.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioFilter.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter", "code_sample": "" }, "@roblox/globaltype/AudioFilter.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioFilter.FilterType": { "documentation": "The curve type of the band represented by the filter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#FilterType", "code_sample": "" }, "@roblox/globaltype/AudioFilter.Frequency": { "documentation": "The central frequency that the filter acts around.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#Frequency", "code_sample": "" }, "@roblox/globaltype/AudioFilter.Gain": { "documentation": "For peaking and shelving filters, controls volume increase or reduction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#Gain", "code_sample": "" }, "@roblox/globaltype/AudioFilter.Q": { "documentation": "For peaking, lowpass, highpass, bandpass, and notch filters, controls the selectiveness or resonance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#Q", "code_sample": "" }, "@roblox/globaltype/AudioFilter.GetConnectedWires/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioFilter.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFilter.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFilter.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioFilter.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioFilter.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioFilter.GetGainAt/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioFilter.GetGainAt/param/1": { "documentation": "The frequency, in hertz, to sample." }, "@roblox/globaltype/AudioFilter.GetGainAt/return/0": { "documentation": "The gain value, in decibels, at the given frequency." }, "@roblox/globaltype/AudioFilter.GetGainAt": { "documentation": "Returns the magnitude response of the filter at the given frequency.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.GetGainAt/param/0" }, { "name": "frequency", "documentation": "@roblox/globaltype/AudioFilter.GetGainAt/param/1" } ], "returns": [ "@roblox/globaltype/AudioFilter.GetGainAt/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetGainAt", "code_sample": "" }, "@roblox/globaltype/AudioFilter.GetInputPins/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioFilter.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFilter.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioFilter.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioFilter.GetOutputPins/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioFilter.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioFilter.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioFilter.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioFilter.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFilter.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFilter.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFilter.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFilter.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFilter.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFilter.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFilter.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioFilter.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioFilter.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioFilter.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioFilter.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioFilter.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioFilter via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioFilter.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioFilter.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioFilter.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioFilter.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioFilter#WiringChanged", "code_sample": "" }, "@roblox/globaltype/PolicyService": { "documentation": "Helps you query information regarding policy compliance for players around the world based on age range, location, and platform type.", "keys": { "CanViewBrandProjectAsync": "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync", "GetPolicyInfoForPlayerAsync": "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PolicyService", "code_sample": "" }, "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/param/0": { "documentation": "Helps you query information regarding policy compliance for players around the world based on age range, location, and platform type." }, "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/param/1": { "documentation": "The Player object you're trying to show the brand project to." }, "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/param/2": { "documentation": "The brand project ID provided by Roblox. Represents all assets associated with a brand project." }, "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/return/0": { "documentation": "Whether or not the brand project can be shown to the specific user." }, "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync": { "documentation": "Determines if a user can see brand project assets inside your experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/param/1" }, { "name": "brandProjectId", "documentation": "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/param/2" } ], "returns": [ "@roblox/globaltype/PolicyService.CanViewBrandProjectAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PolicyService#CanViewBrandProjectAsync", "code_sample": "-- In ServerScriptService\nlocal Players = game:GetService(\"Players\")\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal PolicyService = game:GetService(\"PolicyService\")\n\n-- Pre-created RemoteEvent in ReplicatedStorage\nlocal RemoteEvent = ReplicatedStorage:WaitForChild(\"RemoteEvent\")\n\nlocal brandedAsset = ReplicatedStorage:WaitForChild(\"BrandedAsset\")\nlocal defaultAsset = Instance.new(\"Part\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\t-- PolicyService:CanViewBrandProjectAsync can only be called from the Server\n\tlocal success, canView = pcall(function()\n\t\treturn PolicyService:CanViewBrandProjectAsync(player, \"BRP-0123456789\")\n\tend)\n\n\tif success and canView then\n\t\tRemoteEvent:FireClient(player, brandedAsset)\n\telse\n\t\tRemoteEvent:FireClient(player, defaultAsset)\n\tend\nend)" }, "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync/param/0": { "documentation": "Helps you query information regarding policy compliance for players around the world based on age range, location, and platform type." }, "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync/param/1": { "documentation": "The Player to get policy information for." }, "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync/return/0": { "documentation": "A dictionary containing information about the policy information of the requested player; see above for the dictionary structure." }, "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync": { "documentation": "Returns policy information about a player based on geolocation, age group, and platform.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync/param/1" } ], "returns": [ "@roblox/globaltype/PolicyService.GetPolicyInfoForPlayerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PolicyService#GetPolicyInfoForPlayerAsync", "code_sample": "local PolicyService = game:GetService(\"PolicyService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal success, result = pcall(function()\n\treturn PolicyService:GetPolicyInfoForPlayerAsync(player)\nend)\n\nif not success then\n\twarn(\"PolicyService error: \" .. result)\nelseif result.ArePaidRandomItemsRestricted then\n\twarn(\"Player cannot interact with paid random item generators\")\nend" }, "@roblox/globaltype/MemStorageConnection": { "documentation": "", "keys": { "Disconnect": "@roblox/globaltype/MemStorageConnection.Disconnect" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemStorageConnection", "code_sample": "" }, "@roblox/globaltype/MemStorageConnection.Disconnect/param/0": { "documentation": "" }, "@roblox/globaltype/MemStorageConnection.Disconnect": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemStorageConnection.Disconnect/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemStorageConnection#Disconnect", "code_sample": "" }, "@roblox/globaltype/Part": { "documentation": "A common type of BasePart that comes in different primitive shapes.", "keys": { "Shape": "@roblox/globaltype/Part.Shape" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Part", "code_sample": "local part = Instance.new(\"Part\")\npart.Name = \"JurassicPart\"\npart.Anchored = true\npart.Shape = Enum.PartType.Ball\npart.Color = Color3.new(1, 1, 1)\npart.Parent = workspace -- Put the part into the Workspace" }, "@roblox/globaltype/Part.Shape": { "documentation": "Sets the overall shape of the object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Part#Shape", "code_sample": "local part = Instance.new(\"Part\")\npart.Name = \"JurassicPart\"\npart.Anchored = true\npart.Shape = Enum.PartType.Ball\npart.Color = Color3.new(1, 1, 1)\npart.Parent = workspace -- Put the part into the Workspace" }, "@roblox/globaltype/SensorBase": { "documentation": "An abstract class for various sensor instance types.", "keys": { "UpdateType": "@roblox/globaltype/SensorBase.UpdateType", "Sense": "@roblox/globaltype/SensorBase.Sense" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SensorBase", "code_sample": "" }, "@roblox/globaltype/SensorBase.UpdateType": { "documentation": "Determines how the sensor will update its output data.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SensorBase#UpdateType", "code_sample": "" }, "@roblox/globaltype/SensorBase.Sense/param/0": { "documentation": "An abstract class for various sensor instance types." }, "@roblox/globaltype/SensorBase.Sense": { "documentation": "Deprecated: This method should not be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SensorBase.Sense/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SensorBase#Sense", "code_sample": "" }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SensorBase.OnSensorOutputChanged": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Connect", "ConnectParallel": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.ConnectParallel", "Once": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Once", "Wait": "@roblox/globaltype/SensorBase.OnSensorOutputChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SensorBase#OnSensorOutputChanged", "code_sample": "" }, "@roblox/globaltype/SoundEffect": { "documentation": "SoundEffect is the base class that all other sound effects derive from. A SoundEffect can be applied to either a Sound or SoundGroup by being parented to either.", "keys": { "Enabled": "@roblox/globaltype/SoundEffect.Enabled", "Priority": "@roblox/globaltype/SoundEffect.Priority" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundEffect", "code_sample": "" }, "@roblox/globaltype/SoundEffect.Enabled": { "documentation": "Toggles the effect on and off.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundEffect#Enabled", "code_sample": "" }, "@roblox/globaltype/SoundEffect.Priority": { "documentation": "Determines the order the effect will be applied in relation to other effects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SoundEffect#Priority", "code_sample": "" }, "@roblox/globaltype/BrickColorValue": { "documentation": "A container object for a single BrickColor value.", "keys": { "Value": "@roblox/globaltype/BrickColorValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BrickColorValue", "code_sample": "" }, "@roblox/globaltype/BrickColorValue.Value": { "documentation": "Used to hold a BrickColor value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BrickColorValue#Value", "code_sample": "" }, "@roblox/globaltype/BrickColorValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BrickColorValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BrickColorValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BrickColorValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BrickColorValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BrickColorValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BrickColorValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.Changed": { "documentation": "Fired whenever the BrickColorValue.Value of the BrickColorValue is changed.", "keys": { "Connect": "@roblox/globaltype/BrickColorValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/BrickColorValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/BrickColorValue.Changed.Once", "Wait": "@roblox/globaltype/BrickColorValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BrickColorValue#Changed", "code_sample": "local brickColorValue = script.Parent.BrickColorValue\n\nbrickColorValue.Changed:Connect(print)\n\nbrickColorValue.Value = BrickColor.new(\"Bright red\")" }, "@roblox/globaltype/BrickColorValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BrickColorValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BrickColorValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BrickColorValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BrickColorValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BrickColorValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BrickColorValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BrickColorValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BrickColorValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BrickColorValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of BrickColorValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/BrickColorValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/BrickColorValue.changed.ConnectParallel", "Once": "@roblox/globaltype/BrickColorValue.changed.Once", "Wait": "@roblox/globaltype/BrickColorValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BrickColorValue#changed", "code_sample": "" }, "@roblox/globaltype/TextBoxService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBoxService", "code_sample": "" }, "@roblox/globaltype/ObjectValue": { "documentation": "A container object for a reference to another instance.", "keys": { "Value": "@roblox/globaltype/ObjectValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ObjectValue", "code_sample": "local objectValue = Instance.new(\"ObjectValue\")\nobjectValue.Name = \"MyBaseplateReference\"\nobjectValue.Value = workspace:FindFirstChild(\"Baseplate\")\nobjectValue.Parent = workspace" }, "@roblox/globaltype/ObjectValue.Value": { "documentation": "Holds a reference to an instance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ObjectValue#Value", "code_sample": "" }, "@roblox/globaltype/ObjectValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ObjectValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ObjectValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ObjectValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ObjectValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ObjectValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ObjectValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.Changed": { "documentation": "Fires whenever the ObjectValue.Value is changed.", "keys": { "Connect": "@roblox/globaltype/ObjectValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/ObjectValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/ObjectValue.Changed.Once", "Wait": "@roblox/globaltype/ObjectValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ObjectValue#Changed", "code_sample": "local objectValue = script.Parent.ObjectValue\nlocal part = script.Parent.Part\n\nlocal function printObject(object)\n\tprint(object:GetFullName())\nend\n\nobjectValue.Changed:Connect(printObject)\n\nobjectValue.Value = part" }, "@roblox/globaltype/ObjectValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ObjectValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ObjectValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ObjectValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ObjectValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ObjectValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ObjectValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ObjectValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ObjectValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ObjectValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of ObjectValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/ObjectValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/ObjectValue.changed.ConnectParallel", "Once": "@roblox/globaltype/ObjectValue.changed.Once", "Wait": "@roblox/globaltype/ObjectValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ObjectValue#changed", "code_sample": "" }, "@roblox/globaltype/InputBinding": { "documentation": "Defines which hardware binding should trigger the parent InputAction.", "keys": { "Backward": "@roblox/globaltype/InputBinding.Backward", "Down": "@roblox/globaltype/InputBinding.Down", "Forward": "@roblox/globaltype/InputBinding.Forward", "KeyCode": "@roblox/globaltype/InputBinding.KeyCode", "Left": "@roblox/globaltype/InputBinding.Left", "PressedThreshold": "@roblox/globaltype/InputBinding.PressedThreshold", "ReleasedThreshold": "@roblox/globaltype/InputBinding.ReleasedThreshold", "ResponseCurve": "@roblox/globaltype/InputBinding.ResponseCurve", "Right": "@roblox/globaltype/InputBinding.Right", "Scale": "@roblox/globaltype/InputBinding.Scale", "UIButton": "@roblox/globaltype/InputBinding.UIButton", "Up": "@roblox/globaltype/InputBinding.Up", "Vector2Scale": "@roblox/globaltype/InputBinding.Vector2Scale", "Vector3Scale": "@roblox/globaltype/InputBinding.Vector3Scale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding", "code_sample": "" }, "@roblox/globaltype/InputBinding.Backward": { "documentation": "Specifies an alternate KeyCode for dispatching directionally \"backward\" inputs to the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Backward", "code_sample": "" }, "@roblox/globaltype/InputBinding.Down": { "documentation": "Specifies an alternate KeyCode for dispatching directionally \"down\" inputs to the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Down", "code_sample": "" }, "@roblox/globaltype/InputBinding.Forward": { "documentation": "Specifies an alternate KeyCode for dispatching directionally \"forward\" inputs to the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Forward", "code_sample": "" }, "@roblox/globaltype/InputBinding.KeyCode": { "documentation": "Specifies the KeyCode which triggers the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#KeyCode", "code_sample": "" }, "@roblox/globaltype/InputBinding.Left": { "documentation": "Specifies an alternate KeyCode for dispatching directionally \"left\" inputs to the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Left", "code_sample": "" }, "@roblox/globaltype/InputBinding.PressedThreshold": { "documentation": "Numerical value above which to fire an InputAction with a Type of Bool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold", "code_sample": "" }, "@roblox/globaltype/InputBinding.ReleasedThreshold": { "documentation": "Numerical value below which to fire an InputAction with a Type of Bool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#ReleasedThreshold", "code_sample": "" }, "@roblox/globaltype/InputBinding.ResponseCurve": { "documentation": "Numerical value to configure scaling for more precise thumbstick aiming.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#ResponseCurve", "code_sample": "" }, "@roblox/globaltype/InputBinding.Right": { "documentation": "Specifies an alternate KeyCode for dispatching directionally \"right\" inputs to the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Right", "code_sample": "" }, "@roblox/globaltype/InputBinding.Scale": { "documentation": "Amount by which to linearly scale the values of a directional InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale", "code_sample": "" }, "@roblox/globaltype/InputBinding.UIButton": { "documentation": "Connects a GuiButton to a boolean action.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#UIButton", "code_sample": "" }, "@roblox/globaltype/InputBinding.Up": { "documentation": "Specifies an alternate KeyCode for dispatching directionally \"up\" inputs to the parent InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Up", "code_sample": "" }, "@roblox/globaltype/InputBinding.Vector2Scale": { "documentation": "Amount by which to linearly scale the values of a two-directional InputAction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector2Scale", "code_sample": "" }, "@roblox/globaltype/InputBinding.Vector3Scale": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector3Scale", "code_sample": "" }, "@roblox/globaltype/AudioSpeechToText": { "documentation": "Converts spoken audio into text.", "keys": { "Enabled": "@roblox/globaltype/AudioSpeechToText.Enabled", "Text": "@roblox/globaltype/AudioSpeechToText.Text", "VoiceDetected": "@roblox/globaltype/AudioSpeechToText.VoiceDetected", "GetConnectedWires": "@roblox/globaltype/AudioSpeechToText.GetConnectedWires" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText", "code_sample": "" }, "@roblox/globaltype/AudioSpeechToText.Enabled": { "documentation": "Whether the AudioSpeechToText object is enabled for processing input audio into text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#Enabled", "code_sample": "" }, "@roblox/globaltype/AudioSpeechToText.Text": { "documentation": "The text resulting from the conversion of speech audio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#Text", "code_sample": "" }, "@roblox/globaltype/AudioSpeechToText.VoiceDetected": { "documentation": "Whether the AudioSpeechToText object is detecting speech in the incoming audio signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#VoiceDetected", "code_sample": "" }, "@roblox/globaltype/AudioSpeechToText.GetConnectedWires/param/0": { "documentation": "Converts spoken audio into text." }, "@roblox/globaltype/AudioSpeechToText.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioSpeechToText.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioSpeechToText.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioSpeechToText.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioSpeechToText.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioSpeechToText.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioSpeechToText.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioSpeechToText.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioSpeechToText via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioSpeechToText.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioSpeechToText.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#WiringChanged", "code_sample": "" }, "@roblox/globaltype/IKControl": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics.", "keys": { "ChainRoot": "@roblox/globaltype/IKControl.ChainRoot", "Enabled": "@roblox/globaltype/IKControl.Enabled", "EndEffector": "@roblox/globaltype/IKControl.EndEffector", "EndEffectorOffset": "@roblox/globaltype/IKControl.EndEffectorOffset", "Offset": "@roblox/globaltype/IKControl.Offset", "Pole": "@roblox/globaltype/IKControl.Pole", "Priority": "@roblox/globaltype/IKControl.Priority", "SmoothTime": "@roblox/globaltype/IKControl.SmoothTime", "Target": "@roblox/globaltype/IKControl.Target", "Type": "@roblox/globaltype/IKControl.Type", "Weight": "@roblox/globaltype/IKControl.Weight", "GetChainCount": "@roblox/globaltype/IKControl.GetChainCount", "GetChainLength": "@roblox/globaltype/IKControl.GetChainLength", "GetNodeLocalCFrame": "@roblox/globaltype/IKControl.GetNodeLocalCFrame", "GetNodeWorldCFrame": "@roblox/globaltype/IKControl.GetNodeWorldCFrame", "GetRawFinalTarget": "@roblox/globaltype/IKControl.GetRawFinalTarget", "GetSmoothedFinalTarget": "@roblox/globaltype/IKControl.GetSmoothedFinalTarget" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl", "code_sample": "local character = script.Parent.Character\nlocal humanoid = character.Humanoid\nlocal root = character.HumanoidRootPart\n\n-- Create a new attachment to use as the IKControl.Target\nlocal target = Instance.new(\"Attachment\")\ntarget.CFrame = CFrame.new(-1, 0, -1)\ntarget.Parent = root\n\nlocal ikControl = Instance.new(\"IKControl\")\nikControl.Type = Enum.IKControlType.Position\nikControl.EndEffector = character.LeftHand\nikControl.ChainRoot = character.LeftUpperArm\nikControl.Target = target\nikControl.Parent = humanoid" }, "@roblox/globaltype/IKControl.ChainRoot": { "documentation": "The last part that you are interested in moving your character. For example, the upper arm. Must be an ancestor of EndEffector and be a BasePart or a Bone in your character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#ChainRoot", "code_sample": "" }, "@roblox/globaltype/IKControl.Enabled": { "documentation": "Toggles the control on and off. True by default.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Enabled", "code_sample": "" }, "@roblox/globaltype/IKControl.EndEffector": { "documentation": "The part that you are interested in moving to reach the Target. For example, the hand of your character. Must be a descendant of ChainRoot and be a BasePart or a Bone in your character.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#EndEffector", "code_sample": "" }, "@roblox/globaltype/IKControl.EndEffectorOffset": { "documentation": "An additional offset applied on top of the EndEffector in its local space to change where it moves.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#EndEffectorOffset", "code_sample": "" }, "@roblox/globaltype/IKControl.Offset": { "documentation": "An additional offset applied on top of the Target to change where the EndEffector moves.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Offset", "code_sample": "" }, "@roblox/globaltype/IKControl.Pole": { "documentation": "An optional instance that determines which way the chain bends. You can use this to specify which way an elbow or knee bends.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Pole", "code_sample": "" }, "@roblox/globaltype/IKControl.Priority": { "documentation": "Specifies the order in which controls are solved. Higher values have higher priority.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Priority", "code_sample": "" }, "@roblox/globaltype/IKControl.SmoothTime": { "documentation": "Specifies the average number of seconds that it takes for the EndEffector to smoothly reach the Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#SmoothTime", "code_sample": "" }, "@roblox/globaltype/IKControl.Target": { "documentation": "The object that the EndEffector reaches for or points at. It can be anything that has a position in the world, such as BasePart, Attachment, Bone, or Motor6D.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Target", "code_sample": "" }, "@roblox/globaltype/IKControl.Type": { "documentation": "Specifies how the solver satisfies this control.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Type", "code_sample": "" }, "@roblox/globaltype/IKControl.Weight": { "documentation": "Specifies the weight of the IK control target. Should be in the [0, 1] range.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#Weight", "code_sample": "" }, "@roblox/globaltype/IKControl.GetChainCount/param/0": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics." }, "@roblox/globaltype/IKControl.GetChainCount/return/0": { "documentation": "" }, "@roblox/globaltype/IKControl.GetChainCount": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IKControl.GetChainCount/param/0" } ], "returns": [ "@roblox/globaltype/IKControl.GetChainCount/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#GetChainCount", "code_sample": "" }, "@roblox/globaltype/IKControl.GetChainLength/param/0": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics." }, "@roblox/globaltype/IKControl.GetChainLength/return/0": { "documentation": "" }, "@roblox/globaltype/IKControl.GetChainLength": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IKControl.GetChainLength/param/0" } ], "returns": [ "@roblox/globaltype/IKControl.GetChainLength/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#GetChainLength", "code_sample": "" }, "@roblox/globaltype/IKControl.GetNodeLocalCFrame/param/0": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics." }, "@roblox/globaltype/IKControl.GetNodeLocalCFrame/param/1": { "documentation": "" }, "@roblox/globaltype/IKControl.GetNodeLocalCFrame/return/0": { "documentation": "" }, "@roblox/globaltype/IKControl.GetNodeLocalCFrame": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IKControl.GetNodeLocalCFrame/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/IKControl.GetNodeLocalCFrame/param/1" } ], "returns": [ "@roblox/globaltype/IKControl.GetNodeLocalCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#GetNodeLocalCFrame", "code_sample": "" }, "@roblox/globaltype/IKControl.GetNodeWorldCFrame/param/0": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics." }, "@roblox/globaltype/IKControl.GetNodeWorldCFrame/param/1": { "documentation": "" }, "@roblox/globaltype/IKControl.GetNodeWorldCFrame/return/0": { "documentation": "" }, "@roblox/globaltype/IKControl.GetNodeWorldCFrame": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IKControl.GetNodeWorldCFrame/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/IKControl.GetNodeWorldCFrame/param/1" } ], "returns": [ "@roblox/globaltype/IKControl.GetNodeWorldCFrame/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#GetNodeWorldCFrame", "code_sample": "" }, "@roblox/globaltype/IKControl.GetRawFinalTarget/param/0": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics." }, "@roblox/globaltype/IKControl.GetRawFinalTarget/return/0": { "documentation": "" }, "@roblox/globaltype/IKControl.GetRawFinalTarget": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IKControl.GetRawFinalTarget/param/0" } ], "returns": [ "@roblox/globaltype/IKControl.GetRawFinalTarget/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#GetRawFinalTarget", "code_sample": "" }, "@roblox/globaltype/IKControl.GetSmoothedFinalTarget/param/0": { "documentation": "Specifies a control to generate a procedural animation pose using Inverse Kinematics." }, "@roblox/globaltype/IKControl.GetSmoothedFinalTarget/return/0": { "documentation": "" }, "@roblox/globaltype/IKControl.GetSmoothedFinalTarget": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/IKControl.GetSmoothedFinalTarget/param/0" } ], "returns": [ "@roblox/globaltype/IKControl.GetSmoothedFinalTarget/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/IKControl#GetSmoothedFinalTarget", "code_sample": "" }, "@roblox/globaltype/TerrainModifyOperation": { "documentation": "", "keys": { "CommitBlock": "@roblox/globaltype/TerrainModifyOperation.CommitBlock" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation", "code_sample": "" }, "@roblox/globaltype/TerrainModifyOperation.CommitBlock/param/0": { "documentation": "" }, "@roblox/globaltype/TerrainModifyOperation.CommitBlock/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainModifyOperation.CommitBlock/return/0": { "documentation": "" }, "@roblox/globaltype/TerrainModifyOperation.CommitBlock": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainModifyOperation.CommitBlock/param/0" }, { "name": "block", "documentation": "@roblox/globaltype/TerrainModifyOperation.CommitBlock/param/1" } ], "returns": [ "@roblox/globaltype/TerrainModifyOperation.CommitBlock/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation#CommitBlock", "code_sample": "" }, "@roblox/globaltype/TerrainModifyOperation.Ready.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainModifyOperation.Ready.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainModifyOperation.Ready.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainModifyOperation.Ready.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainModifyOperation.Ready.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainModifyOperation.Ready.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainModifyOperation.Ready.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainModifyOperation.Ready.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainModifyOperation.Ready.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainModifyOperation.Ready.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainModifyOperation.Ready.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainModifyOperation.Ready.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TerrainModifyOperation.Ready": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/TerrainModifyOperation.Ready.Connect", "ConnectParallel": "@roblox/globaltype/TerrainModifyOperation.Ready.ConnectParallel", "Once": "@roblox/globaltype/TerrainModifyOperation.Ready.Once", "Wait": "@roblox/globaltype/TerrainModifyOperation.Ready.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainModifyOperation#Ready", "code_sample": "" }, "@roblox/globaltype/BodyForce": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use VectorForce instead, and see the legacy conversion notes.
Applies a constant force to an object.", "keys": { "Force": "@roblox/globaltype/BodyForce.Force", "force": "@roblox/globaltype/BodyForce.force" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyForce", "code_sample": "" }, "@roblox/globaltype/BodyForce.Force": { "documentation": "Determines the force exerted on each axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyForce#Force", "code_sample": "" }, "@roblox/globaltype/BodyForce.force": { "documentation": "Deprecated: This deprecated property is a variant of BodyForce.Force which should be used instead.
Determines the amount of force applied on each axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyForce#force", "code_sample": "" }, "@roblox/globaltype/PluginManagementService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManagementService", "code_sample": "" }, "@roblox/globaltype/GroundController": { "documentation": "", "keys": { "AccelerationLean": "@roblox/globaltype/GroundController.AccelerationLean", "AccelerationTime": "@roblox/globaltype/GroundController.AccelerationTime", "BalanceMaxTorque": "@roblox/globaltype/GroundController.BalanceMaxTorque", "BalanceSpeed": "@roblox/globaltype/GroundController.BalanceSpeed", "DecelerationTime": "@roblox/globaltype/GroundController.DecelerationTime", "Friction": "@roblox/globaltype/GroundController.Friction", "FrictionWeight": "@roblox/globaltype/GroundController.FrictionWeight", "GroundOffset": "@roblox/globaltype/GroundController.GroundOffset", "StandForce": "@roblox/globaltype/GroundController.StandForce", "StandSpeed": "@roblox/globaltype/GroundController.StandSpeed", "TurnSpeedFactor": "@roblox/globaltype/GroundController.TurnSpeedFactor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController", "code_sample": "" }, "@roblox/globaltype/GroundController.AccelerationLean": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#AccelerationLean", "code_sample": "" }, "@roblox/globaltype/GroundController.AccelerationTime": { "documentation": "Estimated time taken to reach the desired speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#AccelerationTime", "code_sample": "" }, "@roblox/globaltype/GroundController.BalanceMaxTorque": { "documentation": "The maximum torque used to keep the ControllerManager.RootPart aligned upright.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#BalanceMaxTorque", "code_sample": "" }, "@roblox/globaltype/GroundController.BalanceSpeed": { "documentation": "The maximum angular speed used to align the ControllerManager.RootPart upright.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#BalanceSpeed", "code_sample": "" }, "@roblox/globaltype/GroundController.DecelerationTime": { "documentation": "Estimated time taken to reach a complete stop from full speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#DecelerationTime", "code_sample": "" }, "@roblox/globaltype/GroundController.Friction": { "documentation": "The coefficient of friction of the character on the ground.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#Friction", "code_sample": "" }, "@roblox/globaltype/GroundController.FrictionWeight": { "documentation": "Amount the character's friction is weighed against the ground friction.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#FrictionWeight", "code_sample": "" }, "@roblox/globaltype/GroundController.GroundOffset": { "documentation": "The target distance above the ground to keep the ControllerManager.RootPart at.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#GroundOffset", "code_sample": "" }, "@roblox/globaltype/GroundController.StandForce": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#StandForce", "code_sample": "" }, "@roblox/globaltype/GroundController.StandSpeed": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#StandSpeed", "code_sample": "" }, "@roblox/globaltype/GroundController.TurnSpeedFactor": { "documentation": "The value multiplied by the ControllerManager.BaseTurnSpeed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GroundController#TurnSpeedFactor", "code_sample": "" }, "@roblox/globaltype/DataStoreKey": { "documentation": "Object representing a key on a DataStoreKeyPages object.", "keys": { "KeyName": "@roblox/globaltype/DataStoreKey.KeyName" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKey", "code_sample": "" }, "@roblox/globaltype/DataStoreKey.KeyName": { "documentation": "The name of the key.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKey#KeyName", "code_sample": "" }, "@roblox/globaltype/StandalonePluginScripts": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StandalonePluginScripts", "code_sample": "" }, "@roblox/globaltype/Clouds": { "documentation": "Renders realistic clouds that drift slowly across the sky.", "keys": { "Color": "@roblox/globaltype/Clouds.Color", "Cover": "@roblox/globaltype/Clouds.Cover", "Density": "@roblox/globaltype/Clouds.Density", "Enabled": "@roblox/globaltype/Clouds.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clouds", "code_sample": "" }, "@roblox/globaltype/Clouds.Color": { "documentation": "Controls the material color of cloud particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clouds#Color", "code_sample": "" }, "@roblox/globaltype/Clouds.Cover": { "documentation": "Defines the cloud cover within the overall skyscape layer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clouds#Cover", "code_sample": "" }, "@roblox/globaltype/Clouds.Density": { "documentation": "Controls the particulate density of clouds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clouds#Density", "code_sample": "" }, "@roblox/globaltype/Clouds.Enabled": { "documentation": "Toggles rendering of the Clouds object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Clouds#Enabled", "code_sample": "" }, "@roblox/globaltype/OpenCloudService": { "documentation": "Deprecated: This class is deprecated and should not be used for new work. Use HttpService instead and see the In-experience HTTP requests guide.", "keys": { "GetApiV1": "@roblox/globaltype/OpenCloudService.GetApiV1", "InvokeAsync": "@roblox/globaltype/OpenCloudService.InvokeAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OpenCloudService", "code_sample": "" }, "@roblox/globaltype/OpenCloudService.GetApiV1/param/0": { "documentation": "Deprecated: This class is deprecated and should not be used for new work. Use HttpService instead and see the In-experience HTTP requests guide." }, "@roblox/globaltype/OpenCloudService.GetApiV1/return/0": { "documentation": "" }, "@roblox/globaltype/OpenCloudService.GetApiV1": { "documentation": "Deprecated: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/OpenCloudService.GetApiV1/param/0" } ], "returns": [ "@roblox/globaltype/OpenCloudService.GetApiV1/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OpenCloudService#GetApiV1", "code_sample": "" }, "@roblox/globaltype/OpenCloudService.InvokeAsync/param/0": { "documentation": "Deprecated: This class is deprecated and should not be used for new work. Use HttpService instead and see the In-experience HTTP requests guide." }, "@roblox/globaltype/OpenCloudService.InvokeAsync/param/1": { "documentation": "" }, "@roblox/globaltype/OpenCloudService.InvokeAsync/param/2": { "documentation": "" }, "@roblox/globaltype/OpenCloudService.InvokeAsync/param/3": { "documentation": "" }, "@roblox/globaltype/OpenCloudService.InvokeAsync/param/4": { "documentation": "" }, "@roblox/globaltype/OpenCloudService.InvokeAsync/return/0": { "documentation": "" }, "@roblox/globaltype/OpenCloudService.InvokeAsync": { "documentation": "Deprecated: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/OpenCloudService.InvokeAsync/param/0" }, { "name": "version", "documentation": "@roblox/globaltype/OpenCloudService.InvokeAsync/param/1" }, { "name": "methodName", "documentation": "@roblox/globaltype/OpenCloudService.InvokeAsync/param/2" }, { "name": "arguments", "documentation": "@roblox/globaltype/OpenCloudService.InvokeAsync/param/3" }, { "name": "headers", "documentation": "@roblox/globaltype/OpenCloudService.InvokeAsync/param/4" } ], "returns": [ "@roblox/globaltype/OpenCloudService.InvokeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OpenCloudService#InvokeAsync", "code_sample": "" }, "@roblox/globaltype/JointInstance": { "documentation": "The base class for joints.", "keys": { "Active": "@roblox/globaltype/JointInstance.Active", "C0": "@roblox/globaltype/JointInstance.C0", "C1": "@roblox/globaltype/JointInstance.C1", "Enabled": "@roblox/globaltype/JointInstance.Enabled", "Part0": "@roblox/globaltype/JointInstance.Part0", "Part1": "@roblox/globaltype/JointInstance.Part1", "part1": "@roblox/globaltype/JointInstance.part1" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance", "code_sample": "" }, "@roblox/globaltype/JointInstance.Active": { "documentation": "Determines if the joint is currently active in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#Active", "code_sample": "" }, "@roblox/globaltype/JointInstance.C0": { "documentation": "Determines how the offset point is attached to JointInstance.Part0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#C0", "code_sample": "" }, "@roblox/globaltype/JointInstance.C1": { "documentation": "Subtracted from the C0 property to create an offset point for Part1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#C1", "code_sample": "" }, "@roblox/globaltype/JointInstance.Enabled": { "documentation": "Sets whether the joint is active or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#Enabled", "code_sample": "" }, "@roblox/globaltype/JointInstance.Part0": { "documentation": "The first BasePart that the joint connects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#Part0", "code_sample": "" }, "@roblox/globaltype/JointInstance.Part1": { "documentation": "The second BasePart that the joint connects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#Part1", "code_sample": "" }, "@roblox/globaltype/JointInstance.part1": { "documentation": "Deprecated: This deprecated property is a variant of Part1 which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/JointInstance#part1", "code_sample": "" }, "@roblox/globaltype/GuiButton": { "documentation": "An abstract class for interactive 2D user interface elements.", "keys": { "AutoButtonColor": "@roblox/globaltype/GuiButton.AutoButtonColor", "HoverHapticEffect": "@roblox/globaltype/GuiButton.HoverHapticEffect", "Modal": "@roblox/globaltype/GuiButton.Modal", "PressHapticEffect": "@roblox/globaltype/GuiButton.PressHapticEffect", "Selected": "@roblox/globaltype/GuiButton.Selected", "Style": "@roblox/globaltype/GuiButton.Style" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton", "code_sample": "" }, "@roblox/globaltype/GuiButton.AutoButtonColor": { "documentation": "Determines whether the button automatically changes color when the mouse hovers over or clicks on it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#AutoButtonColor", "code_sample": "" }, "@roblox/globaltype/GuiButton.HoverHapticEffect": { "documentation": "A HapticEffect instance that will play when the GuiButton is being hovered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#HoverHapticEffect", "code_sample": "" }, "@roblox/globaltype/GuiButton.Modal": { "documentation": "If true while the GUI element is visible, the mouse will not be locked unless the right mouse button is down.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#Modal", "code_sample": "" }, "@roblox/globaltype/GuiButton.PressHapticEffect": { "documentation": "A HapticEffect instance that will play when the GuiButton is being pressed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#PressHapticEffect", "code_sample": "" }, "@roblox/globaltype/GuiButton.Selected": { "documentation": "A boolean property which indicates whether the object has been selected.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#Selected", "code_sample": "" }, "@roblox/globaltype/GuiButton.Style": { "documentation": "Sets the style of the GuiButton based on a list of pre-determined styles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#Style", "code_sample": "" }, "@roblox/globaltype/GuiButton.Activated.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.Activated.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.Activated.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.Activated.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.Activated.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.Activated.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.Activated.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.Activated.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.Activated.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.Activated.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.Activated.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.Activated.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.Activated.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.Activated.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.Activated.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.Activated.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.Activated.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.Activated.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.Activated": { "documentation": "Fires when the button is activated.", "keys": { "Connect": "@roblox/globaltype/GuiButton.Activated.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.Activated.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.Activated.Once", "Wait": "@roblox/globaltype/GuiButton.Activated.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#Activated", "code_sample": "" }, "@roblox/globaltype/GuiButton.MouseButton1Click.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Click.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Click.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Click.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Click.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Click.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Click.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Click.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Click.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Click.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Click.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Click.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Click": { "documentation": "Fires when the user's mouse fully left clicks the GuiButton.", "keys": { "Connect": "@roblox/globaltype/GuiButton.MouseButton1Click.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.MouseButton1Click.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.MouseButton1Click.Once", "Wait": "@roblox/globaltype/GuiButton.MouseButton1Click.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton1Click", "code_sample": "" }, "@roblox/globaltype/GuiButton.MouseButton1Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Down": { "documentation": "Fires when the user presses their left mouse button down on the GuiButton.", "keys": { "Connect": "@roblox/globaltype/GuiButton.MouseButton1Down.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.MouseButton1Down.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.MouseButton1Down.Once", "Wait": "@roblox/globaltype/GuiButton.MouseButton1Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton1Down", "code_sample": "" }, "@roblox/globaltype/GuiButton.MouseButton1Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton1Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton1Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton1Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton1Up": { "documentation": "Fires when the user releases their left mouse button off of the GuiButton.", "keys": { "Connect": "@roblox/globaltype/GuiButton.MouseButton1Up.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.MouseButton1Up.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.MouseButton1Up.Once", "Wait": "@roblox/globaltype/GuiButton.MouseButton1Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton1Up", "code_sample": "" }, "@roblox/globaltype/GuiButton.MouseButton2Click.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Click.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Click.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Click.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Click.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Click.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Click.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Click.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Click.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Click.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Click.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Click.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Click": { "documentation": "Fires when the user's mouse fully right clicks the GuiButton.", "keys": { "Connect": "@roblox/globaltype/GuiButton.MouseButton2Click.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.MouseButton2Click.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.MouseButton2Click.Once", "Wait": "@roblox/globaltype/GuiButton.MouseButton2Click.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton2Click", "code_sample": "" }, "@roblox/globaltype/GuiButton.MouseButton2Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Down": { "documentation": "Fires when the user presses their right mouse button down on the GuiButton.", "keys": { "Connect": "@roblox/globaltype/GuiButton.MouseButton2Down.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.MouseButton2Down.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.MouseButton2Down.Once", "Wait": "@roblox/globaltype/GuiButton.MouseButton2Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton2Down", "code_sample": "" }, "@roblox/globaltype/GuiButton.MouseButton2Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.MouseButton2Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.MouseButton2Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.MouseButton2Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.MouseButton2Up": { "documentation": "Fires when the user releases their right mouse button off of the GuiButton.", "keys": { "Connect": "@roblox/globaltype/GuiButton.MouseButton2Up.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.MouseButton2Up.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.MouseButton2Up.Once", "Wait": "@roblox/globaltype/GuiButton.MouseButton2Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#MouseButton2Up", "code_sample": "" }, "@roblox/globaltype/GuiButton.SecondaryActivated.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.SecondaryActivated.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.SecondaryActivated.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.SecondaryActivated.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.SecondaryActivated.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.SecondaryActivated.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.SecondaryActivated.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.SecondaryActivated.Once/param/1": { "documentation": "" }, "@roblox/globaltype/GuiButton.SecondaryActivated.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/GuiButton.SecondaryActivated.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/GuiButton.SecondaryActivated.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/GuiButton.SecondaryActivated.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/GuiButton.SecondaryActivated": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/GuiButton.SecondaryActivated.Connect", "ConnectParallel": "@roblox/globaltype/GuiButton.SecondaryActivated.ConnectParallel", "Once": "@roblox/globaltype/GuiButton.SecondaryActivated.Once", "Wait": "@roblox/globaltype/GuiButton.SecondaryActivated.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiButton#SecondaryActivated", "code_sample": "" }, "@roblox/globaltype/PackageLink": { "documentation": "Links a DataModel instance to a corresponding asset in the cloud.", "keys": { "AutoUpdate": "@roblox/globaltype/PackageLink.AutoUpdate", "Creator": "@roblox/globaltype/PackageLink.Creator", "DefaultName": "@roblox/globaltype/PackageLink.DefaultName", "PackageAssetName": "@roblox/globaltype/PackageLink.PackageAssetName", "PackageId": "@roblox/globaltype/PackageLink.PackageId", "PermissionLevel": "@roblox/globaltype/PackageLink.PermissionLevel", "SerializedDefaultAttributes": "@roblox/globaltype/PackageLink.SerializedDefaultAttributes", "Status": "@roblox/globaltype/PackageLink.Status", "VersionNumber": "@roblox/globaltype/PackageLink.VersionNumber" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink", "code_sample": "" }, "@roblox/globaltype/PackageLink.AutoUpdate": { "documentation": "When this property is set to true, the package associated with the given PackageLink automatically updates to the latest version.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#AutoUpdate", "code_sample": "" }, "@roblox/globaltype/PackageLink.Creator": { "documentation": "The creator of the package asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#Creator", "code_sample": "" }, "@roblox/globaltype/PackageLink.DefaultName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#DefaultName", "code_sample": "" }, "@roblox/globaltype/PackageLink.PackageAssetName": { "documentation": "The asset name of the package.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#PackageAssetName", "code_sample": "" }, "@roblox/globaltype/PackageLink.PackageId": { "documentation": "The ID of the asset this package corresponds to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#PackageId", "code_sample": "" }, "@roblox/globaltype/PackageLink.PermissionLevel": { "documentation": "The package permission for the current Studio user.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#PermissionLevel", "code_sample": "" }, "@roblox/globaltype/PackageLink.SerializedDefaultAttributes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#SerializedDefaultAttributes", "code_sample": "" }, "@roblox/globaltype/PackageLink.Status": { "documentation": "The status of the package.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#Status", "code_sample": "" }, "@roblox/globaltype/PackageLink.VersionNumber": { "documentation": "Refers to a revision of a specific package.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PackageLink#VersionNumber", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyPages": { "documentation": "A special type of Pages object whose pages contain DataStoreKey instances.", "keys": { "Cursor": "@roblox/globaltype/DataStoreKeyPages.Cursor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyPages", "code_sample": "" }, "@roblox/globaltype/DataStoreKeyPages.Cursor": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreKeyPages#Cursor", "code_sample": "" }, "@roblox/globaltype/CurveAnimation": { "documentation": "Stores animation data in the form of curves for each individual channel to animate.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CurveAnimation", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect": { "documentation": "Adjusts the dynamic range of audio.", "keys": { "Attack": "@roblox/globaltype/CompressorSoundEffect.Attack", "GainMakeup": "@roblox/globaltype/CompressorSoundEffect.GainMakeup", "Ratio": "@roblox/globaltype/CompressorSoundEffect.Ratio", "Release": "@roblox/globaltype/CompressorSoundEffect.Release", "SideChain": "@roblox/globaltype/CompressorSoundEffect.SideChain", "Threshold": "@roblox/globaltype/CompressorSoundEffect.Threshold" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect.Attack": { "documentation": "The time the effect takes to become active after its Threshold has been reached.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#Attack", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect.GainMakeup": { "documentation": "The overall amplification applied to the effect's Sound or SoundGroup after attenuation of sounds above the threshold.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#GainMakeup", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect.Ratio": { "documentation": "The ratio between the SideChain sound effect, and this sound effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#Ratio", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect.Release": { "documentation": "The time the effect takes to become inactive after its sound is below the Threshold.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#Release", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect.SideChain": { "documentation": "Applies a ducking effect to the compressor sound effect. The behavior of the sidechain depends on the Sound or SoundGroup linked to it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#SideChain", "code_sample": "" }, "@roblox/globaltype/CompressorSoundEffect.Threshold": { "documentation": "Volume level at which point the compressor applies its effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#Threshold", "code_sample": "" }, "@roblox/globaltype/DataStoreVersionPages": { "documentation": "A special type of Pages object whose pages contain DataStoreObjectVersionInfo instances.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreVersionPages", "code_sample": "" }, "@roblox/globaltype/AnalyticsService": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences.", "keys": { "ApiKey": "@roblox/globaltype/AnalyticsService.ApiKey", "FireCustomEvent": "@roblox/globaltype/AnalyticsService.FireCustomEvent", "FireEvent": "@roblox/globaltype/AnalyticsService.FireEvent", "FireInGameEconomyEvent": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent", "FireLogEvent": "@roblox/globaltype/AnalyticsService.FireLogEvent", "FirePlayerProgressionEvent": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent", "LogCustomEvent": "@roblox/globaltype/AnalyticsService.LogCustomEvent", "LogEconomyEvent": "@roblox/globaltype/AnalyticsService.LogEconomyEvent", "LogFunnelStepEvent": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent", "LogOnboardingFunnelStepEvent": "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent", "LogProgressionCompleteEvent": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent", "LogProgressionEvent": "@roblox/globaltype/AnalyticsService.LogProgressionEvent", "LogProgressionFailEvent": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent", "LogProgressionStartEvent": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.ApiKey": { "documentation": "Deprecated:
PlayFab API key. Must be set in order to use FireEvent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#ApiKey", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/1": { "documentation": "The player who triggered the custom event. nil if not player related." }, "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/2": { "documentation": "User defined category. This should be the name of the event." }, "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/3": { "documentation": "Optional. User defined data, could be a string, a number or a table." }, "@roblox/globaltype/AnalyticsService.FireCustomEvent": { "documentation": "Deprecated:
Fires a custom event with a custom event name and data.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/1" }, { "name": "eventCategory", "documentation": "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/2" }, { "name": "customData", "documentation": "@roblox/globaltype/AnalyticsService.FireCustomEvent/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#FireCustomEvent", "code_sample": "local AnalyticsService = game:GetService(\"AnalyticsService\")\nlocal Players = game:GetService(\"Players\")\n\n-- server event, report a new server started\nlocal serverInfo = {\n\tTime = os.time(),\n\tPlaceId = game.PlaceId,\n}\n\nAnalyticsService:FireCustomEvent(nil, \"ServerStart\", serverInfo)\n\nPlayers.PlayerAdded:Connect(function(player)\n\tplayer.Chatted:Connect(function(message)\n\t\tlocal customData = {\n\t\t\tTime = os.time(),\n\t\t\tMessage = message,\n\t\t}\n\t\tAnalyticsService:FireCustomEvent(player, \"PlayerChatted\", customData)\n\tend)\nend)" }, "@roblox/globaltype/AnalyticsService.FireEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.FireEvent/param/1": { "documentation": "'The category of event to report. Cannot contain the following characters: comma ,, double quote \" or newline characters \\r\\n'." }, "@roblox/globaltype/AnalyticsService.FireEvent/param/2": { "documentation": "A value to be serialized and reported. Serialized length must not exceed 1 KiB, or 1024 bytes." }, "@roblox/globaltype/AnalyticsService.FireEvent": { "documentation": "Deprecated: This function has been deprecated in favor of more descriptive methods, including: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.FireEvent/param/0" }, { "name": "category", "documentation": "@roblox/globaltype/AnalyticsService.FireEvent/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/AnalyticsService.FireEvent/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#FireEvent", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/1": { "documentation": "The player who triggered the economy event." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/2": { "documentation": "The name of the item." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/3": { "documentation": "Indicates the acquisition or spending of an in game resource." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/4": { "documentation": "A user defined category for items such as \"Vehicle,\" \"Weapon.\"." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/5": { "documentation": "The amount of the currency." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/6": { "documentation": "The currency used. Examples: 'gold', 'gems', 'life.'." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/7": { "documentation": "The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this you can query which are the most popular \"stores\" then maybe you want to increase/lower the price for the stores. See the example below: 
local location = {     ["placeDesc"] = "Dungeon1",     ["levelDesc"] = "level2",     ["mapDesc"] = "LeftChamberMap",     ["storeName"] = "DarkSmith",     ["userDefinedKey"] = "0005" }
" }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/8": { "documentation": "Optional. User defined data, could be a string, a number or a table." }, "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent": { "documentation": "Deprecated:
Fire an event used to track player actions pertaining to the in-game economy.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/1" }, { "name": "itemName", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/2" }, { "name": "economyAction", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/3" }, { "name": "itemCategory", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/4" }, { "name": "amount", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/5" }, { "name": "currency", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/6" }, { "name": "location", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/7" }, { "name": "customData", "documentation": "@roblox/globaltype/AnalyticsService.FireInGameEconomyEvent/param/8" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#FireInGameEconomyEvent", "code_sample": "local AnalyticsService = game:GetService(\"AnalyticsService\")\n\nlocal gold = script.Parent\n\ngold.Touched:Connect(function(otherPart)\n\tlocal player = game.Players:GetPlayerFromCharacter(otherPart.Parent)\n\tif player == nil then\n\t\treturn\n\tend\n\n\tlocal location = {\n\t\t[\"Map\"] = \"someMap\",\n\t\t[\"Position\"] = tostring(gold.Position),\n\t}\n\n\tAnalyticsService:FireInGameEconomyEvent(\n\t\tplayer,\n\t\t\"Sword\", -- item name\n\t\tEnum.AnalyticsEconomyAction.Spend,\n\t\t\"Weapon\", -- itemCategory\n\t\t2020, -- amount of Gold\n\t\t\"Gold\", -- currency\n\t\tlocation,\n\t\t{ SomeCustomKey = \"SomeCustomValue\" }\n\t) -- optional customData\nend)" }, "@roblox/globaltype/AnalyticsService.FireLogEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.FireLogEvent/param/1": { "documentation": "The player who triggered the error event, nil if not player related." }, "@roblox/globaltype/AnalyticsService.FireLogEvent/param/2": { "documentation": "The specified log level (e.g. Debug, Error)." }, "@roblox/globaltype/AnalyticsService.FireLogEvent/param/3": { "documentation": "User defined message." }, "@roblox/globaltype/AnalyticsService.FireLogEvent/param/4": { "documentation": "Optional. A dictionary which contains predefined keys including \"errorCode\" and \"stackTrace\". Both keys values are strings. stackTrace is a traceback of the current function call stack. 
local debugInfo = {             errorCode = '123',             stackTrace = debug.traceback()       }
" }, "@roblox/globaltype/AnalyticsService.FireLogEvent/param/5": { "documentation": "Optional. User defined data, could be a string, a number or a table." }, "@roblox/globaltype/AnalyticsService.FireLogEvent": { "documentation": "Deprecated:
Fire a log event used to track errors and warnings experienced by players.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.FireLogEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.FireLogEvent/param/1" }, { "name": "logLevel", "documentation": "@roblox/globaltype/AnalyticsService.FireLogEvent/param/2" }, { "name": "message", "documentation": "@roblox/globaltype/AnalyticsService.FireLogEvent/param/3" }, { "name": "debugInfo", "documentation": "@roblox/globaltype/AnalyticsService.FireLogEvent/param/4" }, { "name": "customData", "documentation": "@roblox/globaltype/AnalyticsService.FireLogEvent/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#FireLogEvent", "code_sample": "local Players = game:GetService(\"Players\")\nlocal TeleportService = game:GetService(\"TeleportService\")\nlocal AnalyticsService = game:GetService(\"AnalyticsService\")\n\nlocal placeId = game.PlaceId\n\nlocal player = Players:GetPlayerByUserId(123)\n\nxpcall(function()\n\tTeleportService:Teleport(placeId, player)\nend, function(errorMessage)\n\tlocal debugInfo = {\n\t\terrorCode = \"TeleportFailed\",\n\t\tstackTrace = debug.traceback(), -- the function call stack\n\t}\n\tAnalyticsService:FireLogEvent(\n\t\tplayer,\n\t\tEnum.AnalyticsLogLevel.Error, -- log level\n\t\terrorMessage, -- message\n\t\tdebugInfo, -- optional\n\t\t{\n\t\t\tPlayerId = player.UserId,\n\t\t\tPlaceId = placeId,\n\t\t}\n\t) -- customData optional\nend)" }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/1": { "documentation": "The player who triggered the event." }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/2": { "documentation": "A user defined category for progression." }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/3": { "documentation": "Indicates the status of the progression." }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/4": { "documentation": "The event location. A dictionary that each key-value represents an entry of location data. The key-value is a string-string pair. With this developers can query where is the most frequent location for a specific progression event category. For example, the category could be \"LevelUp\". 
local location = {     ["placeDesc"] = "Dungeon1",     ["levelDesc"] = "level2",     ["mapDesc"] = "LeftChamberMap",     ["ProgresionType"] = "LevelUp",     ["userDefinedKey5"] = "0005" }
" }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/5": { "documentation": "Optional. A dictionary that each key-value represents an entry of statistics data that allows developers to track any specific data that they want to collect as players progress through their game. Key-Value is a string-number pair. 
local statistics = {     ["numberOfKills"] = 111,     ["numberOfExp"] = 222,     ["userDefinedKey3"] = number,     ["userDefinedKey4"] = number,     ["userDefinedKey5"] = number }
" }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/6": { "documentation": "Optional. User defined data, could be a string, a number or a table." }, "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent": { "documentation": "Deprecated:
Fire an event used to track player progression through the game.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/1" }, { "name": "category", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/2" }, { "name": "progressionStatus", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/3" }, { "name": "location", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/4" }, { "name": "statistics", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/5" }, { "name": "customData", "documentation": "@roblox/globaltype/AnalyticsService.FirePlayerProgressionEvent/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#FirePlayerProgressionEvent", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/1": { "documentation": "The user who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/2": { "documentation": "The name of the custom event." }, "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/3": { "documentation": "The value of the event that will be used in aggregation." }, "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/4": { "documentation": "Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience." }, "@roblox/globaltype/AnalyticsService.LogCustomEvent": { "documentation": "Logs an event used to track custom metrics of a user in experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/1" }, { "name": "eventName", "documentation": "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/2" }, { "name": "value", "documentation": "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/3" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogCustomEvent/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogCustomEvent", "code_sample": "local AnalyticsService = game:GetService(\"AnalyticsService\")\n\n-- Log when the mission starts\nAnalyticsService:LogCustomEvent(\n\tplayer,\n\t\"MissionStarted\" -- Custom event name\n)\n\n-- Log when the mission is completed with the time it took\nAnalyticsService:LogCustomEvent(\n\tplayer,\n\t\"MissionCompletedDuration\", -- Custom event name\n\t120 -- Event value used in aggregation\n)" }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/1": { "documentation": "The user who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/2": { "documentation": "Should specify the direction that currency is flowing using AnalyticsEconomyFlowType." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/3": { "documentation": "The name of the currency being added or removed, for example \"gold\", \"gems\", or \"energy\". Limited to 5 unique currency types per experience." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/4": { "documentation": "The amount of currency being added or removed. This value should always be positive." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/5": { "documentation": "The user's balance after the currency has been added or removed. This value should always be greater than or equal to 0." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/6": { "documentation": "The type of transaction that occurred. While you're free to use any transaction type, it's recommended to use the provided types from AnalyticsEconomyTransactionType such as \"IAP\" or \"ContextualPurchase\" to enable future insights from Roblox tools and charts. Because this field type is a string, you'll need to pass the Name value of the enum. For example Enum.AnalyticsEconomyTransactionType.IAP.Name. Limited to 20 unique types per experience." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/7": { "documentation": "Optional SKU of the item or bundle being purchased. This is a unique identifier for the item being purchased. Limited to 100 unique SKUs per experience." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/8": { "documentation": "Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience." }, "@roblox/globaltype/AnalyticsService.LogEconomyEvent": { "documentation": "Logs an event used to track player actions related in experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/1" }, { "name": "flowType", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/2" }, { "name": "currencyType", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/3" }, { "name": "amount", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/4" }, { "name": "endingBalance", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/5" }, { "name": "transactionType", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/6" }, { "name": "itemSku", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/7" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogEconomyEvent/param/8" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogEconomyEvent", "code_sample": "local AnalyticsService = game:GetService(\"AnalyticsService\")\n\nAnalyticsService:LogEconomyEvent(\n\tplayer,\n\tEnum.AnalyticsEconomyFlowType.Source,\n\t\"Coins\",\n\t1000, -- How many coins are in the bundle\n\t1020, -- balance after transaction\n\tEnum.AnalyticsEconomyTransactionType.IAP.Name,\n\t\"1000CoinBundle\" -- Unique identifier of the coin bundle\n)" }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/1": { "documentation": "The user who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/2": { "documentation": "The name of the funnel. This should be the same for all steps in the funnel. Limited to 10 unique funnels per experience." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/3": { "documentation": "Optional unique identifier for the funnel session. This should be the same for all steps in the funnel. Note that this field is only necessary for recurring funnels, for example a purchase flow funnel or an item upgrade funnel. If you don't have a natural funnel session identifier, it's recommended to use HttpService:GenerateGUID()." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/4": { "documentation": "The step number in the funnel. This should be unique for each step in the funnel. All funnels start at step 1. Limited to steps 1-100. Repeated steps by the same user in the same funnel session, or when funnelSessionId is nil will be ignored. Note that if any steps are skipped, the intermediate steps will be considered completed." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/5": { "documentation": "Optional name of the step in the funnel. This field is only used for display purposes in Roblox-provided charts." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/6": { "documentation": "Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience." }, "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent": { "documentation": "Logs an event used to track user actions stepping through a pre-planned funnel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/1" }, { "name": "funnelName", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/2" }, { "name": "funnelSessionId", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/3" }, { "name": "step", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/4" }, { "name": "stepName", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/5" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogFunnelStepEvent/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogFunnelStepEvent", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/1": { "documentation": "The user who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/2": { "documentation": "The step number in the funnel. This should be unique for each step in the funnel. All funnels start at step 1. Limited to steps 1-100. Note that if any steps are skipped, the intermediate steps will be considered completed." }, "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/3": { "documentation": "Optional name of the step in the funnel. This field is only used for display purposes in Roblox-provided charts." }, "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/4": { "documentation": "Optional dictionary of custom fields that will provide breakdowns in Roblox-provided charts. Only specific keys, provided by AnalyticsCustomFieldKeys, will be used for these breakdowns. Limited to 8,000 unique combinations of values across the three custom fields per experience." }, "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent": { "documentation": "Logs an event used to track user actions stepping through an onboarding funnel.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/1" }, { "name": "step", "documentation": "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/2" }, { "name": "stepName", "documentation": "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/3" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogOnboardingFunnelStepEvent/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogOnboardingFunnelStepEvent", "code_sample": "local AnalyticsService = game:GetService(\"AnalyticsService\")\n\n-- Log the first step of the FTUE\nAnalyticsService:LogOnboardingFunnelStepEvent(\n\tplayer,\n\t1, -- Step number\n\t\"Joined Game\" -- Step name\n)\n\n-- Log the second step of the FTUE\nAnalyticsService:LogOnboardingFunnelStepEvent(\n\tplayer,\n\t2, -- Step number\n\t\"Choose Class\" -- Step name\n)" }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/1": { "documentation": "The player who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/2": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/3": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/4": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/5": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent": { "documentation": "Logs an event for when a user has completed a level attempt.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/1" }, { "name": "progressionPathName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/2" }, { "name": "level", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/3" }, { "name": "levelName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/4" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionCompleteEvent/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogProgressionCompleteEvent", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/1": { "documentation": "The player who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/2": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/3": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/4": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/5": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/6": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionEvent": { "documentation": "Logs an event for when a user has started, completed, or failed a level attempt.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/1" }, { "name": "progressionPathName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/2" }, { "name": "status", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/3" }, { "name": "level", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/4" }, { "name": "levelName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/5" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionEvent/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogProgressionEvent", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/1": { "documentation": "The user who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/2": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/3": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/4": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/5": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent": { "documentation": "Logs an event for when a user has failed a level attempt.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/1" }, { "name": "progressionPathName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/2" }, { "name": "level", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/3" }, { "name": "levelName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/4" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionFailEvent/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogProgressionFailEvent", "code_sample": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/0": { "documentation": "Collection of methods that allows developers to track how users interact with their experiences." }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/1": { "documentation": "The player who triggered the event." }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/2": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/3": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/4": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/5": { "documentation": "" }, "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent": { "documentation": "Logs an event for when a user has started a level attempt.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/1" }, { "name": "progressionPathName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/2" }, { "name": "level", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/3" }, { "name": "levelName", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/4" }, { "name": "customFields", "documentation": "@roblox/globaltype/AnalyticsService.LogProgressionStartEvent/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#LogProgressionStartEvent", "code_sample": "" }, "@roblox/globaltype/RigidConstraint": { "documentation": "Creates a rigid connection between two Attachments or Bones.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RigidConstraint", "code_sample": "" }, "@roblox/globaltype/ModerationService": { "documentation": "", "keys": { "BindReviewableContentEventProcessor": "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor", "CreateReviewableContentAsync": "@roblox/globaltype/ModerationService.CreateReviewableContentAsync", "CreateReviewableContentKey": "@roblox/globaltype/ModerationService.CreateReviewableContentKey", "InternalRequestReviewableContentReviewAsync": "@roblox/globaltype/ModerationService.InternalRequestReviewableContentReviewAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModerationService", "code_sample": "" }, "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/param/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/param/1": { "documentation": "" }, "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/param/2": { "documentation": "" }, "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/return/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/param/0" }, { "name": "priority", "documentation": "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/param/1" }, { "name": "callback", "documentation": "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/param/2" } ], "returns": [ "@roblox/globaltype/ModerationService.BindReviewableContentEventProcessor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModerationService#BindReviewableContentEventProcessor", "code_sample": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentAsync/return/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ModerationService.CreateReviewableContentAsync/param/0" }, { "name": "config", "documentation": "@roblox/globaltype/ModerationService.CreateReviewableContentAsync/param/1" } ], "returns": [ "@roblox/globaltype/ModerationService.CreateReviewableContentAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentAsync", "code_sample": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentKey/param/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentKey/param/1": { "documentation": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentKey/return/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.CreateReviewableContentKey": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ModerationService.CreateReviewableContentKey/param/0" }, { "name": "content", "documentation": "@roblox/globaltype/ModerationService.CreateReviewableContentKey/param/1" } ], "returns": [ "@roblox/globaltype/ModerationService.CreateReviewableContentKey/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey", "code_sample": "" }, "@roblox/globaltype/ModerationService.InternalRequestReviewableContentReviewAsync/param/0": { "documentation": "" }, "@roblox/globaltype/ModerationService.InternalRequestReviewableContentReviewAsync/param/1": { "documentation": "" }, "@roblox/globaltype/ModerationService.InternalRequestReviewableContentReviewAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ModerationService.InternalRequestReviewableContentReviewAsync/param/0" }, { "name": "config", "documentation": "@roblox/globaltype/ModerationService.InternalRequestReviewableContentReviewAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModerationService#InternalRequestReviewableContentReviewAsync", "code_sample": "" }, "@roblox/globaltype/SpawnLocation": { "documentation": "SpawnLocations, or \"spawns\" determine where a Player respawns when they die. They can be configured to allow only certain players to use each spawn, using Teams. They also control how ForceFields are set up for newly-spawned players.", "keys": { "AllowTeamChangeOnTouch": "@roblox/globaltype/SpawnLocation.AllowTeamChangeOnTouch", "Duration": "@roblox/globaltype/SpawnLocation.Duration", "Enabled": "@roblox/globaltype/SpawnLocation.Enabled", "Neutral": "@roblox/globaltype/SpawnLocation.Neutral", "TeamColor": "@roblox/globaltype/SpawnLocation.TeamColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnLocation", "code_sample": "" }, "@roblox/globaltype/SpawnLocation.AllowTeamChangeOnTouch": { "documentation": "Allows a Player to join the team by touching the SpawnLocation. When set to true, if a Player character comes into contact with the SpawnLocation, the player's Player.TeamColor will be set to SpawnLocation.TeamColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnLocation#AllowTeamChangeOnTouch", "code_sample": "" }, "@roblox/globaltype/SpawnLocation.Duration": { "documentation": "The length of time, in seconds, that a ForceField will be applied to a Player character spawning at this SpawnLocation. If Duration is zero, the ForceField is never created, and it will not trigger the Instance.DescendantAdded or Instance.ChildAdded events.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnLocation#Duration", "code_sample": "local spawnLocation = Instance.new(\"SpawnLocation\")\nspawnLocation.Anchored = true\nspawnLocation.Size = Vector3.new(5, 1, 5)\nspawnLocation.Neutral = true -- anyone can spawn here\nspawnLocation.Duration = 20\nspawnLocation.Parent = workspace" }, "@roblox/globaltype/SpawnLocation.Enabled": { "documentation": "Sets whether or not the SpawnLocation is enabled. When disabled players cannot spawn at the SpawnLocation and the AllowTeamChangeOnTouch functionality is disabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnLocation#Enabled", "code_sample": "local spawnLocation = Instance.new(\"SpawnLocation\")\nspawnLocation.Anchored = true\nspawnLocation.Size = Vector3.new(5, 1, 5)\nspawnLocation.Neutral = true -- anyone can spawn here\nspawnLocation.Enabled = true\nspawnLocation.Parent = workspace\n\nlocal function onEnabledChanged()\n\tspawnLocation.Transparency = spawnLocation.Enabled and 0 or 0.5\nend\n\nspawnLocation:GetPropertyChangedSignal(\"Enabled\"):Connect(onEnabledChanged)\n\ntask.wait(5)\n\nspawnLocation.Enabled = false -- transparency = 0.5" }, "@roblox/globaltype/SpawnLocation.Neutral": { "documentation": "Whether or not a SpawnLocation is affiliated with a specific team. This means that any Player, of any Team, can spawn on it if this property is set to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnLocation#Neutral", "code_sample": "" }, "@roblox/globaltype/SpawnLocation.TeamColor": { "documentation": "Sets what team the SpawnLocation is affiliated to. If SpawnLocation.Neutral property is false, only Players with the same Player.TeamColor as the spawn's TeamColor will be able to spawn there.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnLocation#TeamColor", "code_sample": "" }, "@roblox/globaltype/PointLight": { "documentation": "A light source that emits illumination from a single point.", "keys": { "Range": "@roblox/globaltype/PointLight.Range" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointLight", "code_sample": "local part = Instance.new(\"Part\")\npart.Anchored = true\npart.Position = Vector3.new(0, 0, 0)\npart.Parent = workspace\n\nlocal light = Instance.new(\"PointLight\")\nlight.Color = Color3.new(1, 1, 1)\nlight.Brightness = 1\nlight.Range = 16\nlight.Parent = part" }, "@roblox/globaltype/PointLight.Range": { "documentation": "The size of the area that the PointLight will illuminate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PointLight#Range", "code_sample": "" }, "@roblox/globaltype/ServerScriptService": { "documentation": "A container service for server-only Script objects.", "keys": { "LoadStringEnabled": "@roblox/globaltype/ServerScriptService.LoadStringEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServerScriptService", "code_sample": "" }, "@roblox/globaltype/ServerScriptService.LoadStringEnabled": { "documentation": "Toggles whether or not the loadstring function can be used by server scripts. Defaults to false.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ServerScriptService#LoadStringEnabled", "code_sample": "" }, "@roblox/globaltype/LuaSourceContainer": { "documentation": "The base class for all objects which contain Luau code.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LuaSourceContainer", "code_sample": "" }, "@roblox/globaltype/UISizeConstraint": { "documentation": "Ensures a GuiObject does not become larger or smaller than the constraint's maximum size or minimum size.", "keys": { "MaxSize": "@roblox/globaltype/UISizeConstraint.MaxSize", "MinSize": "@roblox/globaltype/UISizeConstraint.MinSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UISizeConstraint", "code_sample": "" }, "@roblox/globaltype/UISizeConstraint.MaxSize": { "documentation": "The largest size, in pixels, the parent object is allowed to be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UISizeConstraint#MaxSize", "code_sample": "" }, "@roblox/globaltype/UISizeConstraint.MinSize": { "documentation": "The smallest size, in pixels, the object is allowed to be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UISizeConstraint#MinSize", "code_sample": "" }, "@roblox/globaltype/PartOperation": { "documentation": "An abstract class that all parts based on solid modeling inherit from.", "keys": { "RenderFidelity": "@roblox/globaltype/PartOperation.RenderFidelity", "SmoothingAngle": "@roblox/globaltype/PartOperation.SmoothingAngle", "TriangleCount": "@roblox/globaltype/PartOperation.TriangleCount", "UsePartColor": "@roblox/globaltype/PartOperation.UsePartColor", "SubstituteGeometry": "@roblox/globaltype/PartOperation.SubstituteGeometry" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperation", "code_sample": "" }, "@roblox/globaltype/PartOperation.RenderFidelity": { "documentation": "The level of detail used to render the solid modeled part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperation#RenderFidelity", "code_sample": "" }, "@roblox/globaltype/PartOperation.SmoothingAngle": { "documentation": "An angle in degrees which affects the smooth shading of a solid modeled part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperation#SmoothingAngle", "code_sample": "" }, "@roblox/globaltype/PartOperation.TriangleCount": { "documentation": "The number of polygons in this solid model.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperation#TriangleCount", "code_sample": "" }, "@roblox/globaltype/PartOperation.UsePartColor": { "documentation": "Sets whether the PartOperation can be recolored using inherited color properties.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperation#UsePartColor", "code_sample": "" }, "@roblox/globaltype/PartOperation.SubstituteGeometry/param/0": { "documentation": "An abstract class that all parts based on solid modeling inherit from." }, "@roblox/globaltype/PartOperation.SubstituteGeometry/param/1": { "documentation": "The PartOperation whose geometry will substitute the geometry of this PartOperation." }, "@roblox/globaltype/PartOperation.SubstituteGeometry": { "documentation": "Substitutes the geometry of this PartOperation with the geometry of another PartOperation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PartOperation.SubstituteGeometry/param/0" }, { "name": "source", "documentation": "@roblox/globaltype/PartOperation.SubstituteGeometry/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PartOperation#SubstituteGeometry", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer": { "documentation": "Adjusts the frequency content of audio streams.", "keys": { "Bypass": "@roblox/globaltype/AudioEqualizer.Bypass", "HighGain": "@roblox/globaltype/AudioEqualizer.HighGain", "LowGain": "@roblox/globaltype/AudioEqualizer.LowGain", "MidGain": "@roblox/globaltype/AudioEqualizer.MidGain", "MidRange": "@roblox/globaltype/AudioEqualizer.MidRange", "GetConnectedWires": "@roblox/globaltype/AudioEqualizer.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioEqualizer.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioEqualizer.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.HighGain": { "documentation": "Gain value to be applied to the frequency content of the highest band in the equalizer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#HighGain", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.LowGain": { "documentation": "Gain value to be applied to the frequency content of the lowest band in the equalizer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#LowGain", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.MidGain": { "documentation": "Gain value to be applied to the frequency content of the middle band in the equalizer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#MidGain", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.MidRange": { "documentation": "The frequency range of the band influenced by MidGain.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#MidRange", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.GetConnectedWires/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioEqualizer.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioEqualizer.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioEqualizer.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.GetInputPins/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioEqualizer.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioEqualizer.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.GetOutputPins/param/0": { "documentation": "Adjusts the frequency content of audio streams." }, "@roblox/globaltype/AudioEqualizer.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioEqualizer.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEqualizer.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEqualizer.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEqualizer.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEqualizer.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioEqualizer.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioEqualizer via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioEqualizer.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioEqualizer.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioEqualizer.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioEqualizer.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#WiringChanged", "code_sample": "" }, "@roblox/globaltype/UIListLayout": { "documentation": "Positions sibling UI elements in rows or columns within the parent UI container.", "keys": { "HorizontalFlex": "@roblox/globaltype/UIListLayout.HorizontalFlex", "ItemLineAlignment": "@roblox/globaltype/UIListLayout.ItemLineAlignment", "Padding": "@roblox/globaltype/UIListLayout.Padding", "VerticalFlex": "@roblox/globaltype/UIListLayout.VerticalFlex", "Wraps": "@roblox/globaltype/UIListLayout.Wraps" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIListLayout", "code_sample": "" }, "@roblox/globaltype/UIListLayout.HorizontalFlex": { "documentation": "Controls how to distribute extra horizontal space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIListLayout#HorizontalFlex", "code_sample": "" }, "@roblox/globaltype/UIListLayout.ItemLineAlignment": { "documentation": "In a flex layout, defines the cross-directional alignment of siblings within a line.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIListLayout#ItemLineAlignment", "code_sample": "" }, "@roblox/globaltype/UIListLayout.Padding": { "documentation": "Amount of free space between each element.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIListLayout#Padding", "code_sample": "" }, "@roblox/globaltype/UIListLayout.VerticalFlex": { "documentation": "Controls how to distribute extra vertical space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIListLayout#VerticalFlex", "code_sample": "" }, "@roblox/globaltype/UIListLayout.Wraps": { "documentation": "Controls whether siblings within the parent container wrap.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIListLayout#Wraps", "code_sample": "" }, "@roblox/globaltype/PluginManager": { "documentation": "", "keys": { "CreatePlugin": "@roblox/globaltype/PluginManager.CreatePlugin", "ExportPlace": "@roblox/globaltype/PluginManager.ExportPlace", "ExportSelection": "@roblox/globaltype/PluginManager.ExportSelection" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManager", "code_sample": "" }, "@roblox/globaltype/PluginManager.CreatePlugin/param/0": { "documentation": "" }, "@roblox/globaltype/PluginManager.CreatePlugin/return/0": { "documentation": "" }, "@roblox/globaltype/PluginManager.CreatePlugin": { "documentation": "Deprecated: The steps to create a plugin have changed. To learn more, see Plugin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginManager.CreatePlugin/param/0" } ], "returns": [ "@roblox/globaltype/PluginManager.CreatePlugin/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManager#CreatePlugin", "code_sample": "" }, "@roblox/globaltype/PluginManager.ExportPlace/param/0": { "documentation": "" }, "@roblox/globaltype/PluginManager.ExportPlace/param/1": { "documentation": "" }, "@roblox/globaltype/PluginManager.ExportPlace": { "documentation": "Exports the place to an .obj file that is saved to the path chosen by the user in a file save dialogue.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginManager.ExportPlace/param/0" }, { "name": "filePath", "documentation": "@roblox/globaltype/PluginManager.ExportPlace/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManager#ExportPlace", "code_sample": "" }, "@roblox/globaltype/PluginManager.ExportSelection/param/0": { "documentation": "" }, "@roblox/globaltype/PluginManager.ExportSelection/param/1": { "documentation": "" }, "@roblox/globaltype/PluginManager.ExportSelection": { "documentation": "Exports the current Selection to an .obj file that is saved to the path chosen by the user in a file save dialogue.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginManager.ExportSelection/param/0" }, { "name": "filePath", "documentation": "@roblox/globaltype/PluginManager.ExportSelection/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginManager#ExportSelection", "code_sample": "" }, "@roblox/globaltype/OrderedDataStore": { "documentation": "A GlobalDataStore that also allows for ordered data store entries.", "keys": { "GetSortedAsync": "@roblox/globaltype/OrderedDataStore.GetSortedAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OrderedDataStore", "code_sample": "" }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/0": { "documentation": "A GlobalDataStore that also allows for ordered data store entries." }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/1": { "documentation": "A boolean indicating whether the returned data pages are in ascending order." }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/2": { "documentation": "The length of each page. By default is 50. The max allowed value is 100." }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/3": { "documentation": "Optional parameter. If set, data pages with a value less than minValue will be excluded." }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/4": { "documentation": "Optional parameter. If set, data pages with a value greater than maxValue will be excluded." }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync/return/0": { "documentation": "A sorted DataStorePages object based on the provided arguments." }, "@roblox/globaltype/OrderedDataStore.GetSortedAsync": { "documentation": "Returns a DataStorePages object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/0" }, { "name": "ascending", "documentation": "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/1" }, { "name": "pagesize", "documentation": "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/2" }, { "name": "minValue", "documentation": "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/3" }, { "name": "maxValue", "documentation": "@roblox/globaltype/OrderedDataStore.GetSortedAsync/param/4" } ], "returns": [ "@roblox/globaltype/OrderedDataStore.GetSortedAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OrderedDataStore#GetSortedAsync", "code_sample": "" }, "@roblox/globaltype/Path2D": { "documentation": "", "keys": { "Closed": "@roblox/globaltype/Path2D.Closed", "Color3": "@roblox/globaltype/Path2D.Color3", "SelectedControlPoint": "@roblox/globaltype/Path2D.SelectedControlPoint", "SelectedControlPointData": "@roblox/globaltype/Path2D.SelectedControlPointData", "Thickness": "@roblox/globaltype/Path2D.Thickness", "Visible": "@roblox/globaltype/Path2D.Visible", "ZIndex": "@roblox/globaltype/Path2D.ZIndex", "GetBoundingRect": "@roblox/globaltype/Path2D.GetBoundingRect", "GetControlPoint": "@roblox/globaltype/Path2D.GetControlPoint", "GetControlPoints": "@roblox/globaltype/Path2D.GetControlPoints", "GetLength": "@roblox/globaltype/Path2D.GetLength", "GetMaxControlPoints": "@roblox/globaltype/Path2D.GetMaxControlPoints", "GetPositionOnCurve": "@roblox/globaltype/Path2D.GetPositionOnCurve", "GetPositionOnCurveArcLength": "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength", "GetTangentOnCurve": "@roblox/globaltype/Path2D.GetTangentOnCurve", "GetTangentOnCurveArcLength": "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength", "InsertControlPoint": "@roblox/globaltype/Path2D.InsertControlPoint", "RemoveControlPoint": "@roblox/globaltype/Path2D.RemoveControlPoint", "SetControlPoints": "@roblox/globaltype/Path2D.SetControlPoints", "UpdateControlPoint": "@roblox/globaltype/Path2D.UpdateControlPoint" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D", "code_sample": "" }, "@roblox/globaltype/Path2D.Closed": { "documentation": "Connects the first and last control points when enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#Closed", "code_sample": "" }, "@roblox/globaltype/Path2D.Color3": { "documentation": "Determines the color of the Path2D.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#Color3", "code_sample": "" }, "@roblox/globaltype/Path2D.SelectedControlPoint": { "documentation": "Index of the currently selected Path2DControlPoint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#SelectedControlPoint", "code_sample": "" }, "@roblox/globaltype/Path2D.SelectedControlPointData": { "documentation": "Path2DControlPoint data type representing the currently selected control point.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#SelectedControlPointData", "code_sample": "" }, "@roblox/globaltype/Path2D.Thickness": { "documentation": "Determines how thick the Path2D path is.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#Thickness", "code_sample": "" }, "@roblox/globaltype/Path2D.Visible": { "documentation": "Determines if the Path2D path is rendered or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#Visible", "code_sample": "" }, "@roblox/globaltype/Path2D.ZIndex": { "documentation": "Determines the order in which a Path2D path renders relative to other GUIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#ZIndex", "code_sample": "" }, "@roblox/globaltype/Path2D.GetBoundingRect/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetBoundingRect/return/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetBoundingRect": { "documentation": "Returns the bounding size for the Path2D.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetBoundingRect/param/0" } ], "returns": [ "@roblox/globaltype/Path2D.GetBoundingRect/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetBoundingRect", "code_sample": "" }, "@roblox/globaltype/Path2D.GetControlPoint/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetControlPoint/param/1": { "documentation": "" }, "@roblox/globaltype/Path2D.GetControlPoint/return/0": { "documentation": "The control point at the given index." }, "@roblox/globaltype/Path2D.GetControlPoint": { "documentation": "Returns the Path2DControlPoint for a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetControlPoint/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/Path2D.GetControlPoint/param/1" } ], "returns": [ "@roblox/globaltype/Path2D.GetControlPoint/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetControlPoint", "code_sample": "" }, "@roblox/globaltype/Path2D.GetControlPoints/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetControlPoints/return/0": { "documentation": "Table of all the Path2DControlPoints." }, "@roblox/globaltype/Path2D.GetControlPoints": { "documentation": "Returns all the Path2DControlPoints for the Path2D.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetControlPoints/param/0" } ], "returns": [ "@roblox/globaltype/Path2D.GetControlPoints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetControlPoints", "code_sample": "" }, "@roblox/globaltype/Path2D.GetLength/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetLength/return/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetLength": { "documentation": "Returns the length of the Path2D.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetLength/param/0" } ], "returns": [ "@roblox/globaltype/Path2D.GetLength/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetLength", "code_sample": "" }, "@roblox/globaltype/Path2D.GetMaxControlPoints/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetMaxControlPoints/return/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetMaxControlPoints": { "documentation": "Returns the maximum allowed number of control points.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetMaxControlPoints/param/0" } ], "returns": [ "@roblox/globaltype/Path2D.GetMaxControlPoints/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetMaxControlPoints", "code_sample": "" }, "@roblox/globaltype/Path2D.GetPositionOnCurve/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetPositionOnCurve/param/1": { "documentation": "The value to query the Path2D at." }, "@roblox/globaltype/Path2D.GetPositionOnCurve/return/0": { "documentation": "The position in parameter space." }, "@roblox/globaltype/Path2D.GetPositionOnCurve": { "documentation": "Returns the position at a given value in parameter space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetPositionOnCurve/param/0" }, { "name": "t", "documentation": "@roblox/globaltype/Path2D.GetPositionOnCurve/param/1" } ], "returns": [ "@roblox/globaltype/Path2D.GetPositionOnCurve/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetPositionOnCurve", "code_sample": "" }, "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength/param/1": { "documentation": "The value to query the Path2D at." }, "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength/return/0": { "documentation": "The position in arc length space." }, "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength": { "documentation": "Returns the position at a given value in arc length space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength/param/0" }, { "name": "t", "documentation": "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength/param/1" } ], "returns": [ "@roblox/globaltype/Path2D.GetPositionOnCurveArcLength/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetPositionOnCurveArcLength", "code_sample": "" }, "@roblox/globaltype/Path2D.GetTangentOnCurve/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetTangentOnCurve/param/1": { "documentation": "The value to query the Path2D at." }, "@roblox/globaltype/Path2D.GetTangentOnCurve/return/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetTangentOnCurve": { "documentation": "Returns the tangent at a given value in parameter space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetTangentOnCurve/param/0" }, { "name": "t", "documentation": "@roblox/globaltype/Path2D.GetTangentOnCurve/param/1" } ], "returns": [ "@roblox/globaltype/Path2D.GetTangentOnCurve/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetTangentOnCurve", "code_sample": "" }, "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength/param/1": { "documentation": "The value to query the Path2D at." }, "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength/return/0": { "documentation": "The tangent in arc length space." }, "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength": { "documentation": "Returns the tangent at a given value in arc length space.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength/param/0" }, { "name": "t", "documentation": "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength/param/1" } ], "returns": [ "@roblox/globaltype/Path2D.GetTangentOnCurveArcLength/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#GetTangentOnCurveArcLength", "code_sample": "" }, "@roblox/globaltype/Path2D.InsertControlPoint/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.InsertControlPoint/param/1": { "documentation": "The index to insert at." }, "@roblox/globaltype/Path2D.InsertControlPoint/param/2": { "documentation": "The control point to insert." }, "@roblox/globaltype/Path2D.InsertControlPoint": { "documentation": "Inserts a new control point at a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.InsertControlPoint/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/Path2D.InsertControlPoint/param/1" }, { "name": "point", "documentation": "@roblox/globaltype/Path2D.InsertControlPoint/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#InsertControlPoint", "code_sample": "" }, "@roblox/globaltype/Path2D.RemoveControlPoint/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.RemoveControlPoint/param/1": { "documentation": "The index to remove at." }, "@roblox/globaltype/Path2D.RemoveControlPoint": { "documentation": "Removes a control at the given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.RemoveControlPoint/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/Path2D.RemoveControlPoint/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#RemoveControlPoint", "code_sample": "" }, "@roblox/globaltype/Path2D.SetControlPoints/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.SetControlPoints/param/1": { "documentation": "The new list of control points to set." }, "@roblox/globaltype/Path2D.SetControlPoints": { "documentation": "Sets all the control points to the specified array, replacing all existing points with new ones.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.SetControlPoints/param/0" }, { "name": "controlPoints", "documentation": "@roblox/globaltype/Path2D.SetControlPoints/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#SetControlPoints", "code_sample": "" }, "@roblox/globaltype/Path2D.UpdateControlPoint/param/0": { "documentation": "" }, "@roblox/globaltype/Path2D.UpdateControlPoint/param/1": { "documentation": "The control point index to update." }, "@roblox/globaltype/Path2D.UpdateControlPoint/param/2": { "documentation": "" }, "@roblox/globaltype/Path2D.UpdateControlPoint": { "documentation": "Updates a control point at the given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.UpdateControlPoint/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/Path2D.UpdateControlPoint/param/1" }, { "name": "point", "documentation": "@roblox/globaltype/Path2D.UpdateControlPoint/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#UpdateControlPoint", "code_sample": "" }, "@roblox/globaltype/Path2D.ControlPointChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path2D.ControlPointChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Path2D.ControlPointChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Path2D.ControlPointChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path2D.ControlPointChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Path2D.ControlPointChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Path2D.ControlPointChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path2D.ControlPointChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Path2D.ControlPointChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Path2D.ControlPointChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Path2D.ControlPointChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Path2D.ControlPointChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Path2D.ControlPointChanged": { "documentation": "Fires any time control points change.", "keys": { "Connect": "@roblox/globaltype/Path2D.ControlPointChanged.Connect", "ConnectParallel": "@roblox/globaltype/Path2D.ControlPointChanged.ConnectParallel", "Once": "@roblox/globaltype/Path2D.ControlPointChanged.Once", "Wait": "@roblox/globaltype/Path2D.ControlPointChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Path2D#ControlPointChanged", "code_sample": "" }, "@roblox/globaltype/GameSettings": { "documentation": "A container for miscellaneous in-game options.", "keys": { "VideoCaptureEnabled": "@roblox/globaltype/GameSettings.VideoCaptureEnabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GameSettings", "code_sample": "" }, "@roblox/globaltype/GameSettings.VideoCaptureEnabled": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GameSettings#VideoCaptureEnabled", "code_sample": "" }, "@roblox/globaltype/VisualizationModeCategory": { "documentation": "", "keys": { "Enabled": "@roblox/globaltype/VisualizationModeCategory.Enabled", "Title": "@roblox/globaltype/VisualizationModeCategory.Title" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationModeCategory", "code_sample": "" }, "@roblox/globaltype/VisualizationModeCategory.Enabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationModeCategory#Enabled", "code_sample": "" }, "@roblox/globaltype/VisualizationModeCategory.Title": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationModeCategory#Title", "code_sample": "" }, "@roblox/globaltype/GuiBase": { "documentation": "GuiBase is an abstract class which most graphical user interface objects inherit from.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase", "code_sample": "" }, "@roblox/globaltype/ValueCurve": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value.", "keys": { "Length": "@roblox/globaltype/ValueCurve.Length", "ValueType": "@roblox/globaltype/ValueCurve.ValueType", "GetKeyAtIndex": "@roblox/globaltype/ValueCurve.GetKeyAtIndex", "GetKeyIndicesAtTime": "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime", "GetKeys": "@roblox/globaltype/ValueCurve.GetKeys", "GetValueAtTime": "@roblox/globaltype/ValueCurve.GetValueAtTime", "InsertKey": "@roblox/globaltype/ValueCurve.InsertKey", "InsertKeyValue": "@roblox/globaltype/ValueCurve.InsertKeyValue", "RemoveKeyAtIndex": "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex", "SetKeys": "@roblox/globaltype/ValueCurve.SetKeys" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve", "code_sample": "" }, "@roblox/globaltype/ValueCurve.Length": { "documentation": "Number of keys in the value curve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#Length", "code_sample": "" }, "@roblox/globaltype/ValueCurve.ValueType": { "documentation": "Read-only value indicating the type held in this curve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#ValueType", "code_sample": "" }, "@roblox/globaltype/ValueCurve.GetKeyAtIndex/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.GetKeyAtIndex/param/1": { "documentation": "The index in the existing set of keys held by this ValueCurve." }, "@roblox/globaltype/ValueCurve.GetKeyAtIndex/return/0": { "documentation": "" }, "@roblox/globaltype/ValueCurve.GetKeyAtIndex": { "documentation": "Returns a copy of a key at a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.GetKeyAtIndex/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/ValueCurve.GetKeyAtIndex/param/1" } ], "returns": [ "@roblox/globaltype/ValueCurve.GetKeyAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyAtIndex", "code_sample": "" }, "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime/param/1": { "documentation": "A time during the animation. Inputs will be clamped between 0 and the time of the last key held by this ValueCurve." }, "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime/return/0": { "documentation": "" }, "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime": { "documentation": "Returns the index of the last and first key of a period of time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime/param/1" } ], "returns": [ "@roblox/globaltype/ValueCurve.GetKeyIndicesAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeyIndicesAtTime", "code_sample": "" }, "@roblox/globaltype/ValueCurve.GetKeys/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.GetKeys/return/0": { "documentation": "Array of ValueCurveKeys." }, "@roblox/globaltype/ValueCurve.GetKeys": { "documentation": "Returns a copy of all the keys in the ValueCurve as a Luau array of ValueCurveKeys.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.GetKeys/param/0" } ], "returns": [ "@roblox/globaltype/ValueCurve.GetKeys/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetKeys", "code_sample": "" }, "@roblox/globaltype/ValueCurve.GetValueAtTime/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.GetValueAtTime/param/1": { "documentation": "Time at which to sample the curve." }, "@roblox/globaltype/ValueCurve.GetValueAtTime/return/0": { "documentation": "Value of the curve at the requested time." }, "@roblox/globaltype/ValueCurve.GetValueAtTime": { "documentation": "Samples the value curve at a given time passed as argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.GetValueAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/ValueCurve.GetValueAtTime/param/1" } ], "returns": [ "@roblox/globaltype/ValueCurve.GetValueAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#GetValueAtTime", "code_sample": "" }, "@roblox/globaltype/ValueCurve.InsertKey/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.InsertKey/param/1": { "documentation": "ValueCurveKey to insert." }, "@roblox/globaltype/ValueCurve.InsertKey/return/0": { "documentation": "(see description)" }, "@roblox/globaltype/ValueCurve.InsertKey": { "documentation": "Adds the key passed as an argument to this curve. If a key at the same time is found, it will be replaced.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.InsertKey/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/ValueCurve.InsertKey/param/1" } ], "returns": [ "@roblox/globaltype/ValueCurve.InsertKey/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKey", "code_sample": "" }, "@roblox/globaltype/ValueCurve.InsertKeyValue/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.InsertKeyValue/param/1": { "documentation": "Time at which to insert the new ValueCurveKey. - type: number" }, "@roblox/globaltype/ValueCurve.InsertKeyValue/param/2": { "documentation": "Value of the inserted ValueCurveKey. - type: any" }, "@roblox/globaltype/ValueCurve.InsertKeyValue/param/3": { "documentation": "Interpolation mode of the inserted ValueCurveKey. - type: KeyInterpolationMode" }, "@roblox/globaltype/ValueCurve.InsertKeyValue/return/0": { "documentation": "(see description)" }, "@roblox/globaltype/ValueCurve.InsertKeyValue": { "documentation": "Creates a key for the given value and inserts it at the given time. If a key at the same time is found, it will be replaced.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.InsertKeyValue/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/ValueCurve.InsertKeyValue/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/ValueCurve.InsertKeyValue/param/2" }, { "name": "Interpolation", "documentation": "@roblox/globaltype/ValueCurve.InsertKeyValue/param/3" } ], "returns": [ "@roblox/globaltype/ValueCurve.InsertKeyValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#InsertKeyValue", "code_sample": "" }, "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/param/1": { "documentation": "Starting index from which to remove keys." }, "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/param/2": { "documentation": "Number of keys to remove." }, "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/return/0": { "documentation": "Number of keys removed." }, "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex": { "documentation": "Removes a given number of keys starting from a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/param/0" }, { "name": "startingIndex", "documentation": "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/param/1" }, { "name": "count", "documentation": "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/param/2" } ], "returns": [ "@roblox/globaltype/ValueCurve.RemoveKeyAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#RemoveKeyAtIndex", "code_sample": "" }, "@roblox/globaltype/ValueCurve.SetKeys/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a any type of value." }, "@roblox/globaltype/ValueCurve.SetKeys/param/1": { "documentation": "Array of ValueCurveKeys." }, "@roblox/globaltype/ValueCurve.SetKeys/return/0": { "documentation": "Number of keys inserted." }, "@roblox/globaltype/ValueCurve.SetKeys": { "documentation": "Resets this curve's keys using the ValueCurveKey array passed as an argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ValueCurve.SetKeys/param/0" }, { "name": "keys", "documentation": "@roblox/globaltype/ValueCurve.SetKeys/param/1" } ], "returns": [ "@roblox/globaltype/ValueCurve.SetKeys/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ValueCurve#SetKeys", "code_sample": "" }, "@roblox/globaltype/Pages": { "documentation": "An abstract class for pages objects.", "keys": { "IsFinished": "@roblox/globaltype/Pages.IsFinished", "AdvanceToNextPageAsync": "@roblox/globaltype/Pages.AdvanceToNextPageAsync", "GetCurrentPage": "@roblox/globaltype/Pages.GetCurrentPage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pages", "code_sample": "" }, "@roblox/globaltype/Pages.IsFinished": { "documentation": "Whether or not the current page is the last page available.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pages#IsFinished", "code_sample": "" }, "@roblox/globaltype/Pages.AdvanceToNextPageAsync/param/0": { "documentation": "An abstract class for pages objects." }, "@roblox/globaltype/Pages.AdvanceToNextPageAsync": { "documentation": "Iterates to the next page in the pages object, if possible.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Pages.AdvanceToNextPageAsync/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pages#AdvanceToNextPageAsync", "code_sample": "" }, "@roblox/globaltype/Pages.GetCurrentPage/param/0": { "documentation": "An abstract class for pages objects." }, "@roblox/globaltype/Pages.GetCurrentPage/return/0": { "documentation": "" }, "@roblox/globaltype/Pages.GetCurrentPage": { "documentation": "Returns the items on the current page. The keys in the item are determined by the source of this object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Pages.GetCurrentPage/param/0" } ], "returns": [ "@roblox/globaltype/Pages.GetCurrentPage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pages#GetCurrentPage", "code_sample": "" }, "@roblox/globaltype/FormFactorPart": { "documentation": "The FormFactorPart class is an abstract class. It inherits from the BasePart class and adds the FormFactor property to classes that inherit from it.", "keys": { "FormFactor": "@roblox/globaltype/FormFactorPart.FormFactor", "formFactor": "@roblox/globaltype/FormFactorPart.formFactor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FormFactorPart", "code_sample": "" }, "@roblox/globaltype/FormFactorPart.FormFactor": { "documentation": "Deprecated: This property has been deprecated and should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FormFactorPart#FormFactor", "code_sample": "" }, "@roblox/globaltype/FormFactorPart.formFactor": { "documentation": "Deprecated: This property has been deprecated and should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FormFactorPart#formFactor", "code_sample": "" }, "@roblox/globaltype/CapturesPages": { "documentation": "A special version of the Pages class returned by CaptureService.ReadCapturesFromGalleryAsync.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CapturesPages", "code_sample": "" }, "@roblox/globaltype/ConeHandleAdornment": { "documentation": "A cone-shaped handle that can be adorned to a BasePart.", "keys": { "Height": "@roblox/globaltype/ConeHandleAdornment.Height", "Hollow": "@roblox/globaltype/ConeHandleAdornment.Hollow", "Radius": "@roblox/globaltype/ConeHandleAdornment.Radius", "Shading": "@roblox/globaltype/ConeHandleAdornment.Shading" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment", "code_sample": "" }, "@roblox/globaltype/ConeHandleAdornment.Height": { "documentation": "Height of the cone adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment#Height", "code_sample": "" }, "@roblox/globaltype/ConeHandleAdornment.Hollow": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment#Hollow", "code_sample": "" }, "@roblox/globaltype/ConeHandleAdornment.Radius": { "documentation": "Radius of the cone adornment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment#Radius", "code_sample": "" }, "@roblox/globaltype/ConeHandleAdornment.Shading": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConeHandleAdornment#Shading", "code_sample": "" }, "@roblox/globaltype/Texture": { "documentation": "Applies a repeating image texture to the face of a parent BasePart.", "keys": { "OffsetStudsU": "@roblox/globaltype/Texture.OffsetStudsU", "OffsetStudsV": "@roblox/globaltype/Texture.OffsetStudsV", "StudsPerTileU": "@roblox/globaltype/Texture.StudsPerTileU", "StudsPerTileV": "@roblox/globaltype/Texture.StudsPerTileV" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Texture", "code_sample": "" }, "@roblox/globaltype/Texture.OffsetStudsU": { "documentation": "Determines the offset in studs of the rendered texture's horizontal coordinate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Texture#OffsetStudsU", "code_sample": "" }, "@roblox/globaltype/Texture.OffsetStudsV": { "documentation": "Determines the offset in studs of the rendered texture's vertical coordinate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Texture#OffsetStudsV", "code_sample": "" }, "@roblox/globaltype/Texture.StudsPerTileU": { "documentation": "Sets the horizontal size, in studs, of the tiled image applied by the Texture.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Texture#StudsPerTileU", "code_sample": "" }, "@roblox/globaltype/Texture.StudsPerTileV": { "documentation": "Sets the vertical size, in studs, of the tiled image applied by the Texture.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Texture#StudsPerTileV", "code_sample": "" }, "@roblox/globaltype/AnimationController": { "documentation": "Allows animations to be loaded and applied to a character or model in place of a Humanoid.", "keys": { "GetPlayingAnimationTracks": "@roblox/globaltype/AnimationController.GetPlayingAnimationTracks", "LoadAnimation": "@roblox/globaltype/AnimationController.LoadAnimation" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationController", "code_sample": "" }, "@roblox/globaltype/AnimationController.GetPlayingAnimationTracks/param/0": { "documentation": "Allows animations to be loaded and applied to a character or model in place of a Humanoid." }, "@roblox/globaltype/AnimationController.GetPlayingAnimationTracks/return/0": { "documentation": "An array of playing AnimationTracks." }, "@roblox/globaltype/AnimationController.GetPlayingAnimationTracks": { "documentation": "Deprecated:
Returns an array of all AnimationTracks that are currently being played by the AnimationController.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationController.GetPlayingAnimationTracks/param/0" } ], "returns": [ "@roblox/globaltype/AnimationController.GetPlayingAnimationTracks/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationController#GetPlayingAnimationTracks", "code_sample": "local function stopAllTracks(animationController)\n\tfor _, track in pairs(animationController:GetPlayingAnimationTracks()) do\n\t\ttrack:Stop()\n\tend\nend\n\nlocal animationController = script.Parent:FindFirstChild(\"AnimationController\")\n\nstopAllTracks(animationController)" }, "@roblox/globaltype/AnimationController.LoadAnimation/param/0": { "documentation": "Allows animations to be loaded and applied to a character or model in place of a Humanoid." }, "@roblox/globaltype/AnimationController.LoadAnimation/param/1": { "documentation": "The Animation to be used." }, "@roblox/globaltype/AnimationController.LoadAnimation/return/0": { "documentation": "" }, "@roblox/globaltype/AnimationController.LoadAnimation": { "documentation": "Deprecated: This function is deprecated in favor of using Animator:LoadAnimation() directly (the Animator may be created while editing or at runtime).
Loads an Animation onto an AnimationController, returning an AnimationTrack that can be used for playback.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationController.LoadAnimation/param/0" }, { "name": "animation", "documentation": "@roblox/globaltype/AnimationController.LoadAnimation/param/1" } ], "returns": [ "@roblox/globaltype/AnimationController.LoadAnimation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationController#LoadAnimation", "code_sample": "" }, "@roblox/globaltype/AnimationController.AnimationPlayed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationController.AnimationPlayed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationController.AnimationPlayed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationController.AnimationPlayed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationController.AnimationPlayed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationController.AnimationPlayed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationController.AnimationPlayed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationController.AnimationPlayed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AnimationController.AnimationPlayed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AnimationController.AnimationPlayed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AnimationController.AnimationPlayed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AnimationController.AnimationPlayed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AnimationController.AnimationPlayed": { "documentation": "Deprecated:
Fires whenever the AnimationController begins playing an animation. It returns the AnimationTrack playing.", "keys": { "Connect": "@roblox/globaltype/AnimationController.AnimationPlayed.Connect", "ConnectParallel": "@roblox/globaltype/AnimationController.AnimationPlayed.ConnectParallel", "Once": "@roblox/globaltype/AnimationController.AnimationPlayed.Once", "Wait": "@roblox/globaltype/AnimationController.AnimationPlayed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationController#AnimationPlayed", "code_sample": "" }, "@roblox/globaltype/PluginToolbarButton": { "documentation": "", "keys": { "ClickableWhenViewportHidden": "@roblox/globaltype/PluginToolbarButton.ClickableWhenViewportHidden", "Enabled": "@roblox/globaltype/PluginToolbarButton.Enabled", "Icon": "@roblox/globaltype/PluginToolbarButton.Icon", "SetActive": "@roblox/globaltype/PluginToolbarButton.SetActive" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton", "code_sample": "" }, "@roblox/globaltype/PluginToolbarButton.ClickableWhenViewportHidden": { "documentation": "Determines whether the button can be clicked when the 3D viewport is hidden, such as when a Script is being edited in another tab.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#ClickableWhenViewportHidden", "code_sample": "" }, "@roblox/globaltype/PluginToolbarButton.Enabled": { "documentation": "Determines whether the button is clickable in general.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#Enabled", "code_sample": "" }, "@roblox/globaltype/PluginToolbarButton.Icon": { "documentation": "Determines what icon should represent the button.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#Icon", "code_sample": "" }, "@roblox/globaltype/PluginToolbarButton.SetActive/param/0": { "documentation": "" }, "@roblox/globaltype/PluginToolbarButton.SetActive/param/1": { "documentation": "" }, "@roblox/globaltype/PluginToolbarButton.SetActive": { "documentation": "Sets the state of the plugin button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginToolbarButton.SetActive/param/0" }, { "name": "active", "documentation": "@roblox/globaltype/PluginToolbarButton.SetActive/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#SetActive", "code_sample": "" }, "@roblox/globaltype/PluginToolbarButton.Click.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginToolbarButton.Click.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/PluginToolbarButton.Click.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginToolbarButton.Click.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginToolbarButton.Click.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/PluginToolbarButton.Click.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginToolbarButton.Click.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginToolbarButton.Click.Once/param/1": { "documentation": "" }, "@roblox/globaltype/PluginToolbarButton.Click.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/PluginToolbarButton.Click.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/PluginToolbarButton.Click.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PluginToolbarButton.Click.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/PluginToolbarButton.Click": { "documentation": "Fires when the user presses and releases their cursor on the button.", "keys": { "Connect": "@roblox/globaltype/PluginToolbarButton.Click.Connect", "ConnectParallel": "@roblox/globaltype/PluginToolbarButton.Click.ConnectParallel", "Once": "@roblox/globaltype/PluginToolbarButton.Click.Once", "Wait": "@roblox/globaltype/PluginToolbarButton.Click.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginToolbarButton#Click", "code_sample": "" }, "@roblox/globaltype/StatsItem": { "documentation": "A single performance metric.", "keys": { "DisplayName": "@roblox/globaltype/StatsItem.DisplayName", "GetValue": "@roblox/globaltype/StatsItem.GetValue", "GetValueString": "@roblox/globaltype/StatsItem.GetValueString" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StatsItem", "code_sample": "" }, "@roblox/globaltype/StatsItem.DisplayName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StatsItem#DisplayName", "code_sample": "" }, "@roblox/globaltype/StatsItem.GetValue/param/0": { "documentation": "A single performance metric." }, "@roblox/globaltype/StatsItem.GetValue/return/0": { "documentation": "" }, "@roblox/globaltype/StatsItem.GetValue": { "documentation": "Returns the StatsItem's value.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StatsItem.GetValue/param/0" } ], "returns": [ "@roblox/globaltype/StatsItem.GetValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StatsItem#GetValue", "code_sample": "" }, "@roblox/globaltype/StatsItem.GetValueString/param/0": { "documentation": "A single performance metric." }, "@roblox/globaltype/StatsItem.GetValueString/return/0": { "documentation": "" }, "@roblox/globaltype/StatsItem.GetValueString": { "documentation": "Returns the StatsItem's value as a formatted string.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/StatsItem.GetValueString/param/0" } ], "returns": [ "@roblox/globaltype/StatsItem.GetValueString/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StatsItem#GetValueString", "code_sample": "" }, "@roblox/globaltype/MemoryStoreService": { "documentation": "Exposes methods to access specific primitives within MemoryStore.", "keys": { "GetHashMap": "@roblox/globaltype/MemoryStoreService.GetHashMap", "GetQueue": "@roblox/globaltype/MemoryStoreService.GetQueue", "GetSortedMap": "@roblox/globaltype/MemoryStoreService.GetSortedMap" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreService", "code_sample": "" }, "@roblox/globaltype/MemoryStoreService.GetHashMap/param/0": { "documentation": "Exposes methods to access specific primitives within MemoryStore." }, "@roblox/globaltype/MemoryStoreService.GetHashMap/param/1": { "documentation": "The name of the hash map." }, "@roblox/globaltype/MemoryStoreService.GetHashMap/return/0": { "documentation": "A MemoryStoreHashMap instance for the provided name." }, "@roblox/globaltype/MemoryStoreService.GetHashMap": { "documentation": "Returns a MemoryStoreHashMap instance for the provided name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreService.GetHashMap/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/MemoryStoreService.GetHashMap/param/1" } ], "returns": [ "@roblox/globaltype/MemoryStoreService.GetHashMap/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreService#GetHashMap", "code_sample": "" }, "@roblox/globaltype/MemoryStoreService.GetQueue/param/0": { "documentation": "Exposes methods to access specific primitives within MemoryStore." }, "@roblox/globaltype/MemoryStoreService.GetQueue/param/1": { "documentation": "Name of the queue." }, "@roblox/globaltype/MemoryStoreService.GetQueue/param/2": { "documentation": "(Optional) Invisibility timeout, in seconds, for read operations through this queue instance. If not provided, defaults to 30 seconds." }, "@roblox/globaltype/MemoryStoreService.GetQueue/return/0": { "documentation": "A MemoryStoreQueue instance for the provided name." }, "@roblox/globaltype/MemoryStoreService.GetQueue": { "documentation": "Returns a MemoryStoreQueue instance for the provided name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreService.GetQueue/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/MemoryStoreService.GetQueue/param/1" }, { "name": "invisibilityTimeout", "documentation": "@roblox/globaltype/MemoryStoreService.GetQueue/param/2" } ], "returns": [ "@roblox/globaltype/MemoryStoreService.GetQueue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreService#GetQueue", "code_sample": "" }, "@roblox/globaltype/MemoryStoreService.GetSortedMap/param/0": { "documentation": "Exposes methods to access specific primitives within MemoryStore." }, "@roblox/globaltype/MemoryStoreService.GetSortedMap/param/1": { "documentation": "Name of the sorted map." }, "@roblox/globaltype/MemoryStoreService.GetSortedMap/return/0": { "documentation": "A MemoryStoreSortedMap instance for the provided name." }, "@roblox/globaltype/MemoryStoreService.GetSortedMap": { "documentation": "Returns a MemoryStoreSortedMap instance for the provided name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreService.GetSortedMap/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/MemoryStoreService.GetSortedMap/param/1" } ], "returns": [ "@roblox/globaltype/MemoryStoreService.GetSortedMap/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreService#GetSortedMap", "code_sample": "" }, "@roblox/globaltype/CornerWedgePart": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CornerWedgePart", "code_sample": "" }, "@roblox/globaltype/BinaryStringValue": { "documentation": "An internal type of StringValue object, that stores a BinaryString value.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BinaryStringValue", "code_sample": "" }, "@roblox/globaltype/BinaryStringValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BinaryStringValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BinaryStringValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BinaryStringValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BinaryStringValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BinaryStringValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BinaryStringValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BinaryStringValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BinaryStringValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BinaryStringValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BinaryStringValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BinaryStringValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BinaryStringValue.Changed": { "documentation": "Fires if the BinaryStringValue's value is changed.", "keys": { "Connect": "@roblox/globaltype/BinaryStringValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/BinaryStringValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/BinaryStringValue.Changed.Once", "Wait": "@roblox/globaltype/BinaryStringValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BinaryStringValue#Changed", "code_sample": "" }, "@roblox/globaltype/TextBox": { "documentation": "A 2D user interface element that displays player-editable text.", "keys": { "ClearTextOnFocus": "@roblox/globaltype/TextBox.ClearTextOnFocus", "ContentText": "@roblox/globaltype/TextBox.ContentText", "CursorPosition": "@roblox/globaltype/TextBox.CursorPosition", "Font": "@roblox/globaltype/TextBox.Font", "FontFace": "@roblox/globaltype/TextBox.FontFace", "FontSize": "@roblox/globaltype/TextBox.FontSize", "LineHeight": "@roblox/globaltype/TextBox.LineHeight", "MaxVisibleGraphemes": "@roblox/globaltype/TextBox.MaxVisibleGraphemes", "MultiLine": "@roblox/globaltype/TextBox.MultiLine", "OpenTypeFeatures": "@roblox/globaltype/TextBox.OpenTypeFeatures", "OpenTypeFeaturesError": "@roblox/globaltype/TextBox.OpenTypeFeaturesError", "PlaceholderColor3": "@roblox/globaltype/TextBox.PlaceholderColor3", "PlaceholderText": "@roblox/globaltype/TextBox.PlaceholderText", "RichText": "@roblox/globaltype/TextBox.RichText", "SelectionStart": "@roblox/globaltype/TextBox.SelectionStart", "ShowNativeInput": "@roblox/globaltype/TextBox.ShowNativeInput", "Text": "@roblox/globaltype/TextBox.Text", "TextBounds": "@roblox/globaltype/TextBox.TextBounds", "TextColor": "@roblox/globaltype/TextBox.TextColor", "TextColor3": "@roblox/globaltype/TextBox.TextColor3", "TextDirection": "@roblox/globaltype/TextBox.TextDirection", "TextEditable": "@roblox/globaltype/TextBox.TextEditable", "TextFits": "@roblox/globaltype/TextBox.TextFits", "TextScaled": "@roblox/globaltype/TextBox.TextScaled", "TextSize": "@roblox/globaltype/TextBox.TextSize", "TextStrokeColor3": "@roblox/globaltype/TextBox.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/TextBox.TextStrokeTransparency", "TextTransparency": "@roblox/globaltype/TextBox.TextTransparency", "TextTruncate": "@roblox/globaltype/TextBox.TextTruncate", "TextWrap": "@roblox/globaltype/TextBox.TextWrap", "TextWrapped": "@roblox/globaltype/TextBox.TextWrapped", "TextXAlignment": "@roblox/globaltype/TextBox.TextXAlignment", "TextYAlignment": "@roblox/globaltype/TextBox.TextYAlignment", "CaptureFocus": "@roblox/globaltype/TextBox.CaptureFocus", "IsFocused": "@roblox/globaltype/TextBox.IsFocused", "ReleaseFocus": "@roblox/globaltype/TextBox.ReleaseFocus" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox", "code_sample": "" }, "@roblox/globaltype/TextBox.ClearTextOnFocus": { "documentation": "Determines whether clicking on the TextBox will clear its TextBox.Text property.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#ClearTextOnFocus", "code_sample": "" }, "@roblox/globaltype/TextBox.ContentText": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#ContentText", "code_sample": "" }, "@roblox/globaltype/TextBox.CursorPosition": { "documentation": "Determines the offset of the text cursor in bytes, or -1 if there is no cursor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#CursorPosition", "code_sample": "local textBox = script.Parent\n\nlocal function showSelection()\n\tif textBox.CursorPosition == -1 or textBox.SelectionStart == -1 then\n\t\tprint(\"No selection\")\n\telse\n\t\tlocal selectedText = string.sub(\n\t\t\ttextBox.Text,\n\t\t\tmath.min(textBox.CursorPosition, textBox.SelectionStart),\n\t\t\tmath.max(textBox.CursorPosition, textBox.SelectionStart)\n\t\t)\n\t\tprint('The selection is:\"', selectedText, '\"')\n\tend\nend\n\ntextBox:GetPropertyChangedSignal(\"CursorPosition\"):Connect(showSelection)\ntextBox:GetPropertyChangedSignal(\"SelectionStart\"):Connect(showSelection)" }, "@roblox/globaltype/TextBox.Font": { "documentation": "Determines the font used to render text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#Font", "code_sample": "local textLabel = script.Parent\n\nwhile true do\n\t-- Iterate over all the different fonts\n\tfor _, font in pairs(Enum.Font:GetEnumItems()) do\n\t\ttextLabel.Font = font\n\t\ttextLabel.Text = font.Name\n\t\ttask.wait(1)\n\tend\nend" }, "@roblox/globaltype/TextBox.FontFace": { "documentation": "Determines the font used to render text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#FontFace", "code_sample": "" }, "@roblox/globaltype/TextBox.FontSize": { "documentation": "Deprecated: This item has been superseded by TextBox.TextSize which should be used in all new work.
Determines the font size of a TextBox object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#FontSize", "code_sample": "" }, "@roblox/globaltype/TextBox.LineHeight": { "documentation": "Scales the spacing between lines of text in the TextBox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#LineHeight", "code_sample": "" }, "@roblox/globaltype/TextBox.MaxVisibleGraphemes": { "documentation": "The maximum number of graphemes the TextBox can show.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#MaxVisibleGraphemes", "code_sample": "" }, "@roblox/globaltype/TextBox.MultiLine": { "documentation": "When set to true, text inside a TextBox is able to move onto multiple lines. This also enables players to use the enter key to move onto a new line.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#MultiLine", "code_sample": "" }, "@roblox/globaltype/TextBox.OpenTypeFeatures": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#OpenTypeFeatures", "code_sample": "" }, "@roblox/globaltype/TextBox.OpenTypeFeaturesError": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#OpenTypeFeaturesError", "code_sample": "" }, "@roblox/globaltype/TextBox.PlaceholderColor3": { "documentation": "Sets the text color that gets used when no text has been entered into the TextBox yet.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#PlaceholderColor3", "code_sample": "" }, "@roblox/globaltype/TextBox.PlaceholderText": { "documentation": "Sets the text that gets displayed when no text has been entered into the TextBox yet.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#PlaceholderText", "code_sample": "" }, "@roblox/globaltype/TextBox.RichText": { "documentation": "Determines whether the TextBox renders the TextBox.Text string using rich text formatting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#RichText", "code_sample": "" }, "@roblox/globaltype/TextBox.SelectionStart": { "documentation": "Determines the starting position of a text selection, or -1 if no text is selected.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#SelectionStart", "code_sample": "local textBox = script.Parent\n\nlocal function showSelection()\n\tif textBox.CursorPosition == -1 or textBox.SelectionStart == -1 then\n\t\tprint(\"No selection\")\n\telse\n\t\tlocal selectedText = string.sub(\n\t\t\ttextBox.Text,\n\t\t\tmath.min(textBox.CursorPosition, textBox.SelectionStart),\n\t\t\tmath.max(textBox.CursorPosition, textBox.SelectionStart)\n\t\t)\n\t\tprint('The selection is:\"', selectedText, '\"')\n\tend\nend\n\ntextBox:GetPropertyChangedSignal(\"CursorPosition\"):Connect(showSelection)\ntextBox:GetPropertyChangedSignal(\"SelectionStart\"):Connect(showSelection)" }, "@roblox/globaltype/TextBox.ShowNativeInput": { "documentation": "If set to true, input native to the platform is used instead of Roblox's built-in keyboard.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#ShowNativeInput", "code_sample": "" }, "@roblox/globaltype/TextBox.Text": { "documentation": "Determines the string rendered by the UI element.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#Text", "code_sample": "" }, "@roblox/globaltype/TextBox.TextBounds": { "documentation": "The size of a UI element's text in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextBounds", "code_sample": "" }, "@roblox/globaltype/TextBox.TextColor": { "documentation": "Deprecated: This item has been superseded by TextBox.TextColor3 which should be used in all new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextColor", "code_sample": "" }, "@roblox/globaltype/TextBox.TextColor3": { "documentation": "Determines the color of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextColor3", "code_sample": "local textBox = script.Parent\n\nlocal function hasVowels(str)\n\treturn str:lower():find(\"[aeiou]\")\nend\n\nlocal function onTextChanged()\n\tlocal text = textBox.Text\n\t-- Check for vowels\n\tif hasVowels(text) then\n\t\ttextBox.TextColor3 = Color3.new(0, 0, 0) -- Black\n\telse\n\t\ttextBox.TextColor3 = Color3.new(1, 0, 0) -- Red\n\tend\nend\n\ntextBox:GetPropertyChangedSignal(\"Text\"):Connect(onTextChanged)" }, "@roblox/globaltype/TextBox.TextDirection": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextDirection", "code_sample": "" }, "@roblox/globaltype/TextBox.TextEditable": { "documentation": "Determines whether the user can change the Text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextEditable", "code_sample": "" }, "@roblox/globaltype/TextBox.TextFits": { "documentation": "Whether the text fits within the constraints of the TextBox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextFits", "code_sample": "" }, "@roblox/globaltype/TextBox.TextScaled": { "documentation": "Changes whether text is resized to fit the GUI object that renders it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextScaled", "code_sample": "" }, "@roblox/globaltype/TextBox.TextSize": { "documentation": "Determine the line height of text in offsets.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextSize", "code_sample": "local textLabel = script.Parent\n\ntextLabel.Text = \"Kaboom!\"\n\nwhile true do\n\tfor size = 5, 100, 5 do\n\t\ttextLabel.TextSize = size\n\t\ttextLabel.TextTransparency = size / 100\n\t\ttask.wait()\n\tend\n\ttask.wait(1)\nend" }, "@roblox/globaltype/TextBox.TextStrokeColor3": { "documentation": "Determines the color of the text stroke (outline).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/TextBox.TextStrokeTransparency": { "documentation": "Determines the transparency of the text stroke (outline).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/TextBox.TextTransparency": { "documentation": "Determines the transparency of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextTransparency", "code_sample": "" }, "@roblox/globaltype/TextBox.TextTruncate": { "documentation": "Controls the truncation of the text displayed in this TextBox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextTruncate", "code_sample": "" }, "@roblox/globaltype/TextBox.TextWrap": { "documentation": "Deprecated: This item has been superseded by TextBox.TextWrapped which should be used in all new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextWrap", "code_sample": "" }, "@roblox/globaltype/TextBox.TextWrapped": { "documentation": "Determines if text wraps to multiple lines within the GuiObject element space, truncating excess text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextWrapped", "code_sample": "" }, "@roblox/globaltype/TextBox.TextXAlignment": { "documentation": "Determines the horizontal alignment of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextXAlignment", "code_sample": "-- Paste this in a LocalScript within a TextLabel/TextButton/TextBox\nlocal textLabel = script.Parent\n\nlocal function setAlignment(xAlign, yAlign)\n\ttextLabel.TextXAlignment = xAlign\n\ttextLabel.TextYAlignment = yAlign\n\ttextLabel.Text = xAlign.Name .. \" + \" .. yAlign.Name\nend\n\nwhile true do\n\t-- Iterate over both TextXAlignment and TextYAlignment enum items\n\tfor _, yAlign in pairs(Enum.TextYAlignment:GetEnumItems()) do\n\t\tfor _, xAlign in pairs(Enum.TextXAlignment:GetEnumItems()) do\n\t\t\tsetAlignment(xAlign, yAlign)\n\t\t\ttask.wait(1)\n\t\tend\n\tend\nend" }, "@roblox/globaltype/TextBox.TextYAlignment": { "documentation": "Determines the vertical alignment of rendered text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#TextYAlignment", "code_sample": "-- Paste this in a LocalScript within a TextLabel/TextButton/TextBox\nlocal textLabel = script.Parent\n\nlocal function setAlignment(xAlign, yAlign)\n\ttextLabel.TextXAlignment = xAlign\n\ttextLabel.TextYAlignment = yAlign\n\ttextLabel.Text = xAlign.Name .. \" + \" .. yAlign.Name\nend\n\nwhile true do\n\t-- Iterate over both TextXAlignment and TextYAlignment enum items\n\tfor _, yAlign in pairs(Enum.TextYAlignment:GetEnumItems()) do\n\t\tfor _, xAlign in pairs(Enum.TextXAlignment:GetEnumItems()) do\n\t\t\tsetAlignment(xAlign, yAlign)\n\t\t\ttask.wait(1)\n\t\tend\n\tend\nend" }, "@roblox/globaltype/TextBox.CaptureFocus/param/0": { "documentation": "A 2D user interface element that displays player-editable text." }, "@roblox/globaltype/TextBox.CaptureFocus": { "documentation": "Forces the client to focus on the TextBox.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.CaptureFocus/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#CaptureFocus", "code_sample": "" }, "@roblox/globaltype/TextBox.IsFocused/param/0": { "documentation": "A 2D user interface element that displays player-editable text." }, "@roblox/globaltype/TextBox.IsFocused/return/0": { "documentation": "" }, "@roblox/globaltype/TextBox.IsFocused": { "documentation": "Returns true if the TextBox is focused or false if it is not.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.IsFocused/param/0" } ], "returns": [ "@roblox/globaltype/TextBox.IsFocused/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#IsFocused", "code_sample": "" }, "@roblox/globaltype/TextBox.ReleaseFocus/param/0": { "documentation": "A 2D user interface element that displays player-editable text." }, "@roblox/globaltype/TextBox.ReleaseFocus/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.ReleaseFocus": { "documentation": "Forces the client to unfocus the TextBox.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.ReleaseFocus/param/0" }, { "name": "submitted", "documentation": "@roblox/globaltype/TextBox.ReleaseFocus/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#ReleaseFocus", "code_sample": "local textBox = script.Parent\n\nlocal function onFocused()\n\ttask.wait(5)\n\ttextBox:ReleaseFocus()\nend\n\ntextBox.Focused:Connect(onFocused)" }, "@roblox/globaltype/TextBox.Focused.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.Focused.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.Focused.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.Focused.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.Focused.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.Focused.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.Focused.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.Focused.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.Focused.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.Focused.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.Focused.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.Focused.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.Focused.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.Focused.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.Focused.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.Focused.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.Focused.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.Focused.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextBox.Focused": { "documentation": "Fires when the TextBox gains focus.", "keys": { "Connect": "@roblox/globaltype/TextBox.Focused.Connect", "ConnectParallel": "@roblox/globaltype/TextBox.Focused.ConnectParallel", "Once": "@roblox/globaltype/TextBox.Focused.Once", "Wait": "@roblox/globaltype/TextBox.Focused.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#Focused", "code_sample": "local textBox = script.Parent\n\nlocal function onFocused()\n\tprint(\"Focused\")\nend\n\ntextBox.Focused:Connect(onFocused)" }, "@roblox/globaltype/TextBox.FocusLost.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.FocusLost.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.FocusLost.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.FocusLost.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.FocusLost.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.FocusLost.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.FocusLost.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.FocusLost.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.FocusLost.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.FocusLost.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.FocusLost.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.FocusLost.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.FocusLost.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.FocusLost.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.FocusLost.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.FocusLost.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.FocusLost.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.FocusLost.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextBox.FocusLost": { "documentation": "Fires when the client lets their focus leave the TextBox.", "keys": { "Connect": "@roblox/globaltype/TextBox.FocusLost.Connect", "ConnectParallel": "@roblox/globaltype/TextBox.FocusLost.ConnectParallel", "Once": "@roblox/globaltype/TextBox.FocusLost.Once", "Wait": "@roblox/globaltype/TextBox.FocusLost.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#FocusLost", "code_sample": "local gui = script.Parent\nlocal textBox = gui.TextBox\n\nlocal function focusLost(enterPressed)\n\tif enterPressed then\n\t\tprint(\"Focus was lost because enter was pressed!\")\n\telse\n\t\tprint(\"Focus was lost without enter being pressed\")\n\tend\nend\n\ntextBox.FocusLost:Connect(focusLost)" }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Connect", "ConnectParallel": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.ConnectParallel", "Once": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Once", "Wait": "@roblox/globaltype/TextBox.ReturnPressedFromOnScreenKeyboard.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextBox#ReturnPressedFromOnScreenKeyboard", "code_sample": "" }, "@roblox/globaltype/AudioChannelSplitter": { "documentation": "Splits an audio stream into component channels so that each can be processed independently.", "keys": { "Layout": "@roblox/globaltype/AudioChannelSplitter.Layout", "GetConnectedWires": "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioChannelSplitter.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioChannelSplitter.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter", "code_sample": "" }, "@roblox/globaltype/AudioChannelSplitter.Layout": { "documentation": "Controls the input channel layout to be split from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#Layout", "code_sample": "" }, "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires/param/0": { "documentation": "Splits an audio stream into component channels so that each can be processed independently." }, "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioChannelSplitter.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioChannelSplitter.GetInputPins/param/0": { "documentation": "Splits an audio stream into component channels so that each can be processed independently." }, "@roblox/globaltype/AudioChannelSplitter.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.GetInputPins": { "documentation": "Returns the input pin available for Wire.TargetName.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioChannelSplitter.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioChannelSplitter.GetOutputPins/param/0": { "documentation": "Splits an audio stream into component channels so that each can be processed independently." }, "@roblox/globaltype/AudioChannelSplitter.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.GetOutputPins": { "documentation": "Returns the output pins that can be selected by Wire.SourceName.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioChannelSplitter.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioChannelSplitter.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioChannelSplitter via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioChannelSplitter.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#WiringChanged", "code_sample": "" }, "@roblox/globaltype/NetworkServer": { "documentation": "", "keys": { "EncryptStringForPlayerId": "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkServer", "code_sample": "" }, "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/param/0": { "documentation": "" }, "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/param/2": { "documentation": "" }, "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/return/0": { "documentation": "" }, "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/param/0" }, { "name": "toEncrypt", "documentation": "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/param/1" }, { "name": "playerId", "documentation": "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/param/2" } ], "returns": [ "@roblox/globaltype/NetworkServer.EncryptStringForPlayerId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkServer#EncryptStringForPlayerId", "code_sample": "" }, "@roblox/globaltype/MarketplaceService": { "documentation": "The service responsible for in-experience transactions.", "keys": { "GetDeveloperProductsAsync": "@roblox/globaltype/MarketplaceService.GetDeveloperProductsAsync", "GetProductInfoAsync": "@roblox/globaltype/MarketplaceService.GetProductInfoAsync", "GetProductInfo": "@roblox/globaltype/MarketplaceService.GetProductInfo", "GetSubscriptionProductInfoAsync": "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync", "GetUsersPriceLevelsAsync": "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync", "GetUserSubscriptionDetailsAsync": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync", "GetUserSubscriptionPaymentHistoryAsync": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync", "GetUserSubscriptionStatusAsync": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync", "PlayerOwnsAssetAsync": "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync", "PlayerOwnsAsset": "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset", "PlayerOwnsBundleAsync": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync", "PlayerOwnsBundle": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle", "PromptBulkPurchase": "@roblox/globaltype/MarketplaceService.PromptBulkPurchase", "PromptBundlePurchase": "@roblox/globaltype/MarketplaceService.PromptBundlePurchase", "PromptCancelSubscription": "@roblox/globaltype/MarketplaceService.PromptCancelSubscription", "PromptGamePassPurchase": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase", "PromptPremiumPurchase": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchase", "PromptProductPurchase": "@roblox/globaltype/MarketplaceService.PromptProductPurchase", "PromptPurchase": "@roblox/globaltype/MarketplaceService.PromptPurchase", "PromptSubscriptionPurchase": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase", "RankProductsAsync": "@roblox/globaltype/MarketplaceService.RankProductsAsync", "RecommendTopProductsAsync": "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync", "UserOwnsGamePassAsync": "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync", "ProcessReceipt": "@roblox/globaltype/MarketplaceService.ProcessReceipt" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.GetDeveloperProductsAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetDeveloperProductsAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetDeveloperProductsAsync": { "documentation": "Returns a Pages object which contains information for all of the current experience's developer products.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetDeveloperProductsAsync/param/0" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetDeveloperProductsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetDeveloperProductsAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/param/1": { "documentation": "The asset ID of the specified product." }, "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/param/2": { "documentation": "An InfoType enum value specifying the type of information being retrieved." }, "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/return/0": { "documentation": "A dictionary containing information about the queried item, described in the previous tables." }, "@roblox/globaltype/MarketplaceService.GetProductInfoAsync": { "documentation": "Returns the product information of an asset using its asset ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/param/1" }, { "name": "infoType", "documentation": "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetProductInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetProductInfoAsync", "code_sample": "local MarketplaceService = game:GetService(\"MarketplaceService\")\n\nlocal ASSET_ID = 125378389\n\nlocal asset = MarketplaceService:GetProductInfoAsync(ASSET_ID)\nprint(asset.Name .. \" :: \" .. asset.Description)" }, "@roblox/globaltype/MarketplaceService.GetProductInfo/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetProductInfo/param/1": { "documentation": "The asset ID of the specified product." }, "@roblox/globaltype/MarketplaceService.GetProductInfo/param/2": { "documentation": "An InfoType enum value specifying the type of information being retrieved." }, "@roblox/globaltype/MarketplaceService.GetProductInfo/return/0": { "documentation": "A dictionary containing information about the queried item, described in the previous tables." }, "@roblox/globaltype/MarketplaceService.GetProductInfo": { "documentation": "Deprecated: This method has been superseded by GetProductInfoAsync().
Returns the product information of an asset using its asset ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetProductInfo/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/MarketplaceService.GetProductInfo/param/1" }, { "name": "infoType", "documentation": "@roblox/globaltype/MarketplaceService.GetProductInfo/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetProductInfo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetProductInfo", "code_sample": "local MarketplaceService = game:GetService(\"MarketplaceService\")\n\nlocal ASSET_ID = 125378389\n\nlocal asset = MarketplaceService:GetProductInfoAsync(ASSET_ID)\nprint(asset.Name .. \" :: \" .. asset.Description)" }, "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync/param/1": { "documentation": "The ID of the subscription to check." }, "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync": { "documentation": "Returns the product information of a subscription for the given subscriptionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync/param/0" }, { "name": "subscriptionId", "documentation": "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync/param/1" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetSubscriptionProductInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetSubscriptionProductInfoAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync/param/1": { "documentation": "An array of user IDs." }, "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync/return/0": { "documentation": "Returns an array of PriceLevelInfo objects with a dictionary where the keys are user IDs (strings) and their values are the corresponding price levels (integers between 1 and 1000)." }, "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync": { "documentation": "Returns the regionalized price level of a user, representing the recommended price for an item in their regional market.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync/param/0" }, { "name": "userIds", "documentation": "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync/param/1" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetUsersPriceLevelsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUsersPriceLevelsAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/param/1": { "documentation": "The Player object whose subscription details you want to check." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/param/2": { "documentation": "The ID of the subscription to check." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync": { "documentation": "Returns a table that contains the details of the user's subscription for a given subscriptionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/param/1" }, { "name": "subscriptionId", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetUserSubscriptionDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUserSubscriptionDetailsAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/param/2": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync": { "documentation": "Returns an Array that contains up to one year of the user's subscription payment history for the given subscriptionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/param/1" }, { "name": "subscriptionId", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetUserSubscriptionPaymentHistoryAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUserSubscriptionPaymentHistoryAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/param/1": { "documentation": "The Player object whose subscription status you want to check." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/param/2": { "documentation": "The ID of the subscription to check for." }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync": { "documentation": "Returns a table that contains the subscription status of the user for the given subscriptionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/param/1" }, { "name": "subscriptionId", "documentation": "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.GetUserSubscriptionStatusAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetUserSubscriptionStatusAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/param/1": { "documentation": "The Player whose inventory is tested for ownership of the given asset." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/param/2": { "documentation": "The asset ID for which the given player's inventory is tested." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/return/0": { "documentation": "Indicates whether the given player's inventory contains the given asset." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync": { "documentation": "Returns whether the given user has the given asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/param/1" }, { "name": "assetId", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.PlayerOwnsAssetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsAssetAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/param/1": { "documentation": "The Player whose inventory is tested for ownership of the given asset." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/param/2": { "documentation": "The asset ID for which the given player's inventory is tested." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/return/0": { "documentation": "Indicates whether the given player's inventory contains the given asset." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset": { "documentation": "Deprecated: This method has been superseded by PlayerOwnsAssetAsync().
Returns whether the given user has the given asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/param/1" }, { "name": "assetId", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.PlayerOwnsAsset/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsAsset", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/param/1": { "documentation": "The Player whose inventory is tested for ownership of the given bundle." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/param/2": { "documentation": "The bundle ID for which the given player's inventory is tested." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/return/0": { "documentation": "Indicates whether the given player's inventory contains the given bundle." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync": { "documentation": "Returns whether the given player owns the given bundle.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/param/1" }, { "name": "bundleId", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.PlayerOwnsBundleAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsBundleAsync", "code_sample": "local Players = game:GetService(\"Players\")\nlocal MarketplaceService = game:GetService(\"MarketplaceService\")\n\n-- The bundle we're checking for: https://www.roblox.com/bundles/589/Junkbot\nlocal BUNDLE_ID = 589\nlocal BUNDLE_NAME = \"Junkbot\"\n\nPlayers.PlayerAdded:Connect(function(player)\n\tlocal success, doesPlayerOwnBundle = pcall(function()\n\t\treturn MarketplaceService:PlayerOwnsBundleAsync(player, BUNDLE_ID)\n\tend)\n\n\tif success == false then\n\t\tprint(\"PlayerOwnsBundleAsync call failed: \", doesPlayerOwnBundle)\n\t\treturn\n\tend\n\n\tif doesPlayerOwnBundle then\n\t\tprint(player.Name .. \" owns \" .. BUNDLE_NAME)\n\telse\n\t\tprint(player.Name .. \" doesn't own \" .. BUNDLE_NAME)\n\tend\nend)" }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/param/1": { "documentation": "The Player whose inventory is tested for ownership of the given bundle." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/param/2": { "documentation": "The bundle ID for which the given player's inventory is tested." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/return/0": { "documentation": "Indicates whether the given player's inventory contains the given bundle." }, "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle": { "documentation": "Deprecated: This method has been superseded by PlayerOwnsBundleAsync().
Returns whether the given player owns the given bundle.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/param/1" }, { "name": "bundleId", "documentation": "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.PlayerOwnsBundle/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsBundle", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/1": { "documentation": "The user to prompt to purchase items." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/2": { "documentation": "An array of avatar items to be included in the bulk purchase. Each line item contains the following structure: 
{   Type: MarketplaceProductType,   Id: string }
Each line item contains the following pairs: " }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/3": { "documentation": "Not available at this time." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchase": { "documentation": "Prompts a user to purchase multiple avatar items with the given assetId or bundleId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/1" }, { "name": "lineItems", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchase/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptBulkPurchase", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchase/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchase/param/2": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchase": { "documentation": "Prompts a user to purchase a bundle with the given bundleId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchase/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchase/param/1" }, { "name": "bundleId", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchase/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptBundlePurchase", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptCancelSubscription/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptCancelSubscription/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptCancelSubscription/param/2": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptCancelSubscription": { "documentation": "Prompts a user to cancel a subscription for the given subscriptionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptCancelSubscription/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/MarketplaceService.PromptCancelSubscription/param/1" }, { "name": "subscriptionId", "documentation": "@roblox/globaltype/MarketplaceService.PromptCancelSubscription/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptCancelSubscription", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase/param/2": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase": { "documentation": "Prompts a user to purchase a pass with the given gamePassId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase/param/1" }, { "name": "gamePassId", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchase/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptGamePassPurchase", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchase/param/1": { "documentation": "The user being prompted to purchase Premium." }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchase": { "documentation": "Prompts a user to purchase Roblox Premium.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchase/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchase/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPremiumPurchase", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/2": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/3": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/4": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchase": { "documentation": "Prompts a user to purchase a developer product with the given productId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/1" }, { "name": "productId", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/2" }, { "name": "equipIfPurchased", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/3" }, { "name": "currencyType", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchase/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptProductPurchase", "code_sample": "local MarketplaceService = game:GetService(\"MarketplaceService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal productId = 0000000 -- Change this to your developer product ID\n\n-- Function to prompt purchase of the developer product\nlocal function promptPurchase()\n\tMarketplaceService:PromptProductPurchase(player, productId)\nend\n\npromptPurchase()" }, "@roblox/globaltype/MarketplaceService.PromptPurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptPurchase/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchase/param/2": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchase/param/3": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchase/param/4": { "documentation": "Ignored." }, "@roblox/globaltype/MarketplaceService.PromptPurchase": { "documentation": "Prompts a user to purchase an item with the given assetId. Does not work for USD Creator Store purchases.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchase/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchase/param/1" }, { "name": "assetId", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchase/param/2" }, { "name": "equipIfPurchased", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchase/param/3" }, { "name": "currencyType", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchase/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPurchase", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase/param/1": { "documentation": "The Player object to be prompted to subscribe." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase/param/2": { "documentation": "The ID of the subscription to subscribe to." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase": { "documentation": "Prompts a user to purchase a subscription for the given subscriptionId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase/param/1" }, { "name": "subscriptionId", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchase/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptSubscriptionPurchase", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.RankProductsAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.RankProductsAsync/param/1": { "documentation": "An array of objects identifying the products you want to rank. This array can include up to 50 items. Each ProductIdentifier has: 
local ProductIdentifier = {     InfoType = Enum.InfoType.GamePass,     Id = 123456 }
" }, "@roblox/globaltype/MarketplaceService.RankProductsAsync/return/0": { "documentation": "The array of ranked items in a personalized order for the current user. Each array has: " }, "@roblox/globaltype/MarketplaceService.RankProductsAsync": { "documentation": "Takes a list of product IDs and returns a personalized ordered list of those products.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.RankProductsAsync/param/0" }, { "name": "productIdentifiers", "documentation": "@roblox/globaltype/MarketplaceService.RankProductsAsync/param/1" } ], "returns": [ "@roblox/globaltype/MarketplaceService.RankProductsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RankProductsAsync", "code_sample": "-- Get the MarketplaceService\n local MarketplaceService = game:GetService(\"MarketplaceService\")\n\n-- Create the array of products you want to rank\nlocal productIdentifiers = {\n {InfoType = Enum.InfoType.GamePass, Id = 123},\n {InfoType = Enum.InfoType.Product, Id = 456},\n {InfoType = Enum.InfoType.Product, Id = 789}\n}\n\n-- Call in a protected call to handle errors gracefully\nlocal success, rankedProducts = pcall(function()\n return MarketplaceService:RankProductsAsync(productIdentifiers)\nend)\n\nif not success then\n error(\"Failed to rank products\")\nend\n\n-- Load the returned items into the store.\nfor i, rankedItem in ipairs(rankedProducts) do\n local productIdentifier = rankedItem.ProductIdentifier\n local productInfo = rankedItem.ProductInfo\n -- ...\n -- Logic to add products into store\nend" }, "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync/param/1": { "documentation": "An array of InfoType values specifying the types of product to retrieve recommendations for. Supported InfoTypes: InfoType.GamePass, InfoType.Product. 
local infoTypes = {     Enum.InfoType.GamePass,     Enum.InfoType.Product }
" }, "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync/return/0": { "documentation": "A ranked list of up to 50 items the user is most likely to engage with, based on the provided InfoTypes. If no recommendations can be determined, the method returns an empty list." }, "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync/param/0" }, { "name": "infoTypes", "documentation": "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync/param/1" } ], "returns": [ "@roblox/globaltype/MarketplaceService.RecommendTopProductsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RecommendTopProductsAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/param/0": { "documentation": "The service responsible for in-experience transactions." }, "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/param/1": { "documentation": "The UserId of the Player whose inventory you're checking." }, "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/param/2": { "documentation": "The pass ID you want to check for. Not to be confused with an asset ID." }, "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync": { "documentation": "Returns true if the player with the given UserId owns the pass with the given gamePassId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/param/1" }, { "name": "gamePassId", "documentation": "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/param/2" } ], "returns": [ "@roblox/globaltype/MarketplaceService.UserOwnsGamePassAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#UserOwnsGamePassAsync", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.ProcessReceipt/param/0": { "documentation": "The receiptInfo table passed to this callback contains the following data: " }, "@roblox/globaltype/MarketplaceService.ProcessReceipt/return/0": { "documentation": "An enum that represents how the developer product receipt was processed. " }, "@roblox/globaltype/MarketplaceService.ProcessReceipt": { "documentation": "A callback to process receipts of developer product purchases.", "params": [ { "name": "receiptInfo", "documentation": "@roblox/globaltype/MarketplaceService.ProcessReceipt/param/0" } ], "returns": [ "@roblox/globaltype/MarketplaceService.ProcessReceipt/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#ProcessReceipt", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished": { "documentation": "Fires when a purchase prompt for bulk avatar items is closed.", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptBulkPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptBulkPurchaseFinished", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptBundlePurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptBundlePurchaseFinished", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished": { "documentation": "Fires when a purchase prompt for a pass is closed.", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptGamePassPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptGamePassPurchaseFinished", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished": { "documentation": "Fires when a purchase prompt for Roblox Premium is closed.", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptPremiumPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPremiumPurchaseFinished", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished": { "documentation": "Fires when a purchase prompt for a developer product is closed. Do not use this event to process purchases.", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptProductPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptProductPurchaseFinished", "code_sample": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished": { "documentation": "Fires when a purchase prompt for an affiliate gear sale or other asset is closed. Does not fire for developer product or pass prompts.", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPurchaseFinished", "code_sample": "local MarketplaceService = game:GetService(\"MarketplaceService\")\n\nlocal function onPromptPurchaseFinished(player, assetId, isPurchased)\n\tif isPurchased then\n\t\tprint(player.Name, \"bought an item with AssetID:\", assetId)\n\telse\n\t\tprint(player.Name, \"didn't buy an item with AssetID:\", assetId)\n\tend\nend\n\nMarketplaceService.PromptPurchaseFinished:Connect(onPromptPurchaseFinished)" }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Once/param/1": { "documentation": "" }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished": { "documentation": "Fires when a purchase prompt for a subscription is closed.", "keys": { "Connect": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Connect", "ConnectParallel": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.ConnectParallel", "Once": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Once", "Wait": "@roblox/globaltype/MarketplaceService.PromptSubscriptionPurchaseFinished.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptSubscriptionPurchaseFinished", "code_sample": "" }, "@roblox/globaltype/Shirt": { "documentation": "Displays a shirt texture on a Humanoid rig.", "keys": { "ShirtTemplate": "@roblox/globaltype/Shirt.ShirtTemplate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Shirt", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function replaceClothes(player)\n\tlocal character = player.Character\n\tif character then\n\t\t-- look for shirts / pants\n\t\tlocal shirt = character:FindFirstChildOfClass(\"Shirt\")\n\t\tlocal pants = character:FindFirstChildOfClass(\"Pants\")\n\t\t-- create shirts / pants if they don't exist\n\t\tif not shirt then\n\t\t\tshirt = Instance.new(\"Shirt\")\n\t\t\tshirt.Parent = character\n\t\tend\n\t\tif not pants then\n\t\t\tpants = Instance.new(\"Pants\")\n\t\t\tpants.Parent = character\n\t\tend\n\t\t-- reset shirt / pants content ids\n\t\tshirt.ShirtTemplate = \"http://www.roblox.com/asset/?id=83326831\"\n\t\tpants.PantsTemplate = \"http://www.roblox.com/asset/?id=10045638\"\n\tend\nend\n\nfor _index, player in ipairs(Players:GetPlayers()) do\n\treplaceClothes(player)\nend" }, "@roblox/globaltype/Shirt.ShirtTemplate": { "documentation": "Determines the texture of the Shirt.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Shirt#ShirtTemplate", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function replaceClothes(player)\n\tlocal character = player.Character\n\tif character then\n\t\t-- look for shirts / pants\n\t\tlocal shirt = character:FindFirstChildOfClass(\"Shirt\")\n\t\tlocal pants = character:FindFirstChildOfClass(\"Pants\")\n\t\t-- create shirts / pants if they don't exist\n\t\tif not shirt then\n\t\t\tshirt = Instance.new(\"Shirt\")\n\t\t\tshirt.Parent = character\n\t\tend\n\t\tif not pants then\n\t\t\tpants = Instance.new(\"Pants\")\n\t\t\tpants.Parent = character\n\t\tend\n\t\t-- reset shirt / pants content ids\n\t\tshirt.ShirtTemplate = \"http://www.roblox.com/asset/?id=83326831\"\n\t\tpants.PantsTemplate = \"http://www.roblox.com/asset/?id=10045638\"\n\tend\nend\n\nfor _index, player in ipairs(Players:GetPlayers()) do\n\treplaceClothes(player)\nend" }, "@roblox/globaltype/Mouse": { "documentation": "Legacy object that contains members useful for pointer input.", "keys": { "Hit": "@roblox/globaltype/Mouse.Hit", "hit": "@roblox/globaltype/Mouse.hit", "Icon": "@roblox/globaltype/Mouse.Icon", "IconContent": "@roblox/globaltype/Mouse.IconContent", "Origin": "@roblox/globaltype/Mouse.Origin", "Target": "@roblox/globaltype/Mouse.Target", "target": "@roblox/globaltype/Mouse.target", "TargetFilter": "@roblox/globaltype/Mouse.TargetFilter", "TargetSurface": "@roblox/globaltype/Mouse.TargetSurface", "UnitRay": "@roblox/globaltype/Mouse.UnitRay", "ViewSizeX": "@roblox/globaltype/Mouse.ViewSizeX", "ViewSizeY": "@roblox/globaltype/Mouse.ViewSizeY", "X": "@roblox/globaltype/Mouse.X", "Y": "@roblox/globaltype/Mouse.Y" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse", "code_sample": "" }, "@roblox/globaltype/Mouse.Hit": { "documentation": "The CFrame of the mouse's position in 3D space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Hit", "code_sample": "" }, "@roblox/globaltype/Mouse.hit": { "documentation": "Deprecated: This property is a deprecated variant of Mouse.Hit which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#hit", "code_sample": "" }, "@roblox/globaltype/Mouse.Icon": { "documentation": "The content ID of the image used as the Mouse icon.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Icon", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal mouse = Players.LocalPlayer:GetMouse()\nmouse.Icon = \"http://www.roblox.com/asset?id=163023520\"" }, "@roblox/globaltype/Mouse.IconContent": { "documentation": "The content of the image used as the Mouse icon. Only supports asset URIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#IconContent", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal mouse = Players.LocalPlayer:GetMouse()\nmouse.Icon = \"http://www.roblox.com/asset?id=163023520\"" }, "@roblox/globaltype/Mouse.Origin": { "documentation": "A CFrame positioned at the Workspace.CurrentCamera and oriented toward the mouse's 3D position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Origin", "code_sample": "local Players = game:GetService(\"Players\")\nlocal Workspace = game:GetService(\"Workspace\")\n\nlocal player = Players.LocalPlayer\nlocal camera = Workspace.CurrentCamera\nlocal mouse = player:GetMouse()\nlocal camPos = camera.CFrame.Position\n\nlocal function onButton1Down()\n\tprint(\"Mouse.Hit:\", mouse.Hit.Position)\n\tprint(\"camPos:\", camPos)\n\tprint(\"Mouse.Origin:\", mouse.Origin.Position)\n\tprint(\"Magnitude:\", (mouse.Origin.Position - camPos).Magnitude)\nend\n\nmouse.Button1Down:Connect(onButton1Down)" }, "@roblox/globaltype/Mouse.Target": { "documentation": "The object in 3D space the mouse is pointing to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Target", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal localPlayer = Players.LocalPlayer\nlocal backpack = localPlayer:WaitForChild(\"Backpack\")\n\nlocal tool = Instance.new(\"Tool\")\ntool.RequiresHandle = false\ntool.CanBeDropped = false\ntool.Parent = backpack\n\ntool.Equipped:Connect(function(mouse)\n\tmouse.Button1Down:Connect(function()\n\t\tif mouse.Target and mouse.Target.Parent then\n\t\t\tmouse.Target.BrickColor = BrickColor.random()\n\t\tend\n\tend)\nend)" }, "@roblox/globaltype/Mouse.target": { "documentation": "Deprecated: This property is a deprecated variant of Mouse.Target which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#target", "code_sample": "" }, "@roblox/globaltype/Mouse.TargetFilter": { "documentation": "Determines an object (and its descendants) to be ignored when determining Mouse.Hit and Mouse.Target.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#TargetFilter", "code_sample": "" }, "@roblox/globaltype/Mouse.TargetSurface": { "documentation": "Indicates the NormalId of the BasePart surface at which the mouse is pointing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#TargetSurface", "code_sample": "" }, "@roblox/globaltype/Mouse.UnitRay": { "documentation": "A Ray directed towards the mouse's world position, originating from the Workspace.CurrentCamera world position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#UnitRay", "code_sample": "" }, "@roblox/globaltype/Mouse.ViewSizeX": { "documentation": "Describes the width of the game window in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#ViewSizeX", "code_sample": "local Players = game:GetService(\"Players\")\n\n-- Note: You should use ContextActionService or UserInputService instead of\n-- the Mouse object for accomplishing this task.\nlocal player = Players.LocalPlayer\nlocal mouse = player:GetMouse()\n\nlocal function onMouseMove()\n\t-- Construct Vector2 objects for the mouse's position and screen size\n\tlocal position = Vector2.new(mouse.X, mouse.Y)\n\tlocal size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)\n\t-- A normalized position will map the top left (just under the topbar)\n\t-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).\n\t-- This is calculated by dividing the position by the total size.\n\tlocal normalizedPosition = position / size\n\tprint(normalizedPosition)\nend\nmouse.Move:Connect(onMouseMove)" }, "@roblox/globaltype/Mouse.ViewSizeY": { "documentation": "Describes the height of the game window in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#ViewSizeY", "code_sample": "local Players = game:GetService(\"Players\")\n\n-- Note: You should use ContextActionService or UserInputService instead of\n-- the Mouse object for accomplishing this task.\nlocal player = Players.LocalPlayer\nlocal mouse = player:GetMouse()\n\nlocal function onMouseMove()\n\t-- Construct Vector2 objects for the mouse's position and screen size\n\tlocal position = Vector2.new(mouse.X, mouse.Y)\n\tlocal size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)\n\t-- A normalized position will map the top left (just under the topbar)\n\t-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).\n\t-- This is calculated by dividing the position by the total size.\n\tlocal normalizedPosition = position / size\n\tprint(normalizedPosition)\nend\nmouse.Move:Connect(onMouseMove)" }, "@roblox/globaltype/Mouse.X": { "documentation": "Describes the X (horizontal) component of the mouse's position on the screen.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#X", "code_sample": "local Players = game:GetService(\"Players\")\n\n-- Note: You should use ContextActionService or UserInputService instead of\n-- the Mouse object for accomplishing this task.\nlocal player = Players.LocalPlayer\nlocal mouse = player:GetMouse()\n\nlocal function onMouseMove()\n\t-- Construct Vector2 objects for the mouse's position and screen size\n\tlocal position = Vector2.new(mouse.X, mouse.Y)\n\tlocal size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)\n\t-- A normalized position will map the top left (just under the topbar)\n\t-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).\n\t-- This is calculated by dividing the position by the total size.\n\tlocal normalizedPosition = position / size\n\tprint(normalizedPosition)\nend\nmouse.Move:Connect(onMouseMove)" }, "@roblox/globaltype/Mouse.Y": { "documentation": "Describes the Y (vertical) component of the mouse's screen position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Y", "code_sample": "local Players = game:GetService(\"Players\")\n\n-- Note: You should use ContextActionService or UserInputService instead of\n-- the Mouse object for accomplishing this task.\nlocal player = Players.LocalPlayer\nlocal mouse = player:GetMouse()\n\nlocal function onMouseMove()\n\t-- Construct Vector2 objects for the mouse's position and screen size\n\tlocal position = Vector2.new(mouse.X, mouse.Y)\n\tlocal size = Vector2.new(mouse.ViewSizeX, mouse.ViewSizeY)\n\t-- A normalized position will map the top left (just under the topbar)\n\t-- to (0, 0) the bottom right to (1, 1), and the center to (0.5, 0.5).\n\t-- This is calculated by dividing the position by the total size.\n\tlocal normalizedPosition = position / size\n\tprint(normalizedPosition)\nend\nmouse.Move:Connect(onMouseMove)" }, "@roblox/globaltype/Mouse.Button1Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button1Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button1Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button1Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button1Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button1Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button1Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Down": { "documentation": "Fires when the left mouse button is pressed.", "keys": { "Connect": "@roblox/globaltype/Mouse.Button1Down.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.Button1Down.ConnectParallel", "Once": "@roblox/globaltype/Mouse.Button1Down.Once", "Wait": "@roblox/globaltype/Mouse.Button1Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Button1Down", "code_sample": "" }, "@roblox/globaltype/Mouse.Button1Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button1Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button1Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button1Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button1Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button1Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button1Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button1Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button1Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button1Up": { "documentation": "Fires when the left mouse button is released.", "keys": { "Connect": "@roblox/globaltype/Mouse.Button1Up.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.Button1Up.ConnectParallel", "Once": "@roblox/globaltype/Mouse.Button1Up.Once", "Wait": "@roblox/globaltype/Mouse.Button1Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Button1Up", "code_sample": "" }, "@roblox/globaltype/Mouse.Button2Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button2Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button2Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button2Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button2Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button2Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button2Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Down": { "documentation": "Fires when the right mouse button is pressed.", "keys": { "Connect": "@roblox/globaltype/Mouse.Button2Down.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.Button2Down.ConnectParallel", "Once": "@roblox/globaltype/Mouse.Button2Down.Once", "Wait": "@roblox/globaltype/Mouse.Button2Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Button2Down", "code_sample": "" }, "@roblox/globaltype/Mouse.Button2Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button2Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button2Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button2Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button2Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Button2Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Button2Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Button2Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Button2Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.Button2Up": { "documentation": "Fired when the right mouse button is released.", "keys": { "Connect": "@roblox/globaltype/Mouse.Button2Up.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.Button2Up.ConnectParallel", "Once": "@roblox/globaltype/Mouse.Button2Up.Once", "Wait": "@roblox/globaltype/Mouse.Button2Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Button2Up", "code_sample": "" }, "@roblox/globaltype/Mouse.Idle.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Idle.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Idle.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Idle.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Idle.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Idle.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Idle.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Idle.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Idle.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Idle.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Idle.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Idle.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Idle.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Idle.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Idle.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Idle.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Idle.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Idle.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.Idle": { "documentation": "Fired during every heartbeat that the mouse isn't being passed to another mouse event.", "keys": { "Connect": "@roblox/globaltype/Mouse.Idle.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.Idle.ConnectParallel", "Once": "@roblox/globaltype/Mouse.Idle.Once", "Wait": "@roblox/globaltype/Mouse.Idle.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Idle", "code_sample": "" }, "@roblox/globaltype/Mouse.KeyDown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyDown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.KeyDown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyDown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.KeyDown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyDown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyDown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.KeyDown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyDown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.KeyDown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyDown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyDown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.KeyDown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyDown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.KeyDown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyDown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyDown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyDown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyDown": { "documentation": "Deprecated: Mouse events have been superseded by UserInputService which should be used in all new work.
Fires when a Key is pressed.", "keys": { "Connect": "@roblox/globaltype/Mouse.KeyDown.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.KeyDown.ConnectParallel", "Once": "@roblox/globaltype/Mouse.KeyDown.Once", "Wait": "@roblox/globaltype/Mouse.KeyDown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyDown", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal mouse = player:GetMouse()\n\nlocal function onKeyDown(key)\n\tprint(\"Key:\", key, \"Code:\", string.byte(key))\nend\n\nmouse.KeyDown:Connect(onKeyDown)" }, "@roblox/globaltype/Mouse.keyDown.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.keyDown.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.keyDown.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.keyDown.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.keyDown.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.keyDown.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.keyDown.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.keyDown.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.keyDown.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.keyDown.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.keyDown.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.keyDown.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.keyDown.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.keyDown.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.keyDown.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.keyDown.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.keyDown.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.keyDown.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.keyDown": { "documentation": "Deprecated: This event is a deprecated variant of Mouse.KeyDown which has also been deprecated. Neither event should be used in new work.", "keys": { "Connect": "@roblox/globaltype/Mouse.keyDown.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.keyDown.ConnectParallel", "Once": "@roblox/globaltype/Mouse.keyDown.Once", "Wait": "@roblox/globaltype/Mouse.keyDown.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#keyDown", "code_sample": "" }, "@roblox/globaltype/Mouse.KeyUp.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyUp.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.KeyUp.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyUp.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.KeyUp.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyUp.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyUp.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.KeyUp.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyUp.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.KeyUp.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyUp.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyUp.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.KeyUp.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyUp.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.KeyUp.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyUp.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.KeyUp.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.KeyUp.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.KeyUp": { "documentation": "Deprecated: Mouse events have been superseded by UserInputService which should be used in all new work.
Fires when a Key is released.", "keys": { "Connect": "@roblox/globaltype/Mouse.KeyUp.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.KeyUp.ConnectParallel", "Once": "@roblox/globaltype/Mouse.KeyUp.Once", "Wait": "@roblox/globaltype/Mouse.KeyUp.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#KeyUp", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal mouse = player:GetMouse()\n\nlocal function onKeyUp(key)\n\tprint(\"Key:\", key, \"Code:\", string.byte(key))\nend\n\nmouse.KeyUp:Connect(onKeyUp)" }, "@roblox/globaltype/Mouse.Move.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Move.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Move.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Move.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Move.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Move.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Move.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Move.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Move.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Move.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Move.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Move.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.Move.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Move.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.Move.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.Move.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.Move.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.Move.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.Move": { "documentation": "Fired when the mouse is moved.", "keys": { "Connect": "@roblox/globaltype/Mouse.Move.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.Move.ConnectParallel", "Once": "@roblox/globaltype/Mouse.Move.Once", "Wait": "@roblox/globaltype/Mouse.Move.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#Move", "code_sample": "" }, "@roblox/globaltype/Mouse.WheelBackward.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelBackward.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.WheelBackward.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelBackward.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.WheelBackward.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelBackward.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelBackward.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.WheelBackward.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelBackward.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.WheelBackward.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelBackward.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelBackward.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.WheelBackward.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelBackward.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.WheelBackward.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelBackward.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelBackward.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelBackward.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelBackward": { "documentation": "Fires when the mouse wheel is scrolled backwards.", "keys": { "Connect": "@roblox/globaltype/Mouse.WheelBackward.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.WheelBackward.ConnectParallel", "Once": "@roblox/globaltype/Mouse.WheelBackward.Once", "Wait": "@roblox/globaltype/Mouse.WheelBackward.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#WheelBackward", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal mouse = player:GetMouse()\n\nlocal function onWheelBackward()\n\tprint(\"Wheel went backwards!\")\nend\n\nmouse.WheelBackward:Connect(onWheelBackward)" }, "@roblox/globaltype/Mouse.WheelForward.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelForward.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.WheelForward.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelForward.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.WheelForward.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelForward.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelForward.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.WheelForward.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelForward.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.WheelForward.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelForward.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelForward.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Mouse.WheelForward.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelForward.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Mouse.WheelForward.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelForward.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Mouse.WheelForward.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Mouse.WheelForward.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Mouse.WheelForward": { "documentation": "Fires when the mouse wheel is scrolled forwards.", "keys": { "Connect": "@roblox/globaltype/Mouse.WheelForward.Connect", "ConnectParallel": "@roblox/globaltype/Mouse.WheelForward.ConnectParallel", "Once": "@roblox/globaltype/Mouse.WheelForward.Once", "Wait": "@roblox/globaltype/Mouse.WheelForward.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Mouse#WheelForward", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal mouse = player:GetMouse()\n\nlocal function onWheelForward()\n\tprint(\"Wheel went forward!\")\nend\n\nmouse.WheelForward:Connect(onWheelForward)" }, "@roblox/globaltype/DataStoreService": { "documentation": "A game service that gives access to persistent data storage across places in a game.", "keys": { "GetDataStore": "@roblox/globaltype/DataStoreService.GetDataStore", "GetGlobalDataStore": "@roblox/globaltype/DataStoreService.GetGlobalDataStore", "GetOrderedDataStore": "@roblox/globaltype/DataStoreService.GetOrderedDataStore", "GetRequestBudgetForRequestType": "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType", "ListDataStoresAsync": "@roblox/globaltype/DataStoreService.ListDataStoresAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreService", "code_sample": "local DataStoreService = game:GetService(\"DataStoreService\")\n\nfor _, enumItem in pairs(Enum.DataStoreRequestType:GetEnumItems()) do\n\tprint(enumItem.Name, DataStoreService:GetRequestBudgetForRequestType(enumItem))\nend" }, "@roblox/globaltype/DataStoreService.GetDataStore/param/0": { "documentation": "A game service that gives access to persistent data storage across places in a game." }, "@roblox/globaltype/DataStoreService.GetDataStore/param/1": { "documentation": "Name of the data store." }, "@roblox/globaltype/DataStoreService.GetDataStore/param/2": { "documentation": "(Optional) A string specifying the scope." }, "@roblox/globaltype/DataStoreService.GetDataStore/param/3": { "documentation": "(Optional) A DataStoreOptions instance to enable experimental features and v2 API features." }, "@roblox/globaltype/DataStoreService.GetDataStore/return/0": { "documentation": "A DataStore instance with provided name and optional scope." }, "@roblox/globaltype/DataStoreService.GetDataStore": { "documentation": "Creates a DataStore instance with the provided name and scope.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreService.GetDataStore/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/DataStoreService.GetDataStore/param/1" }, { "name": "scope", "documentation": "@roblox/globaltype/DataStoreService.GetDataStore/param/2" }, { "name": "options", "documentation": "@roblox/globaltype/DataStoreService.GetDataStore/param/3" } ], "returns": [ "@roblox/globaltype/DataStoreService.GetDataStore/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetDataStore", "code_sample": "" }, "@roblox/globaltype/DataStoreService.GetGlobalDataStore/param/0": { "documentation": "A game service that gives access to persistent data storage across places in a game." }, "@roblox/globaltype/DataStoreService.GetGlobalDataStore/return/0": { "documentation": "" }, "@roblox/globaltype/DataStoreService.GetGlobalDataStore": { "documentation": "Returns the default data store.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreService.GetGlobalDataStore/param/0" } ], "returns": [ "@roblox/globaltype/DataStoreService.GetGlobalDataStore/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetGlobalDataStore", "code_sample": "local DataStoreService = game:GetService(\"DataStoreService\")\n\nlocal GlobalDataStore = DataStoreService:GetGlobalDataStore()\n\nprint(GlobalDataStore.Name)" }, "@roblox/globaltype/DataStoreService.GetOrderedDataStore/param/0": { "documentation": "A game service that gives access to persistent data storage across places in a game." }, "@roblox/globaltype/DataStoreService.GetOrderedDataStore/param/1": { "documentation": "" }, "@roblox/globaltype/DataStoreService.GetOrderedDataStore/param/2": { "documentation": "" }, "@roblox/globaltype/DataStoreService.GetOrderedDataStore/return/0": { "documentation": "" }, "@roblox/globaltype/DataStoreService.GetOrderedDataStore": { "documentation": "Get an OrderedDataStore given a name and optional scope.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreService.GetOrderedDataStore/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/DataStoreService.GetOrderedDataStore/param/1" }, { "name": "scope", "documentation": "@roblox/globaltype/DataStoreService.GetOrderedDataStore/param/2" } ], "returns": [ "@roblox/globaltype/DataStoreService.GetOrderedDataStore/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetOrderedDataStore", "code_sample": "" }, "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType/param/0": { "documentation": "A game service that gives access to persistent data storage across places in a game." }, "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType/param/1": { "documentation": "" }, "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType/return/0": { "documentation": "" }, "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType": { "documentation": "Returns the number of requests that can be made by the given request type.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType/param/0" }, { "name": "requestType", "documentation": "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType/param/1" } ], "returns": [ "@roblox/globaltype/DataStoreService.GetRequestBudgetForRequestType/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreService#GetRequestBudgetForRequestType", "code_sample": "" }, "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/0": { "documentation": "A game service that gives access to persistent data storage across places in a game." }, "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/1": { "documentation": "(Optional) Prefix to enumerate data stores that start with the given prefix." }, "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/2": { "documentation": "(Optional) Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 32 items per page." }, "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/3": { "documentation": "(Optional) Cursor to continue iteration." }, "@roblox/globaltype/DataStoreService.ListDataStoresAsync/return/0": { "documentation": "DataStoreListingPages instance containing DataStoreInfo instances that provide details such as name, creation time, and time last updated." }, "@roblox/globaltype/DataStoreService.ListDataStoresAsync": { "documentation": "Returns a DataStoreListingPages object for enumerating through all of the experience's data stores.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/0" }, { "name": "prefix", "documentation": "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/1" }, { "name": "pageSize", "documentation": "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/2" }, { "name": "cursor", "documentation": "@roblox/globaltype/DataStoreService.ListDataStoresAsync/param/3" } ], "returns": [ "@roblox/globaltype/DataStoreService.ListDataStoresAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreService#ListDataStoresAsync", "code_sample": "" }, "@roblox/globaltype/SunRaysEffect": { "documentation": "Renders dynamic rays from the sun.", "keys": { "Intensity": "@roblox/globaltype/SunRaysEffect.Intensity", "Spread": "@roblox/globaltype/SunRaysEffect.Spread" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SunRaysEffect", "code_sample": "" }, "@roblox/globaltype/SunRaysEffect.Intensity": { "documentation": "Determines the opacity of the sun rays.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SunRaysEffect#Intensity", "code_sample": "" }, "@roblox/globaltype/SunRaysEffect.Spread": { "documentation": "Determines how wide the sun rays will spread out.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SunRaysEffect#Spread", "code_sample": "" }, "@roblox/globaltype/CharacterAppearance": { "documentation": "The base class for objects that change the character's appearance, such as the BodyColors, CharacterMesh, ShirtGraphic, Pants and Shirt objects.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CharacterAppearance", "code_sample": "" }, "@roblox/globaltype/TouchInputService": { "documentation": "An internal service responsible for touch inputs on mobile devices.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TouchInputService", "code_sample": "" }, "@roblox/globaltype/Motor6D": { "documentation": "Creates an animatable joint between two BaseParts.", "keys": { "ChildName": "@roblox/globaltype/Motor6D.ChildName", "ParentName": "@roblox/globaltype/Motor6D.ParentName", "Transform": "@roblox/globaltype/Motor6D.Transform" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor6D", "code_sample": "" }, "@roblox/globaltype/Motor6D.ChildName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor6D#ChildName", "code_sample": "" }, "@roblox/globaltype/Motor6D.ParentName": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor6D#ParentName", "code_sample": "" }, "@roblox/globaltype/Motor6D.Transform": { "documentation": "Describes the current animation offset of the Motor6D joint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor6D#Transform", "code_sample": "" }, "@roblox/globaltype/ViewportFrame": { "documentation": "GuiObject that renders 3D objects inside its bounds.", "keys": { "Ambient": "@roblox/globaltype/ViewportFrame.Ambient", "CurrentCamera": "@roblox/globaltype/ViewportFrame.CurrentCamera", "ImageColor3": "@roblox/globaltype/ViewportFrame.ImageColor3", "ImageTransparency": "@roblox/globaltype/ViewportFrame.ImageTransparency", "LightColor": "@roblox/globaltype/ViewportFrame.LightColor", "LightDirection": "@roblox/globaltype/ViewportFrame.LightDirection" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\nlocal playerGui = player:WaitForChild(\"PlayerGui\")\nlocal screenGui = Instance.new(\"ScreenGui\")\nscreenGui.Parent = playerGui\n\nlocal viewportFrame = Instance.new(\"ViewportFrame\")\nviewportFrame.Size = UDim2.new(0.3, 0, 0.4, 0)\nviewportFrame.Position = UDim2.new(0, 15, 0, 15)\nviewportFrame.BackgroundColor3 = Color3.new(0, 0, 0)\nviewportFrame.BorderColor3 = Color3.new(0.6, 0.5, 0.4)\nviewportFrame.BorderSizePixel = 2\nviewportFrame.BackgroundTransparency = 0.25\nviewportFrame.Parent = screenGui\n\nlocal part = Instance.new(\"Part\")\npart.Material = Enum.Material.Concrete\npart.Color = Color3.new(0.25, 0.75, 1)\npart.Position = Vector3.new(0, 0, 0)\npart.Parent = viewportFrame\n\nlocal viewportCamera = Instance.new(\"Camera\")\nviewportFrame.CurrentCamera = viewportCamera\nviewportCamera.Parent = viewportFrame\n\nviewportCamera.CFrame = CFrame.new(Vector3.new(0, 2, 12), part.Position)" }, "@roblox/globaltype/ViewportFrame.Ambient": { "documentation": "The lighting hue applied to the area within the ViewportFrame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame#Ambient", "code_sample": "" }, "@roblox/globaltype/ViewportFrame.CurrentCamera": { "documentation": "Camera that is used to render children objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame#CurrentCamera", "code_sample": "" }, "@roblox/globaltype/ViewportFrame.ImageColor3": { "documentation": "Determines how the rendered viewport image will be colorized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame#ImageColor3", "code_sample": "" }, "@roblox/globaltype/ViewportFrame.ImageTransparency": { "documentation": "Determines the transparency of the rendered viewport image.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame#ImageTransparency", "code_sample": "" }, "@roblox/globaltype/ViewportFrame.LightColor": { "documentation": "The color of the emitted light.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame#LightColor", "code_sample": "" }, "@roblox/globaltype/ViewportFrame.LightDirection": { "documentation": "A Vector3 representing the direction of the light source.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ViewportFrame#LightDirection", "code_sample": "" }, "@roblox/globaltype/FluidForceSensor": { "documentation": "A SensorBase that outputs Force, Torque and CenterOfPressure.", "keys": { "CenterOfPressure": "@roblox/globaltype/FluidForceSensor.CenterOfPressure", "Force": "@roblox/globaltype/FluidForceSensor.Force", "Torque": "@roblox/globaltype/FluidForceSensor.Torque", "EvaluateAsync": "@roblox/globaltype/FluidForceSensor.EvaluateAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FluidForceSensor", "code_sample": "" }, "@roblox/globaltype/FluidForceSensor.CenterOfPressure": { "documentation": "Assembly center of pressure offset from its center of mass in world coordinates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FluidForceSensor#CenterOfPressure", "code_sample": "" }, "@roblox/globaltype/FluidForceSensor.Force": { "documentation": "Assembly fluid force in world coordinates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FluidForceSensor#Force", "code_sample": "" }, "@roblox/globaltype/FluidForceSensor.Torque": { "documentation": "Assembly fluid torque in world coordinates.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FluidForceSensor#Torque", "code_sample": "" }, "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/0": { "documentation": "A SensorBase that outputs Force, Torque and CenterOfPressure." }, "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/1": { "documentation": "Linear velocity in world coordinates." }, "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/2": { "documentation": "Angular velocity in world coordinates." }, "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/3": { "documentation": "CFrame to be used for evaluation." }, "@roblox/globaltype/FluidForceSensor.EvaluateAsync/return/0": { "documentation": "Tuple of Force, Torque and CenterOfPressure calculated given the input parameters." }, "@roblox/globaltype/FluidForceSensor.EvaluateAsync": { "documentation": "Asynchronously computes force, torque, and center of pressure for the parent part of a sensor given provided inputs.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/0" }, { "name": "linearVelocity", "documentation": "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/1" }, { "name": "angularVelocity", "documentation": "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/2" }, { "name": "cframe", "documentation": "@roblox/globaltype/FluidForceSensor.EvaluateAsync/param/3" } ], "returns": [ "@roblox/globaltype/FluidForceSensor.EvaluateAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FluidForceSensor#EvaluateAsync", "code_sample": "" }, "@roblox/globaltype/VideoService": { "documentation": "An internal service that offers no functionality to developers.", "keys": { "CreateVideoSamplerAsync": "@roblox/globaltype/VideoService.CreateVideoSamplerAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoService", "code_sample": "" }, "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/param/0": { "documentation": "An internal service that offers no functionality to developers." }, "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/param/1": { "documentation": "The video content to sample from." }, "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/param/2": { "documentation": "Options table for creating the VideoSampler: " }, "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/return/0": { "documentation": "The created VideoSampler." }, "@roblox/globaltype/VideoService.CreateVideoSamplerAsync": { "documentation": "Creates a VideoSampler that samples frames from the provided video content.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/param/0" }, { "name": "content", "documentation": "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/param/1" }, { "name": "options", "documentation": "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/param/2" } ], "returns": [ "@roblox/globaltype/VideoService.CreateVideoSamplerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoService#CreateVideoSamplerAsync", "code_sample": "" }, "@roblox/globaltype/Debris": { "documentation": "Allows scheduling the guaranteed destruction of an object without yielding.
.", "keys": { "MaxItems": "@roblox/globaltype/Debris.MaxItems", "AddItem": "@roblox/globaltype/Debris.AddItem", "addItem": "@roblox/globaltype/Debris.addItem" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Debris", "code_sample": "" }, "@roblox/globaltype/Debris.MaxItems": { "documentation": "Deprecated: This property is deprecated and should not be used in new work.
The maximum number of items that can be assigned to the Debris service at one time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Debris#MaxItems", "code_sample": "" }, "@roblox/globaltype/Debris.AddItem/param/0": { "documentation": "Allows scheduling the guaranteed destruction of an object without yielding.
." }, "@roblox/globaltype/Debris.AddItem/param/1": { "documentation": "The Instance to add to Debris." }, "@roblox/globaltype/Debris.AddItem/param/2": { "documentation": "Number of seconds before the Instance should be destroyed." }, "@roblox/globaltype/Debris.AddItem": { "documentation": "Schedules a given Instance for destruction within the specified lifetime.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Debris.AddItem/param/0" }, { "name": "item", "documentation": "@roblox/globaltype/Debris.AddItem/param/1" }, { "name": "lifetime", "documentation": "@roblox/globaltype/Debris.AddItem/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Debris#AddItem", "code_sample": "" }, "@roblox/globaltype/Debris.addItem/param/0": { "documentation": "Allows scheduling the guaranteed destruction of an object without yielding.
." }, "@roblox/globaltype/Debris.addItem/param/1": { "documentation": "" }, "@roblox/globaltype/Debris.addItem/param/2": { "documentation": "" }, "@roblox/globaltype/Debris.addItem": { "documentation": "Deprecated: This function is a deprecated variant of Debris:AddItem() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Debris.addItem/param/0" }, { "name": "item", "documentation": "@roblox/globaltype/Debris.addItem/param/1" }, { "name": "lifetime", "documentation": "@roblox/globaltype/Debris.addItem/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Debris#addItem", "code_sample": "" }, "@roblox/globaltype/Status": { "documentation": "Deprecated: Status is an unfinished object designed to store custom Humanoid statuses. It has been deprecated and should not be used by developers in new work. Developers looking to implement custom Humanoid statuses should use Character Physics Controllers, as they are written in Luau and are easily extendable.
An unfinished object which offers no functionality to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Status", "code_sample": "" }, "@roblox/globaltype/VehicleSeat": { "documentation": "A seat object that can be used to control a vehicle.", "keys": { "AreHingesDetected": "@roblox/globaltype/VehicleSeat.AreHingesDetected", "Disabled": "@roblox/globaltype/VehicleSeat.Disabled", "HeadsUpDisplay": "@roblox/globaltype/VehicleSeat.HeadsUpDisplay", "MaxSpeed": "@roblox/globaltype/VehicleSeat.MaxSpeed", "Occupant": "@roblox/globaltype/VehicleSeat.Occupant", "Steer": "@roblox/globaltype/VehicleSeat.Steer", "SteerFloat": "@roblox/globaltype/VehicleSeat.SteerFloat", "Throttle": "@roblox/globaltype/VehicleSeat.Throttle", "ThrottleFloat": "@roblox/globaltype/VehicleSeat.ThrottleFloat", "Torque": "@roblox/globaltype/VehicleSeat.Torque", "TurnSpeed": "@roblox/globaltype/VehicleSeat.TurnSpeed", "Sit": "@roblox/globaltype/VehicleSeat.Sit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.AreHingesDetected": { "documentation": "Displays how many hinges are detected by the VehicleSeat. Useful for debugging vehicle designs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#AreHingesDetected", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.Disabled": { "documentation": "Toggles whether the VehicleSeat is active or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Disabled", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.HeadsUpDisplay": { "documentation": "If true, a fancy speed bar will be displayed speed on screen that tells you what speed the Vehicle is moving at.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#HeadsUpDisplay", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.MaxSpeed": { "documentation": "The maximum speed that can be attained.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#MaxSpeed", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.Occupant": { "documentation": "The humanoid that is sitting in the seat.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Occupant", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.Steer": { "documentation": "The direction of movement, tied to the keys A and D. Must be one of 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Steer", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.SteerFloat": { "documentation": "Functions identically to VehicleSeat.Steer, but the value is not an integer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#SteerFloat", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.Throttle": { "documentation": "The direction of movement, tied to the keys W and S. Must be an integer 1 (forward) 0 (null) or -1 (reverse). Will refresh back to 0 unless constantly set.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Throttle", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.ThrottleFloat": { "documentation": "Functions identically to VehicleSeat.Throttle, but the value is not an integer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#ThrottleFloat", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.Torque": { "documentation": "How fast the vehicles will be able to attain VehicleSeat.MaxSpeed. The greater the number, the faster it will reach the maximum speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Torque", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.TurnSpeed": { "documentation": "The speed at which the vehicle will turn. Higher numbers can cause problems and are not necessarily better.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#TurnSpeed", "code_sample": "" }, "@roblox/globaltype/VehicleSeat.Sit/param/0": { "documentation": "A seat object that can be used to control a vehicle." }, "@roblox/globaltype/VehicleSeat.Sit/param/1": { "documentation": "The humanoid being forced to sit in the VehicleSeat." }, "@roblox/globaltype/VehicleSeat.Sit": { "documentation": "Forces the character with the specified Humanoid to sit in the VehicleSeat.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VehicleSeat.Sit/param/0" }, { "name": "humanoid", "documentation": "@roblox/globaltype/VehicleSeat.Sit/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Sit", "code_sample": "" }, "@roblox/globaltype/PluginDragEvent": { "documentation": "", "keys": { "Data": "@roblox/globaltype/PluginDragEvent.Data", "MimeType": "@roblox/globaltype/PluginDragEvent.MimeType", "Position": "@roblox/globaltype/PluginDragEvent.Position", "Sender": "@roblox/globaltype/PluginDragEvent.Sender" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent", "code_sample": "" }, "@roblox/globaltype/PluginDragEvent.Data": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent#Data", "code_sample": "" }, "@roblox/globaltype/PluginDragEvent.MimeType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent#MimeType", "code_sample": "" }, "@roblox/globaltype/PluginDragEvent.Position": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent#Position", "code_sample": "" }, "@roblox/globaltype/PluginDragEvent.Sender": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PluginDragEvent#Sender", "code_sample": "" }, "@roblox/globaltype/TweenBase": { "documentation": "Abstract base class for in-between interpolation handlers. Tween inherits from TweenBase.", "keys": { "PlaybackState": "@roblox/globaltype/TweenBase.PlaybackState", "Cancel": "@roblox/globaltype/TweenBase.Cancel", "Pause": "@roblox/globaltype/TweenBase.Pause", "Play": "@roblox/globaltype/TweenBase.Play" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenBase", "code_sample": "" }, "@roblox/globaltype/TweenBase.PlaybackState": { "documentation": "Read-only property that shows the current state for the Tween animation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenBase#PlaybackState", "code_sample": "" }, "@roblox/globaltype/TweenBase.Cancel/param/0": { "documentation": "Abstract base class for in-between interpolation handlers. Tween inherits from TweenBase." }, "@roblox/globaltype/TweenBase.Cancel": { "documentation": "Halts playback and resets the tween variables. If you then call TweenBase:Play(), the properties of the tween resume interpolating towards their destination, but take the full length of the animation to do so.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Cancel/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenBase#Cancel", "code_sample": "" }, "@roblox/globaltype/TweenBase.Pause/param/0": { "documentation": "Abstract base class for in-between interpolation handlers. Tween inherits from TweenBase." }, "@roblox/globaltype/TweenBase.Pause": { "documentation": "Halts playback of the tween. Doesn't reset its progress variables, meaning that if you call TweenBase:Play(), the tween resumes playback from the moment it was paused.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenBase#Pause", "code_sample": "local TweenService = game:GetService(\"TweenService\")\n\nlocal part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 10, 0)\npart.Anchored = true\npart.BrickColor = BrickColor.new(\"Bright green\")\npart.Parent = workspace\n\nlocal goal = {}\ngoal.Position = Vector3.new(50, 10, 0)\n\nlocal tweenInfo = TweenInfo.new(10, Enum.EasingStyle.Linear)\n\nlocal tween = TweenService:Create(part, tweenInfo, goal)\n\ntween:Play()\n\ntask.wait(3)\npart.BrickColor = BrickColor.new(\"Bright red\")\ntween:Pause()\n\ntask.wait(2)\npart.BrickColor = BrickColor.new(\"Bright green\")\ntween:Play()" }, "@roblox/globaltype/TweenBase.Play/param/0": { "documentation": "Abstract base class for in-between interpolation handlers. Tween inherits from TweenBase." }, "@roblox/globaltype/TweenBase.Play": { "documentation": "Starts playback of a tween. Note that if playback has already started, calling Play() has no effect unless the tween has finished or is stopped (either by TweenBase:Cancel() or TweenBase:Pause()).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenBase#Play", "code_sample": "local TweenService = game:GetService(\"TweenService\")\n\nlocal part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 10, 0)\npart.Color = Color3.new(1, 0, 0)\npart.Anchored = true\npart.Parent = game.Workspace\n\nlocal goal = {}\ngoal.Position = Vector3.new(10, 10, 0)\ngoal.Color = Color3.new(0, 1, 0)\n\nlocal tweenInfo = TweenInfo.new(5)\n\nlocal tween = TweenService:Create(part, tweenInfo, goal)\n\ntween:Play()" }, "@roblox/globaltype/TweenBase.Completed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TweenBase.Completed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TweenBase.Completed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Completed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TweenBase.Completed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TweenBase.Completed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TweenBase.Completed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TweenBase.Completed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Completed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TweenBase.Completed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TweenBase.Completed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TweenBase.Completed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TweenBase.Completed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Completed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TweenBase.Completed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TweenBase.Completed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TweenBase.Completed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenBase.Completed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TweenBase.Completed": { "documentation": "Fires when the tween finishes playing or when stopped with TweenBase:Cancel().", "keys": { "Connect": "@roblox/globaltype/TweenBase.Completed.Connect", "ConnectParallel": "@roblox/globaltype/TweenBase.Completed.ConnectParallel", "Once": "@roblox/globaltype/TweenBase.Completed.Once", "Wait": "@roblox/globaltype/TweenBase.Completed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenBase#Completed", "code_sample": "" }, "@roblox/globaltype/SerializationService": { "documentation": "", "keys": { "DeserializeInstancesAsync": "@roblox/globaltype/SerializationService.DeserializeInstancesAsync", "SerializeInstancesAsync": "@roblox/globaltype/SerializationService.SerializeInstancesAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SerializationService", "code_sample": "" }, "@roblox/globaltype/SerializationService.DeserializeInstancesAsync/param/0": { "documentation": "" }, "@roblox/globaltype/SerializationService.DeserializeInstancesAsync/param/1": { "documentation": "" }, "@roblox/globaltype/SerializationService.DeserializeInstancesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/SerializationService.DeserializeInstancesAsync": { "documentation": "Deserializes a buffer containing .rbxm content, returning a list of instances.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SerializationService.DeserializeInstancesAsync/param/0" }, { "name": "buffer", "documentation": "@roblox/globaltype/SerializationService.DeserializeInstancesAsync/param/1" } ], "returns": [ "@roblox/globaltype/SerializationService.DeserializeInstancesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SerializationService#DeserializeInstancesAsync", "code_sample": "" }, "@roblox/globaltype/SerializationService.SerializeInstancesAsync/param/0": { "documentation": "" }, "@roblox/globaltype/SerializationService.SerializeInstancesAsync/param/1": { "documentation": "" }, "@roblox/globaltype/SerializationService.SerializeInstancesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/SerializationService.SerializeInstancesAsync": { "documentation": "Serializes a list of instances to the .rbxm format, returning a buffer or .rbxm content.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SerializationService.SerializeInstancesAsync/param/0" }, { "name": "inputInstances", "documentation": "@roblox/globaltype/SerializationService.SerializeInstancesAsync/param/1" } ], "returns": [ "@roblox/globaltype/SerializationService.SerializeInstancesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SerializationService#SerializeInstancesAsync", "code_sample": "" }, "@roblox/globaltype/NoCollisionConstraint": { "documentation": "An instance used to prevent collisions between two specific parts.", "keys": { "Enabled": "@roblox/globaltype/NoCollisionConstraint.Enabled", "Part0": "@roblox/globaltype/NoCollisionConstraint.Part0", "Part1": "@roblox/globaltype/NoCollisionConstraint.Part1" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NoCollisionConstraint", "code_sample": "" }, "@roblox/globaltype/NoCollisionConstraint.Enabled": { "documentation": "Determines whether the two linked BaseParts will collide with each other.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NoCollisionConstraint#Enabled", "code_sample": "" }, "@roblox/globaltype/NoCollisionConstraint.Part0": { "documentation": "The second BasePart that the constraint connects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NoCollisionConstraint#Part0", "code_sample": "" }, "@roblox/globaltype/NoCollisionConstraint.Part1": { "documentation": "The first BasePart that the constraint connects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NoCollisionConstraint#Part1", "code_sample": "" }, "@roblox/globaltype/ContentProvider": { "documentation": "Service that is used to load content, or assets, into a game.", "keys": { "BaseUrl": "@roblox/globaltype/ContentProvider.BaseUrl", "RequestQueueSize": "@roblox/globaltype/ContentProvider.RequestQueueSize", "GetAssetFetchStatus": "@roblox/globaltype/ContentProvider.GetAssetFetchStatus", "GetAssetFetchStatusChangedSignal": "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal", "ListEncryptedAssets": "@roblox/globaltype/ContentProvider.ListEncryptedAssets", "Preload": "@roblox/globaltype/ContentProvider.Preload", "PreloadAsync": "@roblox/globaltype/ContentProvider.PreloadAsync", "RegisterDefaultEncryptionKey": "@roblox/globaltype/ContentProvider.RegisterDefaultEncryptionKey", "RegisterDefaultSessionKey": "@roblox/globaltype/ContentProvider.RegisterDefaultSessionKey", "RegisterEncryptedAsset": "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset", "RegisterSessionEncryptedAsset": "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset", "UnregisterDefaultEncryptionKey": "@roblox/globaltype/ContentProvider.UnregisterDefaultEncryptionKey", "UnregisterEncryptedAsset": "@roblox/globaltype/ContentProvider.UnregisterEncryptedAsset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider", "code_sample": "local ContentProvider = game:GetService(\"ContentProvider\")\n\nlocal LOGO_ID = \"rbxassetid://658743164\"\nlocal PAGE_TURN_ID = \"rbxassetid://12222076\"\n\nlocal decal = Instance.new(\"Decal\")\ndecal.ColorMapContent = LOGO_ID\n\nlocal sound = Instance.new(\"Sound\")\nsound.SoundId = PAGE_TURN_ID\n\nlocal assets = { decal, sound }\n\nContentProvider:PreloadAsync(assets)\n\nprint(\"All assets loaded.\")" }, "@roblox/globaltype/ContentProvider.BaseUrl": { "documentation": "Used by the ContentProvider to download assets from the Roblox website.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#BaseUrl", "code_sample": "" }, "@roblox/globaltype/ContentProvider.RequestQueueSize": { "documentation": "Gives the number of items in the ContentProvider request queue that need to be downloaded.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RequestQueueSize", "code_sample": "" }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatus/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatus/param/1": { "documentation": "The ID of the content to fetch the status for." }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatus/return/0": { "documentation": "The AssetFetchStatus of the content." }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatus": { "documentation": "Gets the current AssetFetchStatus of the contentId provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.GetAssetFetchStatus/param/0" }, { "name": "contentId", "documentation": "@roblox/globaltype/ContentProvider.GetAssetFetchStatus/param/1" } ], "returns": [ "@roblox/globaltype/ContentProvider.GetAssetFetchStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#GetAssetFetchStatus", "code_sample": "" }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal/return/0": { "documentation": "" }, "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal": { "documentation": "A signal that fires when the AssetFetchStatus of the provided content changes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal/param/0" }, { "name": "contentId", "documentation": "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal/param/1" } ], "returns": [ "@roblox/globaltype/ContentProvider.GetAssetFetchStatusChangedSignal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#GetAssetFetchStatusChangedSignal", "code_sample": "" }, "@roblox/globaltype/ContentProvider.ListEncryptedAssets/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.ListEncryptedAssets/return/0": { "documentation": "" }, "@roblox/globaltype/ContentProvider.ListEncryptedAssets": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.ListEncryptedAssets/param/0" } ], "returns": [ "@roblox/globaltype/ContentProvider.ListEncryptedAssets/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#ListEncryptedAssets", "code_sample": "" }, "@roblox/globaltype/ContentProvider.Preload/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.Preload/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.Preload": { "documentation": "Deprecated: This item has been superseded by ContentProvider:PreloadAsync() which should be used in all new work.
Queues an asset to be downloaded by the ContentProvider.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.Preload/param/0" }, { "name": "contentId", "documentation": "@roblox/globaltype/ContentProvider.Preload/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#Preload", "code_sample": "local ContentProvider = game:GetService(\"ContentProvider\")\n\nContentProvider:Preload(\"http://www.roblox.com/asset/?id=12222058\")" }, "@roblox/globaltype/ContentProvider.PreloadAsync/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.PreloadAsync/param/1": { "documentation": "An array of instances to load." }, "@roblox/globaltype/ContentProvider.PreloadAsync/param/2": { "documentation": "The function called when each asset request completes. Returns the content string and the asset's final AssetFetchStatus." }, "@roblox/globaltype/ContentProvider.PreloadAsync": { "documentation": "Yields until all of the assets associated with the given Instances have loaded.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.PreloadAsync/param/0" }, { "name": "contentIdList", "documentation": "@roblox/globaltype/ContentProvider.PreloadAsync/param/1" }, { "name": "callbackFunction", "documentation": "@roblox/globaltype/ContentProvider.PreloadAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#PreloadAsync", "code_sample": "local ContentProvider = game:GetService(\"ContentProvider\")\n\nlocal sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://9120386436\"\nlocal decal = Instance.new(\"Decal\")\ndecal.ColorMapContent = \"rbxassetid://5447528495\"\n\nlocal assets = {\n\tdecal,\n\tsound,\n}\n\n-- This will be hit as each asset resolves\nlocal callback = function(assetId, assetFetchStatus)\n\tprint(\"PreloadAsync() resolved asset ID:\", assetId)\n\tprint(\"PreloadAsync() final AssetFetchStatus:\", assetFetchStatus)\nend\n\n-- Preload the content and time it\nlocal startTime = os.clock()\nContentProvider:PreloadAsync(assets, callback)\nlocal deltaTime = os.clock() - startTime\nprint((\"Preloading complete, took %.2f seconds\"):format(deltaTime))" }, "@roblox/globaltype/ContentProvider.RegisterDefaultEncryptionKey/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.RegisterDefaultEncryptionKey/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.RegisterDefaultEncryptionKey": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.RegisterDefaultEncryptionKey/param/0" }, { "name": "encryptionKey", "documentation": "@roblox/globaltype/ContentProvider.RegisterDefaultEncryptionKey/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterDefaultEncryptionKey", "code_sample": "" }, "@roblox/globaltype/ContentProvider.RegisterDefaultSessionKey/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.RegisterDefaultSessionKey/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.RegisterDefaultSessionKey": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.RegisterDefaultSessionKey/param/0" }, { "name": "sessionKey", "documentation": "@roblox/globaltype/ContentProvider.RegisterDefaultSessionKey/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterDefaultSessionKey", "code_sample": "" }, "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset/param/2": { "documentation": "" }, "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset/param/1" }, { "name": "encryptionKey", "documentation": "@roblox/globaltype/ContentProvider.RegisterEncryptedAsset/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterEncryptedAsset", "code_sample": "" }, "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset/param/2": { "documentation": "" }, "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset/param/0" }, { "name": "contentId", "documentation": "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset/param/1" }, { "name": "sessionKey", "documentation": "@roblox/globaltype/ContentProvider.RegisterSessionEncryptedAsset/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#RegisterSessionEncryptedAsset", "code_sample": "" }, "@roblox/globaltype/ContentProvider.UnregisterDefaultEncryptionKey/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.UnregisterDefaultEncryptionKey": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.UnregisterDefaultEncryptionKey/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#UnregisterDefaultEncryptionKey", "code_sample": "" }, "@roblox/globaltype/ContentProvider.UnregisterEncryptedAsset/param/0": { "documentation": "Service that is used to load content, or assets, into a game." }, "@roblox/globaltype/ContentProvider.UnregisterEncryptedAsset/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.UnregisterEncryptedAsset": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.UnregisterEncryptedAsset/param/0" }, { "name": "assetId", "documentation": "@roblox/globaltype/ContentProvider.UnregisterEncryptedAsset/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#UnregisterEncryptedAsset", "code_sample": "" }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContentProvider.AssetFetchFailed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ContentProvider.AssetFetchFailed": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Connect", "ConnectParallel": "@roblox/globaltype/ContentProvider.AssetFetchFailed.ConnectParallel", "Once": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Once", "Wait": "@roblox/globaltype/ContentProvider.AssetFetchFailed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContentProvider#AssetFetchFailed", "code_sample": "" }, "@roblox/globaltype/ILegacyStudioBridge": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ILegacyStudioBridge", "code_sample": "" }, "@roblox/globaltype/Team": { "documentation": "The Team class represents a faction in a Roblox place. The only valid parent for a Team is in the Teams service.", "keys": { "AutoAssignable": "@roblox/globaltype/Team.AutoAssignable", "AutoColorCharacters": "@roblox/globaltype/Team.AutoColorCharacters", "Score": "@roblox/globaltype/Team.Score", "TeamColor": "@roblox/globaltype/Team.TeamColor", "GetPlayers": "@roblox/globaltype/Team.GetPlayers" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team", "code_sample": "" }, "@roblox/globaltype/Team.AutoAssignable": { "documentation": "This property determines whether Players will be automatically placed onto the Team when joining. If multiple teams have this property set to true, Roblox will attempt to even the teams out when Players are added.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#AutoAssignable", "code_sample": "" }, "@roblox/globaltype/Team.AutoColorCharacters": { "documentation": "Deprecated: This property is deprecated and no longer functions, it should not be used for new work.
Deprecated and no longer functional. Historically set whether or not Player character models on a team would be colored to Team.TeamColor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#AutoColorCharacters", "code_sample": "" }, "@roblox/globaltype/Team.Score": { "documentation": "Deprecated: This property is deprecated and should not be used in new work. For more information on how to handle leaderboards and scoring please see this tutorial.
This property can be used to store an integer value associated with the team. This property offers no additional functionality and is not used by any game services.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#Score", "code_sample": "" }, "@roblox/globaltype/Team.TeamColor": { "documentation": "This property sets the color of the Team. Determines the Player.TeamColor property of players who are a member of the team. Also determines the color displayed on the player list and above player's heads.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#TeamColor", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal door = Instance.new(\"Part\")\ndoor.Anchored = true\ndoor.Size = Vector3.new(7, 10, 1)\ndoor.Position = Vector3.new(0, 5, 0)\ndoor.Parent = workspace\n\nlocal debounce = false\n\ndoor.Touched:Connect(function(hit)\n\tif not debounce then\n\t\tdebounce = true\n\t\tif hit then\n\t\t\tlocal player = Players:GetPlayerFromCharacter(hit.Parent)\n\t\t\tif player and player.TeamColor == BrickColor.new(\"Bright red\") then\n\t\t\t\tdoor.Transparency = 0.5\n\t\t\t\tdoor.CanCollide = false\n\t\t\t\ttask.wait(3)\n\t\t\t\tdoor.Transparency = 0\n\t\t\t\tdoor.CanCollide = true\n\t\t\tend\n\t\tend\n\t\ttask.wait(0.5)\n\t\tdebounce = false\n\tend\nend)" }, "@roblox/globaltype/Team.GetPlayers/param/0": { "documentation": "The Team class represents a faction in a Roblox place. The only valid parent for a Team is in the Teams service." }, "@roblox/globaltype/Team.GetPlayers/return/0": { "documentation": "An array of Players in the Team." }, "@roblox/globaltype/Team.GetPlayers": { "documentation": "Returns a list of Players who are assigned to the Team. A Player is considered assigned if their Player.Team property is equal to the Team and Player.Neutral is false.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.GetPlayers/param/0" } ], "returns": [ "@roblox/globaltype/Team.GetPlayers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#GetPlayers", "code_sample": "local Teams = game:GetService(\"Teams\")\n\nlocal teams = Teams:GetTeams()\n\nfor _, team in pairs(teams) do\n\tlocal players = team:GetPlayers()\n\tprint(\"Team\", team.Name, \"has\", #players, \"players\")\nend" }, "@roblox/globaltype/Team.PlayerAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Team.PlayerAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Team.PlayerAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Team.PlayerAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Team.PlayerAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Team.PlayerAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Team.PlayerAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerAdded": { "documentation": "Fires whenever a Player is assigned to the Team. A player is considered assigned if their Player.Team property is equal to the Team and Player.Neutral is false.", "keys": { "Connect": "@roblox/globaltype/Team.PlayerAdded.Connect", "ConnectParallel": "@roblox/globaltype/Team.PlayerAdded.ConnectParallel", "Once": "@roblox/globaltype/Team.PlayerAdded.Once", "Wait": "@roblox/globaltype/Team.PlayerAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#PlayerAdded", "code_sample": "" }, "@roblox/globaltype/Team.PlayerRemoved.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerRemoved.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Team.PlayerRemoved.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerRemoved.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Team.PlayerRemoved.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerRemoved.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerRemoved.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Team.PlayerRemoved.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerRemoved.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Team.PlayerRemoved.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerRemoved.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerRemoved.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Team.PlayerRemoved.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerRemoved.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Team.PlayerRemoved.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerRemoved.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Team.PlayerRemoved.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Team.PlayerRemoved.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Team.PlayerRemoved": { "documentation": "Fires whenever a Player is removed from a Team. This can be due to the Player leaving the game, Player.Neutral being set to true or the Player joining a different team.", "keys": { "Connect": "@roblox/globaltype/Team.PlayerRemoved.Connect", "ConnectParallel": "@roblox/globaltype/Team.PlayerRemoved.ConnectParallel", "Once": "@roblox/globaltype/Team.PlayerRemoved.Once", "Wait": "@roblox/globaltype/Team.PlayerRemoved.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Team#PlayerRemoved", "code_sample": "" }, "@roblox/globaltype/TaskScheduler": { "documentation": "Collection of settings for the Task Scheduler feature.", "keys": { "SchedulerDutyCycle": "@roblox/globaltype/TaskScheduler.SchedulerDutyCycle", "SchedulerRate": "@roblox/globaltype/TaskScheduler.SchedulerRate", "ThreadPoolConfig": "@roblox/globaltype/TaskScheduler.ThreadPoolConfig", "ThreadPoolSize": "@roblox/globaltype/TaskScheduler.ThreadPoolSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TaskScheduler", "code_sample": "" }, "@roblox/globaltype/TaskScheduler.SchedulerDutyCycle": { "documentation": "The average time divided by the average interval of the duty cycle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TaskScheduler#SchedulerDutyCycle", "code_sample": "" }, "@roblox/globaltype/TaskScheduler.SchedulerRate": { "documentation": "The current average rate of the task scheduler.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TaskScheduler#SchedulerRate", "code_sample": "" }, "@roblox/globaltype/TaskScheduler.ThreadPoolConfig": { "documentation": "The specified thread pooling configuration for the task scheduler.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TaskScheduler#ThreadPoolConfig", "code_sample": "" }, "@roblox/globaltype/TaskScheduler.ThreadPoolSize": { "documentation": "The current size of the thread pool.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TaskScheduler#ThreadPoolSize", "code_sample": "" }, "@roblox/globaltype/PathfindingLink": { "documentation": "Connects two locations which otherwise by default are unconnected.", "keys": { "Attachment0": "@roblox/globaltype/PathfindingLink.Attachment0", "Attachment1": "@roblox/globaltype/PathfindingLink.Attachment1", "IsBidirectional": "@roblox/globaltype/PathfindingLink.IsBidirectional", "Label": "@roblox/globaltype/PathfindingLink.Label" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingLink", "code_sample": "" }, "@roblox/globaltype/PathfindingLink.Attachment0": { "documentation": "The originating attachment of the link.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingLink#Attachment0", "code_sample": "" }, "@roblox/globaltype/PathfindingLink.Attachment1": { "documentation": "The landing attachment of the link.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingLink#Attachment1", "code_sample": "" }, "@roblox/globaltype/PathfindingLink.IsBidirectional": { "documentation": "Enables a path to traverse a link in both directions. The default value is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingLink#IsBidirectional", "code_sample": "" }, "@roblox/globaltype/PathfindingLink.Label": { "documentation": "A classifying string to add additional information about the link. This Label is included in the waypoint generated by this link.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingLink#Label", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams": { "documentation": "Instance to be passed to AssetService:SearchAudioAsync() to search for audio assets.", "keys": { "Album": "@roblox/globaltype/AudioSearchParams.Album", "Artist": "@roblox/globaltype/AudioSearchParams.Artist", "AudioSubType": "@roblox/globaltype/AudioSearchParams.AudioSubType", "AudioSubtype": "@roblox/globaltype/AudioSearchParams.AudioSubtype", "MaxDuration": "@roblox/globaltype/AudioSearchParams.MaxDuration", "MinDuration": "@roblox/globaltype/AudioSearchParams.MinDuration", "SearchKeyword": "@roblox/globaltype/AudioSearchParams.SearchKeyword", "Tag": "@roblox/globaltype/AudioSearchParams.Tag", "Title": "@roblox/globaltype/AudioSearchParams.Title" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.Album": { "documentation": "The album the audio asset belongs to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#Album", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.Artist": { "documentation": "The artist that created the audio asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#Artist", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.AudioSubType": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubType", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.AudioSubtype": { "documentation": "Deprecated:
The subtype of the audio asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#AudioSubtype", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.MaxDuration": { "documentation": "The maximum duration of the audio asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#MaxDuration", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.MinDuration": { "documentation": "The minimum duration of the audio asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#MinDuration", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.SearchKeyword": { "documentation": "The keyword to search for.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#SearchKeyword", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.Tag": { "documentation": "The tag of the audio asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#Tag", "code_sample": "" }, "@roblox/globaltype/AudioSearchParams.Title": { "documentation": "The title of the audio asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioSearchParams#Title", "code_sample": "" }, "@roblox/globaltype/ControllerService": { "documentation": "Container class for the HumanoidController among other classes.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerService", "code_sample": "" }, "@roblox/globaltype/TerrainReadOperation": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainReadOperation", "code_sample": "" }, "@roblox/globaltype/TerrainReadOperation.Ready.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainReadOperation.Ready.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainReadOperation.Ready.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainReadOperation.Ready.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainReadOperation.Ready.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainReadOperation.Ready.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainReadOperation.Ready.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainReadOperation.Ready.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TerrainReadOperation.Ready.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TerrainReadOperation.Ready.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TerrainReadOperation.Ready.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TerrainReadOperation.Ready.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TerrainReadOperation.Ready": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/TerrainReadOperation.Ready.Connect", "ConnectParallel": "@roblox/globaltype/TerrainReadOperation.Ready.ConnectParallel", "Once": "@roblox/globaltype/TerrainReadOperation.Ready.Once", "Wait": "@roblox/globaltype/TerrainReadOperation.Ready.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TerrainReadOperation#Ready", "code_sample": "" }, "@roblox/globaltype/InventoryPages": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InventoryPages", "code_sample": "" }, "@roblox/globaltype/ReplicatedFirst": { "documentation": "A container whose contents are replicated to all clients (but not back to the server) first before anything else.", "keys": { "RemoveDefaultLoadingScreen": "@roblox/globaltype/ReplicatedFirst.RemoveDefaultLoadingScreen" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReplicatedFirst", "code_sample": "" }, "@roblox/globaltype/ReplicatedFirst.RemoveDefaultLoadingScreen/param/0": { "documentation": "A container whose contents are replicated to all clients (but not back to the server) first before anything else." }, "@roblox/globaltype/ReplicatedFirst.RemoveDefaultLoadingScreen": { "documentation": "Immediately removes the default Roblox loading screen.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ReplicatedFirst.RemoveDefaultLoadingScreen/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReplicatedFirst#RemoveDefaultLoadingScreen", "code_sample": "" }, "@roblox/globaltype/AssetPatchSettings": { "documentation": "", "keys": { "ContentId": "@roblox/globaltype/AssetPatchSettings.ContentId", "OutputPath": "@roblox/globaltype/AssetPatchSettings.OutputPath", "PatchId": "@roblox/globaltype/AssetPatchSettings.PatchId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings", "code_sample": "" }, "@roblox/globaltype/AssetPatchSettings.ContentId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings#ContentId", "code_sample": "" }, "@roblox/globaltype/AssetPatchSettings.OutputPath": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings#OutputPath", "code_sample": "" }, "@roblox/globaltype/AssetPatchSettings.PatchId": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AssetPatchSettings#PatchId", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint": { "documentation": "Forces its two attachments into the same position and allows them to freely rotate about all three axes, with optional limits to restrict both tilt and twist.", "keys": { "LimitsEnabled": "@roblox/globaltype/BallSocketConstraint.LimitsEnabled", "MaxFrictionTorque": "@roblox/globaltype/BallSocketConstraint.MaxFrictionTorque", "Radius": "@roblox/globaltype/BallSocketConstraint.Radius", "Restitution": "@roblox/globaltype/BallSocketConstraint.Restitution", "TwistLimitsEnabled": "@roblox/globaltype/BallSocketConstraint.TwistLimitsEnabled", "TwistLowerAngle": "@roblox/globaltype/BallSocketConstraint.TwistLowerAngle", "TwistUpperAngle": "@roblox/globaltype/BallSocketConstraint.TwistUpperAngle", "UpperAngle": "@roblox/globaltype/BallSocketConstraint.UpperAngle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.LimitsEnabled": { "documentation": "Sets whether the BallSocketConstraint sets a limit on rotation based on UpperAngle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.MaxFrictionTorque": { "documentation": "Sets the maximum frictional torque applied to keep its Attachments aligned.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#MaxFrictionTorque", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.Radius": { "documentation": "The visualized radius of the BallSocketConstraint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#Radius", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.Restitution": { "documentation": "How elastic Attachments connected by a BallSocketConstraint will be when they reach the end of the range specified by UpperAngle when LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#Restitution", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.TwistLimitsEnabled": { "documentation": "Sets whether the BallSocketConstraint sets a limit on twist rotation based on TwistUpperAngle and TwistLowerAngle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#TwistLimitsEnabled", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.TwistLowerAngle": { "documentation": "Sets the lower twist rotation limit of the BallSocketConstraint, as long as TwistLimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#TwistLowerAngle", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.TwistUpperAngle": { "documentation": "Sets the upper twist rotation limit of the BallSocketConstraint, as long as TwistLimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#TwistUpperAngle", "code_sample": "" }, "@roblox/globaltype/BallSocketConstraint.UpperAngle": { "documentation": "Sets the upper rotation limit of the BallSocketConstraint, as long as LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BallSocketConstraint#UpperAngle", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties": { "documentation": "", "keys": { "FontFace": "@roblox/globaltype/ChatWindowMessageProperties.FontFace", "PrefixTextProperties": "@roblox/globaltype/ChatWindowMessageProperties.PrefixTextProperties", "TextColor3": "@roblox/globaltype/ChatWindowMessageProperties.TextColor3", "TextSize": "@roblox/globaltype/ChatWindowMessageProperties.TextSize", "TextStrokeColor3": "@roblox/globaltype/ChatWindowMessageProperties.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/ChatWindowMessageProperties.TextStrokeTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties.FontFace": { "documentation": "Font used to render text in the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties#FontFace", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties.PrefixTextProperties": { "documentation": "Determines the properties of the PrefixText preceding the chat message.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties#PrefixTextProperties", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties.TextColor3": { "documentation": "Color of the text in the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties#TextColor3", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties.TextSize": { "documentation": "Size of the text in the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties#TextSize", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties.TextStrokeColor3": { "documentation": "Stroke color applied to text in the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/ChatWindowMessageProperties.TextStrokeTransparency": { "documentation": "Transparency of the stroke applied to text in the chat window.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChatWindowMessageProperties#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/Handles": { "documentation": "Places 3D handles around any object that its Adornee is set to.", "keys": { "Faces": "@roblox/globaltype/Handles.Faces", "Style": "@roblox/globaltype/Handles.Style" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles", "code_sample": "" }, "@roblox/globaltype/Handles.Faces": { "documentation": "Sets which sides the GUI handles will appear.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#Faces", "code_sample": "" }, "@roblox/globaltype/Handles.Style": { "documentation": "Sets the GUI style of the handles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#Style", "code_sample": "" }, "@roblox/globaltype/Handles.MouseButton1Down.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Down.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseButton1Down.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Down.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Down.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseButton1Down.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Down.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Down.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseButton1Down.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Down.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Down.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Down.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Down": { "documentation": "Fired when the left mouse button goes down on one of the GUI handles.", "keys": { "Connect": "@roblox/globaltype/Handles.MouseButton1Down.Connect", "ConnectParallel": "@roblox/globaltype/Handles.MouseButton1Down.ConnectParallel", "Once": "@roblox/globaltype/Handles.MouseButton1Down.Once", "Wait": "@roblox/globaltype/Handles.MouseButton1Down.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#MouseButton1Down", "code_sample": "" }, "@roblox/globaltype/Handles.MouseButton1Up.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Up.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseButton1Up.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Up.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Up.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseButton1Up.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Up.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Up.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseButton1Up.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Up.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseButton1Up.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseButton1Up.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseButton1Up": { "documentation": "Fired when the left mouse button is released on one of the GUI handles.", "keys": { "Connect": "@roblox/globaltype/Handles.MouseButton1Up.Connect", "ConnectParallel": "@roblox/globaltype/Handles.MouseButton1Up.ConnectParallel", "Once": "@roblox/globaltype/Handles.MouseButton1Up.Once", "Wait": "@roblox/globaltype/Handles.MouseButton1Up.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#MouseButton1Up", "code_sample": "" }, "@roblox/globaltype/Handles.MouseDrag.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseDrag.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseDrag.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseDrag.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseDrag.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseDrag.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseDrag.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseDrag.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseDrag.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseDrag.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseDrag.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseDrag.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseDrag.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseDrag.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseDrag.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseDrag.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseDrag.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseDrag.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseDrag": { "documentation": "Fired when the mouse moves while the MouseButton1Down event has fired, but the left mouse button has not been released yet.", "keys": { "Connect": "@roblox/globaltype/Handles.MouseDrag.Connect", "ConnectParallel": "@roblox/globaltype/Handles.MouseDrag.ConnectParallel", "Once": "@roblox/globaltype/Handles.MouseDrag.Once", "Wait": "@roblox/globaltype/Handles.MouseDrag.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#MouseDrag", "code_sample": "" }, "@roblox/globaltype/Handles.MouseEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseEnter": { "documentation": "Fired when a mouse \"enters\" the GUI handle.", "keys": { "Connect": "@roblox/globaltype/Handles.MouseEnter.Connect", "ConnectParallel": "@roblox/globaltype/Handles.MouseEnter.ConnectParallel", "Once": "@roblox/globaltype/Handles.MouseEnter.Once", "Wait": "@roblox/globaltype/Handles.MouseEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#MouseEnter", "code_sample": "" }, "@roblox/globaltype/Handles.MouseLeave.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseLeave.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseLeave.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseLeave.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseLeave.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseLeave.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseLeave.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseLeave.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseLeave.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseLeave.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseLeave.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseLeave.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Handles.MouseLeave.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseLeave.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Handles.MouseLeave.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseLeave.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Handles.MouseLeave.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Handles.MouseLeave.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Handles.MouseLeave": { "documentation": "Fired when the mouse leaves the GUI handle.", "keys": { "Connect": "@roblox/globaltype/Handles.MouseLeave.Connect", "ConnectParallel": "@roblox/globaltype/Handles.MouseLeave.ConnectParallel", "Once": "@roblox/globaltype/Handles.MouseLeave.Once", "Wait": "@roblox/globaltype/Handles.MouseLeave.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Handles#MouseLeave", "code_sample": "" }, "@roblox/globaltype/MicroProfilerService": { "documentation": "", "keys": { "ContextLabel": "@roblox/globaltype/MicroProfilerService.ContextLabel" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService", "code_sample": "" }, "@roblox/globaltype/MicroProfilerService.ContextLabel": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#ContextLabel", "code_sample": "" }, "@roblox/globaltype/BodyPosition": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use AlignPosition instead, and see the legacy conversion notes.
Applies a force to maintain a constant position.", "keys": { "D": "@roblox/globaltype/BodyPosition.D", "MaxForce": "@roblox/globaltype/BodyPosition.MaxForce", "maxForce": "@roblox/globaltype/BodyPosition.maxForce", "P": "@roblox/globaltype/BodyPosition.P", "Position": "@roblox/globaltype/BodyPosition.Position", "position": "@roblox/globaltype/BodyPosition.position", "GetLastForce": "@roblox/globaltype/BodyPosition.GetLastForce", "lastForce": "@roblox/globaltype/BodyPosition.lastForce" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition", "code_sample": "" }, "@roblox/globaltype/BodyPosition.D": { "documentation": "Determines the amount of dampening to use in reaching the goal Position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#D", "code_sample": "" }, "@roblox/globaltype/BodyPosition.MaxForce": { "documentation": "Determines the limit on how much force that may be applied to each axis.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#MaxForce", "code_sample": "" }, "@roblox/globaltype/BodyPosition.maxForce": { "documentation": "Deprecated: This property is a deprecated variant of BodyPosition.MaxForce which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#maxForce", "code_sample": "" }, "@roblox/globaltype/BodyPosition.P": { "documentation": "Determines how aggressive of a force is applied in reaching the goal position.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#P", "code_sample": "" }, "@roblox/globaltype/BodyPosition.Position": { "documentation": "Determines the goal position towards which force will be applied.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#Position", "code_sample": "" }, "@roblox/globaltype/BodyPosition.position": { "documentation": "Deprecated: This is a deprecated variant of BodyPosition.Position which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#position", "code_sample": "" }, "@roblox/globaltype/BodyPosition.GetLastForce/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use AlignPosition instead, and see the legacy conversion notes.
Applies a force to maintain a constant position." }, "@roblox/globaltype/BodyPosition.GetLastForce/return/0": { "documentation": "" }, "@roblox/globaltype/BodyPosition.GetLastForce": { "documentation": "Returns the last force in the object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyPosition.GetLastForce/param/0" } ], "returns": [ "@roblox/globaltype/BodyPosition.GetLastForce/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#GetLastForce", "code_sample": "" }, "@roblox/globaltype/BodyPosition.lastForce/param/0": { "documentation": "Deprecated: This object is deprecated and should not be used for new work. Use AlignPosition instead, and see the legacy conversion notes.
Applies a force to maintain a constant position." }, "@roblox/globaltype/BodyPosition.lastForce/return/0": { "documentation": "" }, "@roblox/globaltype/BodyPosition.lastForce": { "documentation": "Deprecated: This property has been superseded by BodyPosition:GetLastForce() which should be used in new work instead,
Returns the last force in the object.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyPosition.lastForce/param/0" } ], "returns": [ "@roblox/globaltype/BodyPosition.lastForce/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#lastForce", "code_sample": "" }, "@roblox/globaltype/BodyPosition.ReachedTarget.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BodyPosition.ReachedTarget.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BodyPosition.ReachedTarget.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BodyPosition.ReachedTarget.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BodyPosition.ReachedTarget.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BodyPosition.ReachedTarget.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BodyPosition.ReachedTarget.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BodyPosition.ReachedTarget.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BodyPosition.ReachedTarget.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BodyPosition.ReachedTarget.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BodyPosition.ReachedTarget.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BodyPosition.ReachedTarget.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BodyPosition.ReachedTarget": { "documentation": "Fired when the Parent of the BodyPosition reaches the desired BodyPosition.Position (within .1 studs). Once this event fires it will not fire again until BodyPosition.Position is updated.", "keys": { "Connect": "@roblox/globaltype/BodyPosition.ReachedTarget.Connect", "ConnectParallel": "@roblox/globaltype/BodyPosition.ReachedTarget.ConnectParallel", "Once": "@roblox/globaltype/BodyPosition.ReachedTarget.Once", "Wait": "@roblox/globaltype/BodyPosition.ReachedTarget.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPosition#ReachedTarget", "code_sample": "" }, "@roblox/globaltype/Wire": { "documentation": "Connects one or more Instances to form a processing graph of their streams. At the moment, only audio streams are supported, but this may expand in the future.", "keys": { "Connected": "@roblox/globaltype/Wire.Connected", "SourceInstance": "@roblox/globaltype/Wire.SourceInstance", "SourceName": "@roblox/globaltype/Wire.SourceName", "TargetInstance": "@roblox/globaltype/Wire.TargetInstance", "TargetName": "@roblox/globaltype/Wire.TargetName" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Wire", "code_sample": "" }, "@roblox/globaltype/Wire.Connected": { "documentation": "Denotes whether the Wire is carrying a stream of data.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Wire#Connected", "code_sample": "" }, "@roblox/globaltype/Wire.SourceInstance": { "documentation": "The Instance producing a stream to be carried over the wire.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Wire#SourceInstance", "code_sample": "" }, "@roblox/globaltype/Wire.SourceName": { "documentation": "The name of the pin on SourceInstance that is producing a stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Wire#SourceName", "code_sample": "" }, "@roblox/globaltype/Wire.TargetInstance": { "documentation": "The Instance to receive a stream from SourceInstance.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Wire#TargetInstance", "code_sample": "" }, "@roblox/globaltype/Wire.TargetName": { "documentation": "The name of the pin on TargetInstance that is receiving a stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Wire#TargetName", "code_sample": "" }, "@roblox/globaltype/ExperienceInviteOptions": { "documentation": "Used to customize a player invite prompt.", "keys": { "InviteMessageId": "@roblox/globaltype/ExperienceInviteOptions.InviteMessageId", "InviteUser": "@roblox/globaltype/ExperienceInviteOptions.InviteUser", "LaunchData": "@roblox/globaltype/ExperienceInviteOptions.LaunchData", "PromptMessage": "@roblox/globaltype/ExperienceInviteOptions.PromptMessage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceInviteOptions", "code_sample": "" }, "@roblox/globaltype/ExperienceInviteOptions.InviteMessageId": { "documentation": "Asset ID that maps to a Notification asset type.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceInviteOptions#InviteMessageId", "code_sample": "" }, "@roblox/globaltype/ExperienceInviteOptions.InviteUser": { "documentation": "Roblox UserId of the specific connection to invite.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceInviteOptions#InviteUser", "code_sample": "" }, "@roblox/globaltype/ExperienceInviteOptions.LaunchData": { "documentation": "Used to set a parameter in Player:GetJoinData() when a connection joins from the invite notification.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceInviteOptions#LaunchData", "code_sample": "" }, "@roblox/globaltype/ExperienceInviteOptions.PromptMessage": { "documentation": "Custom text shown on the invite prompt for the sending player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ExperienceInviteOptions#PromptMessage", "code_sample": "" }, "@roblox/globaltype/TextGenerator": { "documentation": "Gives access to a large language model for text generation.", "keys": { "Seed": "@roblox/globaltype/TextGenerator.Seed", "SystemPrompt": "@roblox/globaltype/TextGenerator.SystemPrompt", "Temperature": "@roblox/globaltype/TextGenerator.Temperature", "TopP": "@roblox/globaltype/TextGenerator.TopP", "GenerateTextAsync": "@roblox/globaltype/TextGenerator.GenerateTextAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextGenerator", "code_sample": "" }, "@roblox/globaltype/TextGenerator.Seed": { "documentation": "Sets a fixed seed for the random number generator, allowing reproducible responses in cases where the same input parameters are used across multiple requests.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextGenerator#Seed", "code_sample": "" }, "@roblox/globaltype/TextGenerator.SystemPrompt": { "documentation": "Provides context to the model about its role, tone, or behavior during conversation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextGenerator#SystemPrompt", "code_sample": "" }, "@roblox/globaltype/TextGenerator.Temperature": { "documentation": "Controls the \"creativity\" or randomness of the model's responses.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextGenerator#Temperature", "code_sample": "" }, "@roblox/globaltype/TextGenerator.TopP": { "documentation": "Helps the AI model narrow or expand the range of possible words to sample from while generating the next token.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextGenerator#TopP", "code_sample": "" }, "@roblox/globaltype/TextGenerator.GenerateTextAsync/param/0": { "documentation": "Gives access to a large language model for text generation." }, "@roblox/globaltype/TextGenerator.GenerateTextAsync/param/1": { "documentation": "A dictionary containing optional parameters for the text generation request. The currently supported parameters are UserPrompt, ContextToken, and MaxTokens." }, "@roblox/globaltype/TextGenerator.GenerateTextAsync/return/0": { "documentation": "A dictionary containing the generated response." }, "@roblox/globaltype/TextGenerator.GenerateTextAsync": { "documentation": "Returns text generated by an LLM based on the provided system and user prompts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextGenerator.GenerateTextAsync/param/0" }, { "name": "request", "documentation": "@roblox/globaltype/TextGenerator.GenerateTextAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextGenerator.GenerateTextAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextGenerator#GenerateTextAsync", "code_sample": "" }, "@roblox/globaltype/Message": { "documentation": "Deprecated: With the introduction of Roblox's GUI features hints have been deprecated and TextLabels should be used instead for new work. The TextLabel object offers a wide range of features for displaying and customizing text that messages do not.
Fills the entire screen with a semi-transparent grey background, with centered text in the middle of the screen.", "keys": { "Text": "@roblox/globaltype/Message.Text" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Message", "code_sample": "" }, "@roblox/globaltype/Message.Text": { "documentation": "Sets the text of a Message or Hint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Message#Text", "code_sample": "" }, "@roblox/globaltype/CoreGui": { "documentation": "The CoreGui is a service used to store Guis created in-game by Roblox for the core user interface found in every game (such as the game menu, the playerlist, the backpack, etc.). It can also be used by Plugins in Roblox Studio.", "keys": { "SelectionImageObject": "@roblox/globaltype/CoreGui.SelectionImageObject", "Version": "@roblox/globaltype/CoreGui.Version" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CoreGui", "code_sample": "" }, "@roblox/globaltype/CoreGui.SelectionImageObject": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CoreGui#SelectionImageObject", "code_sample": "" }, "@roblox/globaltype/CoreGui.Version": { "documentation": "The current version of the CoreGui. Every time the CoreGui is majorly changed, this number is increased.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CoreGui#Version", "code_sample": "" }, "@roblox/globaltype/ReflectionMetadataClasses": { "documentation": "An internal object which cannot be used by developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ReflectionMetadataClasses", "code_sample": "" }, "@roblox/globaltype/MessagingService": { "documentation": "Allows servers of the same experience to communicate with each other.", "keys": { "PublishAsync": "@roblox/globaltype/MessagingService.PublishAsync", "SubscribeAsync": "@roblox/globaltype/MessagingService.SubscribeAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MessagingService", "code_sample": "" }, "@roblox/globaltype/MessagingService.PublishAsync/param/0": { "documentation": "Allows servers of the same experience to communicate with each other." }, "@roblox/globaltype/MessagingService.PublishAsync/param/1": { "documentation": "Determines where the message is sent." }, "@roblox/globaltype/MessagingService.PublishAsync/param/2": { "documentation": "The data to include in the message." }, "@roblox/globaltype/MessagingService.PublishAsync": { "documentation": "Invokes the supplied callback whenever a message is pushed to the topic.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MessagingService.PublishAsync/param/0" }, { "name": "topic", "documentation": "@roblox/globaltype/MessagingService.PublishAsync/param/1" }, { "name": "message", "documentation": "@roblox/globaltype/MessagingService.PublishAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MessagingService#PublishAsync", "code_sample": "" }, "@roblox/globaltype/MessagingService.SubscribeAsync/param/0": { "documentation": "Allows servers of the same experience to communicate with each other." }, "@roblox/globaltype/MessagingService.SubscribeAsync/param/1": { "documentation": "Determines where to listen for messages." }, "@roblox/globaltype/MessagingService.SubscribeAsync/param/2": { "documentation": "Function to be invoked whenever a message is received." }, "@roblox/globaltype/MessagingService.SubscribeAsync/return/0": { "documentation": "Connection that can be used to unsubscribe from the topic." }, "@roblox/globaltype/MessagingService.SubscribeAsync": { "documentation": "Begins listening to the given topic.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MessagingService.SubscribeAsync/param/0" }, { "name": "topic", "documentation": "@roblox/globaltype/MessagingService.SubscribeAsync/param/1" }, { "name": "callback", "documentation": "@roblox/globaltype/MessagingService.SubscribeAsync/param/2" } ], "returns": [ "@roblox/globaltype/MessagingService.SubscribeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MessagingService#SubscribeAsync", "code_sample": "local MessagingService = game:GetService(\"MessagingService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\t--subscribe to the topic\n\tlocal topic = \"player-\" .. player.UserId\n\tlocal connection = MessagingService:SubscribeAsync(topic, function(message)\n\t\tprint(\"Received message for\", player.Name, message.Data)\n\tend)\n\n\tplayer.AncestryChanged:Connect(function()\n\t\t-- unsubscribe from the topic\n\t\tconnection:Disconnect()\n\tend)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/BillboardGui": { "documentation": "A container for GuiObjects that renders in 3D space facing the camera.", "keys": { "Active": "@roblox/globaltype/BillboardGui.Active", "Adornee": "@roblox/globaltype/BillboardGui.Adornee", "AlwaysOnTop": "@roblox/globaltype/BillboardGui.AlwaysOnTop", "Brightness": "@roblox/globaltype/BillboardGui.Brightness", "ClipsDescendants": "@roblox/globaltype/BillboardGui.ClipsDescendants", "CurrentDistance": "@roblox/globaltype/BillboardGui.CurrentDistance", "DistanceLowerLimit": "@roblox/globaltype/BillboardGui.DistanceLowerLimit", "DistanceStep": "@roblox/globaltype/BillboardGui.DistanceStep", "DistanceUpperLimit": "@roblox/globaltype/BillboardGui.DistanceUpperLimit", "ExtentsOffset": "@roblox/globaltype/BillboardGui.ExtentsOffset", "ExtentsOffsetWorldSpace": "@roblox/globaltype/BillboardGui.ExtentsOffsetWorldSpace", "LightInfluence": "@roblox/globaltype/BillboardGui.LightInfluence", "MaxDistance": "@roblox/globaltype/BillboardGui.MaxDistance", "PlayerToHideFrom": "@roblox/globaltype/BillboardGui.PlayerToHideFrom", "Size": "@roblox/globaltype/BillboardGui.Size", "SizeOffset": "@roblox/globaltype/BillboardGui.SizeOffset", "StudsOffset": "@roblox/globaltype/BillboardGui.StudsOffset", "StudsOffsetWorldSpace": "@roblox/globaltype/BillboardGui.StudsOffsetWorldSpace" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui", "code_sample": "" }, "@roblox/globaltype/BillboardGui.Active": { "documentation": "Controls whether the descendants will receive input events.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#Active", "code_sample": "" }, "@roblox/globaltype/BillboardGui.Adornee": { "documentation": "Sets the target part or attachment that the BillboardGui is positioned relative to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#Adornee", "code_sample": "" }, "@roblox/globaltype/BillboardGui.AlwaysOnTop": { "documentation": "Determines whether the BillboardGui will always be rendered on top of other 3D objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#AlwaysOnTop", "code_sample": "" }, "@roblox/globaltype/BillboardGui.Brightness": { "documentation": "Determines the factor by which the BillboardGui container's light is scaled when LightInfluence is 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#Brightness", "code_sample": "" }, "@roblox/globaltype/BillboardGui.ClipsDescendants": { "documentation": "Whether portions of GuiObjects that fall outside of the BillboardGui canvas borders will be drawn.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#ClipsDescendants", "code_sample": "" }, "@roblox/globaltype/BillboardGui.CurrentDistance": { "documentation": "The current distance in studs that the BillboardGui is from the player's camera.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#CurrentDistance", "code_sample": "" }, "@roblox/globaltype/BillboardGui.DistanceLowerLimit": { "documentation": "Deprecated:
Determines the distance in studs at which the BillboardGui will stop scaling larger in size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#DistanceLowerLimit", "code_sample": "" }, "@roblox/globaltype/BillboardGui.DistanceStep": { "documentation": "Determines the size CurrentDistance increments and decrements in studs as the player's camera moves closer and further from the BillboardGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#DistanceStep", "code_sample": "" }, "@roblox/globaltype/BillboardGui.DistanceUpperLimit": { "documentation": "Deprecated:
Determines the distance in studs at which the BillboardGui will stop scaling smaller in size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#DistanceUpperLimit", "code_sample": "" }, "@roblox/globaltype/BillboardGui.ExtentsOffset": { "documentation": "Determines how the BillboardGui is offset from its Adornee, relative to the Camera orientation, in units half the dimensions of the model's Camera-aligned bounding box.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#ExtentsOffset", "code_sample": "" }, "@roblox/globaltype/BillboardGui.ExtentsOffsetWorldSpace": { "documentation": "Determines how the BillboardGui is offset from its Adornee, relative to the global axes, in units half the dimensions of the model's axis-aligned bounding box.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#ExtentsOffsetWorldSpace", "code_sample": "" }, "@roblox/globaltype/BillboardGui.LightInfluence": { "documentation": "Controls how much the BillboardGui is influenced by environmental lighting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#LightInfluence", "code_sample": "" }, "@roblox/globaltype/BillboardGui.MaxDistance": { "documentation": "Controls how far away the BillboardGui can be displayed before it stops rendering.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#MaxDistance", "code_sample": "" }, "@roblox/globaltype/BillboardGui.PlayerToHideFrom": { "documentation": "Used by scripts to hide the BillboardGui from a specific player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#PlayerToHideFrom", "code_sample": "" }, "@roblox/globaltype/BillboardGui.Size": { "documentation": "Controls the size that the BillboardGui will have on screen.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#Size", "code_sample": "" }, "@roblox/globaltype/BillboardGui.SizeOffset": { "documentation": "A 2D offset in size-relative units that acts like an anchor point.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#SizeOffset", "code_sample": "" }, "@roblox/globaltype/BillboardGui.StudsOffset": { "documentation": "Determines how the BillboardGui is offset from its Adornee in studs, relative to the Camera orientation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#StudsOffset", "code_sample": "" }, "@roblox/globaltype/BillboardGui.StudsOffsetWorldSpace": { "documentation": "Determines how the BillboardGui is offset from its Adornee in studs, relative to the global axes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BillboardGui#StudsOffsetWorldSpace", "code_sample": "" }, "@roblox/globaltype/PlaneConstraint": { "documentation": "Moves its attachments into a position/orientation along a plane whose normal vector is the primary axis of Attachment0.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PlaneConstraint", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance": { "documentation": "An object that allows developers to override the appearance of a MeshPart with advanced graphics options.", "keys": { "AlphaMode": "@roblox/globaltype/SurfaceAppearance.AlphaMode", "Color": "@roblox/globaltype/SurfaceAppearance.Color", "ColorMap": "@roblox/globaltype/SurfaceAppearance.ColorMap", "ColorMapContent": "@roblox/globaltype/SurfaceAppearance.ColorMapContent", "EmissiveMaskContent": "@roblox/globaltype/SurfaceAppearance.EmissiveMaskContent", "EmissiveStrength": "@roblox/globaltype/SurfaceAppearance.EmissiveStrength", "EmissiveTint": "@roblox/globaltype/SurfaceAppearance.EmissiveTint", "MetalnessMap": "@roblox/globaltype/SurfaceAppearance.MetalnessMap", "MetalnessMapContent": "@roblox/globaltype/SurfaceAppearance.MetalnessMapContent", "NormalMap": "@roblox/globaltype/SurfaceAppearance.NormalMap", "NormalMapContent": "@roblox/globaltype/SurfaceAppearance.NormalMapContent", "RoughnessMap": "@roblox/globaltype/SurfaceAppearance.RoughnessMap", "RoughnessMapContent": "@roblox/globaltype/SurfaceAppearance.RoughnessMapContent", "TexturePack": "@roblox/globaltype/SurfaceAppearance.TexturePack" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.AlphaMode": { "documentation": "Determines how the alpha channel of the SurfaceAppearance.ColorMap is used.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#AlphaMode", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.Color": { "documentation": "Applies a tint to your existing colormap. Set directly with color picker or programmatically with Color3.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#Color", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.ColorMap": { "documentation": "Determines the color and opacity of the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#ColorMap", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.ColorMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#ColorMapContent", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.EmissiveMaskContent": { "documentation": "Determines the emissivity across the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#EmissiveMaskContent", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.EmissiveStrength": { "documentation": "Determines the strength of emissive contribution.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#EmissiveStrength", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.EmissiveTint": { "documentation": "Determines the tinting color for emissive contribution.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#EmissiveTint", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.MetalnessMap": { "documentation": "Determines which parts of the surface are metal or non-metal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#MetalnessMap", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.MetalnessMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#MetalnessMapContent", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.NormalMap": { "documentation": "Modifies the lighting of the surface by adding bumps, dents, cracks, and curves.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#NormalMap", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.NormalMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#NormalMapContent", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.RoughnessMap": { "documentation": "Determines the apparent roughness across the surface.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#RoughnessMap", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.RoughnessMapContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#RoughnessMapContent", "code_sample": "" }, "@roblox/globaltype/SurfaceAppearance.TexturePack": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#TexturePack", "code_sample": "" }, "@roblox/globaltype/DataModelSession": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModelSession", "code_sample": "" }, "@roblox/globaltype/BloomEffect": { "documentation": "Simulates the camera viewing a very bright light.", "keys": { "Intensity": "@roblox/globaltype/BloomEffect.Intensity", "Size": "@roblox/globaltype/BloomEffect.Size", "Threshold": "@roblox/globaltype/BloomEffect.Threshold" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BloomEffect", "code_sample": "" }, "@roblox/globaltype/BloomEffect.Intensity": { "documentation": "Determines the additive blending intensity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BloomEffect#Intensity", "code_sample": "" }, "@roblox/globaltype/BloomEffect.Size": { "documentation": "Determines the radius of the bloom in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BloomEffect#Size", "code_sample": "" }, "@roblox/globaltype/BloomEffect.Threshold": { "documentation": "Determines how bright a color must be before it blooms.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BloomEffect#Threshold", "code_sample": "" }, "@roblox/globaltype/Accoutrement": { "documentation": "An object that can attach to a player's character.", "keys": { "AttachmentForward": "@roblox/globaltype/Accoutrement.AttachmentForward", "AttachmentPoint": "@roblox/globaltype/Accoutrement.AttachmentPoint", "AttachmentPos": "@roblox/globaltype/Accoutrement.AttachmentPos", "AttachmentRight": "@roblox/globaltype/Accoutrement.AttachmentRight", "AttachmentUp": "@roblox/globaltype/Accoutrement.AttachmentUp" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accoutrement", "code_sample": "" }, "@roblox/globaltype/Accoutrement.AttachmentForward": { "documentation": "Sets the offset position of the object on the Player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accoutrement#AttachmentForward", "code_sample": "" }, "@roblox/globaltype/Accoutrement.AttachmentPoint": { "documentation": "The exact CFrame of the Accoutrement.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accoutrement#AttachmentPoint", "code_sample": "" }, "@roblox/globaltype/Accoutrement.AttachmentPos": { "documentation": "Sets the position of the object on the Player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accoutrement#AttachmentPos", "code_sample": "" }, "@roblox/globaltype/Accoutrement.AttachmentRight": { "documentation": "Sets the offset position of the object on the Player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accoutrement#AttachmentRight", "code_sample": "" }, "@roblox/globaltype/Accoutrement.AttachmentUp": { "documentation": "Sets the offset position of the object on the Player.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Accoutrement#AttachmentUp", "code_sample": "" }, "@roblox/globaltype/TextChatConfigurations": { "documentation": "The parental class of all text chat configurations.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatConfigurations", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService": { "documentation": "A service to support developer Avatar Editors.", "keys": { "CheckApplyDefaultClothingAsync": "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync", "CheckApplyDefaultClothing": "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing", "ConformToAvatarRulesAsync": "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync", "ConformToAvatarRules": "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules", "GetAccessoryType": "@roblox/globaltype/AvatarEditorService.GetAccessoryType", "GetAvatarRulesAsync": "@roblox/globaltype/AvatarEditorService.GetAvatarRulesAsync", "GetAvatarRules": "@roblox/globaltype/AvatarEditorService.GetAvatarRules", "GetBatchItemDetailsAsync": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync", "GetBatchItemDetails": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails", "GetFavoriteAsync": "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync", "GetFavorite": "@roblox/globaltype/AvatarEditorService.GetFavorite", "GetInventoryAsync": "@roblox/globaltype/AvatarEditorService.GetInventoryAsync", "GetInventory": "@roblox/globaltype/AvatarEditorService.GetInventory", "GetItemDetailsAsync": "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync", "GetItemDetails": "@roblox/globaltype/AvatarEditorService.GetItemDetails", "GetOutfitDetailsAsync": "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync", "GetOutfitDetails": "@roblox/globaltype/AvatarEditorService.GetOutfitDetails", "GetOutfitsAsync": "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync", "GetOutfits": "@roblox/globaltype/AvatarEditorService.GetOutfits", "GetRecommendedAssetsAsync": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync", "GetRecommendedAssets": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets", "GetRecommendedBundlesAsync": "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync", "GetRecommendedBundles": "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles", "PromptAllowInventoryReadAccess": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccess", "PromptCreateOutfit": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit", "PromptDeleteOutfit": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfit", "PromptRenameOutfit": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfit", "PromptSaveAvatar": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar", "PromptSetFavorite": "@roblox/globaltype/AvatarEditorService.PromptSetFavorite", "PromptUpdateOutfit": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit", "SearchCatalogAsync": "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync", "SearchCatalog": "@roblox/globaltype/AvatarEditorService.SearchCatalog" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync/param/1": { "documentation": "The HumanoidDescription to check if default clothing is required." }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync/return/0": { "documentation": "Returns a HumanoidDescription if default clothing was necessary. Otherwise returns nil." }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync": { "documentation": "Used to apply default clothing to the HumanoidDescription if necessary.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothingAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#CheckApplyDefaultClothingAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing/param/1": { "documentation": "The HumanoidDescription to check if default clothing is required." }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing/return/0": { "documentation": "Returns a HumanoidDescription if default clothing was necessary. Otherwise returns nil." }, "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing": { "documentation": "Deprecated:
Used to apply default clothing to the HumanoidDescription if necessary.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.CheckApplyDefaultClothing/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#CheckApplyDefaultClothing", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.ConformToAvatarRulesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRulesAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules": { "documentation": "Deprecated: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.ConformToAvatarRules/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRules", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetAccessoryType/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetAccessoryType/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetAccessoryType/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetAccessoryType": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetAccessoryType/param/0" }, { "name": "avatarAssetType", "documentation": "@roblox/globaltype/AvatarEditorService.GetAccessoryType/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetAccessoryType/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAccessoryType", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetAvatarRulesAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetAvatarRulesAsync/return/0": { "documentation": "A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above." }, "@roblox/globaltype/AvatarEditorService.GetAvatarRulesAsync": { "documentation": "Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetAvatarRulesAsync/param/0" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetAvatarRulesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRulesAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetAvatarRules/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetAvatarRules/return/0": { "documentation": "A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above." }, "@roblox/globaltype/AvatarEditorService.GetAvatarRules": { "documentation": "Deprecated:
Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetAvatarRules/param/0" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetAvatarRules/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRules", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/param/1": { "documentation": "The list of item ids to get details of." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/param/2": { "documentation": "The type of the item ids provided." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/return/0": { "documentation": "Returns an array of item details with the following fields: 
  {     "AssetType" = "string",     "CreatorName" = "string",     "CreatorTargetId" = 0,     "CreatorType" = "string",     "Description" = "string",     "FavoriteCount" = 0,     "Genres" = [       "All"     ],     "Id" = 0,     "ItemRestrictions" = [       "Limited"     ],     "ItemStatus": [       "New"     ],     "ItemType" = "string",     "LowestPrice" = 0,     "Name" = "string",     "Price" = 0,     "ProductId" = 0   }
." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync": { "documentation": "Gets the item details for a list of items at once.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/param/0" }, { "name": "itemIds", "documentation": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetBatchItemDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBatchItemDetailsAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/param/1": { "documentation": "The list of item ids to get details of." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/param/2": { "documentation": "The type of the item ids provided." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/return/0": { "documentation": "Returns an array of item details with the following fields: 
  {     "AssetType" = "string",     "CreatorName" = "string",     "CreatorTargetId" = 0,     "CreatorType" = "string",     "Description" = "string",     "FavoriteCount" = 0,     "Genres" = [       "All"     ],     "Id" = 0,     "ItemRestrictions" = [       "Limited"     ],     "ItemStatus": [       "New"     ],     "ItemType" = "string",     "LowestPrice" = 0,     "Name" = "string",     "Price" = 0,     "ProductId" = 0   }
." }, "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails": { "documentation": "Deprecated:
Gets the item details for a list of items at once.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/param/0" }, { "name": "itemIds", "documentation": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetBatchItemDetails/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBatchItemDetails", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/param/1": { "documentation": "The ID of the specified asset or bundle." }, "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/param/2": { "documentation": "The AvatarItemType of the specified asset or bundle." }, "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/return/0": { "documentation": "Whether the LocalPlayer has favorited the given bundle or asset." }, "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync": { "documentation": "Returns if the Players.LocalPlayer has favorited the given bundle or asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetFavoriteAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavoriteAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetFavorite/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetFavorite/param/1": { "documentation": "The ID of the specified asset or bundle." }, "@roblox/globaltype/AvatarEditorService.GetFavorite/param/2": { "documentation": "The AvatarItemType of the specified asset or bundle." }, "@roblox/globaltype/AvatarEditorService.GetFavorite/return/0": { "documentation": "Whether the LocalPlayer has favorited the given bundle or asset." }, "@roblox/globaltype/AvatarEditorService.GetFavorite": { "documentation": "Deprecated:
Returns if the Players.LocalPlayer has favorited the given bundle or asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetFavorite/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/AvatarEditorService.GetFavorite/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.GetFavorite/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetFavorite/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavorite", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetInventoryAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetInventoryAsync/param/1": { "documentation": "The AvatarAssetType that can will be checked for in the player's inventory." }, "@roblox/globaltype/AvatarEditorService.GetInventoryAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetInventoryAsync": { "documentation": "Returns an InventoryPages object with information about owned items in the users inventory with the given AvatarAssetTypes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetInventoryAsync/param/0" }, { "name": "assetTypes", "documentation": "@roblox/globaltype/AvatarEditorService.GetInventoryAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetInventoryAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventoryAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetInventory/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetInventory/param/1": { "documentation": "The AvatarAssetType that can will be checked for in the player's inventory." }, "@roblox/globaltype/AvatarEditorService.GetInventory/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetInventory": { "documentation": "Deprecated:
Returns an InventoryPages object with information about owned items in the users inventory with the given AvatarAssetTypes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetInventory/param/0" }, { "name": "assetTypes", "documentation": "@roblox/globaltype/AvatarEditorService.GetInventory/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetInventory/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventory", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/param/1": { "documentation": "The ID of the item whose details are being retrieved." }, "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/param/2": { "documentation": "An enum value indicating the type of item whose details are being retrieved." }, "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/return/0": { "documentation": "A table containing the item info for the retrieved item. See above for a sample table." }, "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync": { "documentation": "Returns the item details for the given item.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetItemDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetItemDetailsAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetItemDetails/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetItemDetails/param/1": { "documentation": "The ID of the item whose details are being retrieved." }, "@roblox/globaltype/AvatarEditorService.GetItemDetails/param/2": { "documentation": "An enum value indicating the type of item whose details are being retrieved." }, "@roblox/globaltype/AvatarEditorService.GetItemDetails/return/0": { "documentation": "A table containing the item info for the retrieved item. See above for a sample table." }, "@roblox/globaltype/AvatarEditorService.GetItemDetails": { "documentation": "Deprecated:
Returns the item details for the given item.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetItemDetails/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/AvatarEditorService.GetItemDetails/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.GetItemDetails/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetItemDetails/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetItemDetails", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync/param/1": { "documentation": "The ID of the outfit whose details are being retrieved." }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync/return/0": { "documentation": "A table containing the outfit info for the retrieved outfit. See above for a sample table." }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync": { "documentation": "Returns the outfit details for the given outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetOutfitDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitDetailsAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetails/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetails/param/1": { "documentation": "The ID of the outfit whose details are being retrieved." }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetails/return/0": { "documentation": "A table containing the outfit info for the retrieved outfit. See above for a sample table." }, "@roblox/globaltype/AvatarEditorService.GetOutfitDetails": { "documentation": "Deprecated:
Returns the outfit details for the given outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitDetails/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitDetails/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetOutfitDetails/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitDetails", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/param/2": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync": { "documentation": "Returns outfit data for the Players.LocalPlayer.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/param/0" }, { "name": "outfitSource", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/param/1" }, { "name": "outfitType", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetOutfitsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitsAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfits/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetOutfits/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfits/param/2": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfits/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.GetOutfits": { "documentation": "Deprecated:
Returns outfit data for the Players.LocalPlayer.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfits/param/0" }, { "name": "outfitSource", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfits/param/1" }, { "name": "outfitType", "documentation": "@roblox/globaltype/AvatarEditorService.GetOutfits/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetOutfits/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfits", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/param/1": { "documentation": "The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given contextAssetId." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/param/2": { "documentation": "The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/return/0": { "documentation": "A list of recommendations based on the given AssetType." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync": { "documentation": "Returns a list of recommended assets based on a given AssetType and asset ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/param/0" }, { "name": "assetType", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/param/1" }, { "name": "contextAssetId", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetRecommendedAssetsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssetsAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/param/1": { "documentation": "The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given contextAssetId." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/param/2": { "documentation": "The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/return/0": { "documentation": "A list of recommendations based on the given AssetType." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets": { "documentation": "Deprecated:
Returns a list of recommended assets based on a given AssetType and asset ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/param/0" }, { "name": "assetType", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/param/1" }, { "name": "contextAssetId", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/param/2" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetRecommendedAssets/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssets", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync/param/1": { "documentation": "A list of recommended bundles." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync/return/0": { "documentation": "The bundle ID that the recommended bundles will be returned for." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync": { "documentation": "Returns a list of recommended bundles for a given bundle id.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync/param/0" }, { "name": "bundleId", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetRecommendedBundlesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedBundlesAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles/param/1": { "documentation": "A list of recommended bundles." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles/return/0": { "documentation": "The bundle ID that the recommended bundles will be returned for." }, "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles": { "documentation": "Deprecated:
Returns a list of recommended bundles for a given bundle id.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles/param/0" }, { "name": "bundleId", "documentation": "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.GetRecommendedBundles/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedBundles", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccess/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccess": { "documentation": "Prompts the Players.LocalPlayer to allow the developer to read what items the user has in their inventory and other avatar editor related information.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccess/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptAllowInventoryReadAccess", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit/param/1": { "documentation": "The Outfit that the player will be prompted to created." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit/param/2": { "documentation": "The RigType that the outfit will be created for if the player confirms the prompt." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit": { "documentation": "Prompts the Players.LocalPlayer to save the given HumanoidDescription as an outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit/param/0" }, { "name": "outfit", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit/param/1" }, { "name": "rigType", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfit/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptCreateOutfit", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfit/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfit/param/1": { "documentation": "The outfitId of the outfit to delete." }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfit": { "documentation": "Prompts the Players.LocalPlayer to delete the given outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfit/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfit/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptDeleteOutfit", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfit/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfit/param/1": { "documentation": "The outfitId of the outfit to rename." }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfit": { "documentation": "Prompts the Players.LocalPlayer to rename the given outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfit/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfit/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptRenameOutfit", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar/param/1": { "documentation": "The given HumanoidDescription being prompted to save." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar/param/2": { "documentation": "The RigType that the avatar will be saved for if the player confirms the prompt." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar": { "documentation": "Prompts the Players.LocalPlayer to update their avatar based on the given HumanoidDescription and RigType of R6 or R15.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar/param/0" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar/param/1" }, { "name": "rigType", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatar/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptSaveAvatar", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/1": { "documentation": "The ItemId of the item being prompted to favorite." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/2": { "documentation": "The type of item being prompted to favorite." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/3": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSetFavorite": { "documentation": "Prompts the Players.LocalPlayer to favorite or unfavorite the given asset or bundle.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/0" }, { "name": "itemId", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/1" }, { "name": "itemType", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/2" }, { "name": "shouldFavorite", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavorite/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptSetFavorite", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/1": { "documentation": "The outfitId of the outfit to update." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/2": { "documentation": "A HumanoidDescription that represents the new outfit data." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/3": { "documentation": "The HumanoidRigType to update the outfit to." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit": { "documentation": "Prompts the Players.LocalPlayer to update the given outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/1" }, { "name": "updatedOutfit", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/2" }, { "name": "rigType", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfit/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptUpdateOutfit", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync/param/1": { "documentation": "An object containing the parameters used for the search." }, "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync": { "documentation": "Returns a CatalogPages object containing the result of the given search.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync/param/0" }, { "name": "searchParameters", "documentation": "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.SearchCatalogAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalogAsync", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.SearchCatalog/param/0": { "documentation": "A service to support developer Avatar Editors." }, "@roblox/globaltype/AvatarEditorService.SearchCatalog/param/1": { "documentation": "An object containing the parameters used for the search." }, "@roblox/globaltype/AvatarEditorService.SearchCatalog/return/0": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.SearchCatalog": { "documentation": "Deprecated:
Returns a CatalogPages object containing the result of the given search.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.SearchCatalog/param/0" }, { "name": "searchParameters", "documentation": "@roblox/globaltype/AvatarEditorService.SearchCatalog/param/1" } ], "returns": [ "@roblox/globaltype/AvatarEditorService.SearchCatalog/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalog", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted": { "documentation": "Fires when the AvatarEditorService:PromptAllowInventoryReadAccess() prompt is responded to by the user.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptAllowInventoryReadAccessCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptAllowInventoryReadAccessCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted": { "documentation": "Fires when the PromptSaveOutfit operation is completed.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptCreateOutfitCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptCreateOutfitCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted": { "documentation": "Fires when the PromptDeleteOutfit operation is completed.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptDeleteOutfitCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptDeleteOutfitCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted": { "documentation": "Fires when the PromptRenameOutfit operation is completed.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptRenameOutfitCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptRenameOutfitCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted": { "documentation": "Fires when the AvatarEditorService:PromptSaveAvatar() operation is completed.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptSaveAvatarCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptSaveAvatarCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted": { "documentation": "Fires when the AvatarEditorService:PromptSetFavorite() operation is completed.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptSetFavoriteCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptSetFavoriteCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted": { "documentation": "Fires when the AvatarEditorService:PromptUpdateOutfit() operation is completed.", "keys": { "Connect": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Once", "Wait": "@roblox/globaltype/AvatarEditorService.PromptUpdateOutfitCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptUpdateOutfitCompleted", "code_sample": "" }, "@roblox/globaltype/FlagStandService": { "documentation": "An internal service responsible for handling the now deprecated FlagStand and Flag objects.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlagStandService", "code_sample": "" }, "@roblox/globaltype/BlurEffect": { "documentation": "Applies a blur to the entire game world.", "keys": { "Size": "@roblox/globaltype/BlurEffect.Size" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BlurEffect", "code_sample": "" }, "@roblox/globaltype/BlurEffect.Size": { "documentation": "Determines the blur radius.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BlurEffect#Size", "code_sample": "" }, "@roblox/globaltype/FunctionalTest": { "documentation": "Deprecated: FunctionalTest has been deprecated, developers are advised to use TestService instead.", "keys": { "Description": "@roblox/globaltype/FunctionalTest.Description", "Error": "@roblox/globaltype/FunctionalTest.Error", "Failed": "@roblox/globaltype/FunctionalTest.Failed", "Pass": "@roblox/globaltype/FunctionalTest.Pass", "Passed": "@roblox/globaltype/FunctionalTest.Passed", "Warn": "@roblox/globaltype/FunctionalTest.Warn" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest", "code_sample": "" }, "@roblox/globaltype/FunctionalTest.Description": { "documentation": "The description of the FunctionalTest.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest#Description", "code_sample": "" }, "@roblox/globaltype/FunctionalTest.Error/param/0": { "documentation": "Deprecated: FunctionalTest has been deprecated, developers are advised to use TestService instead." }, "@roblox/globaltype/FunctionalTest.Error/param/1": { "documentation": "" }, "@roblox/globaltype/FunctionalTest.Error": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FunctionalTest.Error/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/FunctionalTest.Error/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest#Error", "code_sample": "" }, "@roblox/globaltype/FunctionalTest.Failed/param/0": { "documentation": "Deprecated: FunctionalTest has been deprecated, developers are advised to use TestService instead." }, "@roblox/globaltype/FunctionalTest.Failed/param/1": { "documentation": "" }, "@roblox/globaltype/FunctionalTest.Failed": { "documentation": "Prints a red message to the output, prefixed by \"TestService: \".", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FunctionalTest.Failed/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/FunctionalTest.Failed/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest#Failed", "code_sample": "" }, "@roblox/globaltype/FunctionalTest.Pass/param/0": { "documentation": "Deprecated: FunctionalTest has been deprecated, developers are advised to use TestService instead." }, "@roblox/globaltype/FunctionalTest.Pass/param/1": { "documentation": "" }, "@roblox/globaltype/FunctionalTest.Pass": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FunctionalTest.Pass/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/FunctionalTest.Pass/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest#Pass", "code_sample": "" }, "@roblox/globaltype/FunctionalTest.Passed/param/0": { "documentation": "Deprecated: FunctionalTest has been deprecated, developers are advised to use TestService instead." }, "@roblox/globaltype/FunctionalTest.Passed/param/1": { "documentation": "" }, "@roblox/globaltype/FunctionalTest.Passed": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FunctionalTest.Passed/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/FunctionalTest.Passed/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest#Passed", "code_sample": "" }, "@roblox/globaltype/FunctionalTest.Warn/param/0": { "documentation": "Deprecated: FunctionalTest has been deprecated, developers are advised to use TestService instead." }, "@roblox/globaltype/FunctionalTest.Warn/param/1": { "documentation": "" }, "@roblox/globaltype/FunctionalTest.Warn": { "documentation": "Prints if a condition is true, otherwise prints a warning.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FunctionalTest.Warn/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/FunctionalTest.Warn/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FunctionalTest#Warn", "code_sample": "local TestService = game:GetService(\"TestService\")\n\nTestService:Warn(false, \"this action is invalid\")" }, "@roblox/globaltype/UITableLayout": { "documentation": "Lays out sibling UI elements and their child UI elements as rows/columns and cells in a table.", "keys": { "FillEmptySpaceColumns": "@roblox/globaltype/UITableLayout.FillEmptySpaceColumns", "FillEmptySpaceRows": "@roblox/globaltype/UITableLayout.FillEmptySpaceRows", "MajorAxis": "@roblox/globaltype/UITableLayout.MajorAxis", "Padding": "@roblox/globaltype/UITableLayout.Padding" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITableLayout", "code_sample": "" }, "@roblox/globaltype/UITableLayout.FillEmptySpaceColumns": { "documentation": "Determines whether cells are sized such that they occupy the horizontal space of the parent UI element.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITableLayout#FillEmptySpaceColumns", "code_sample": "" }, "@roblox/globaltype/UITableLayout.FillEmptySpaceRows": { "documentation": "Determines whether cells are sized such that they occupy the vertical space of the parent UI element.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITableLayout#FillEmptySpaceRows", "code_sample": "" }, "@roblox/globaltype/UITableLayout.MajorAxis": { "documentation": "Determines whether sibling UI elements are treated as rows or columns.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITableLayout#MajorAxis", "code_sample": "" }, "@roblox/globaltype/UITableLayout.Padding": { "documentation": "Determines the empty space between cells.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITableLayout#Padding", "code_sample": "" }, "@roblox/globaltype/NetworkMarker": { "documentation": "The NetworkMarker is used to tell the client when the server has finished loading the world for the client.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkMarker", "code_sample": "" }, "@roblox/globaltype/NetworkMarker.Received.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkMarker.Received.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkMarker.Received.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkMarker.Received.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkMarker.Received.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkMarker.Received.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkMarker.Received.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkMarker.Received.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkMarker.Received.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkMarker.Received.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkMarker.Received.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkMarker.Received.Once/param/1": { "documentation": "" }, "@roblox/globaltype/NetworkMarker.Received.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkMarker.Received.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/NetworkMarker.Received.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/NetworkMarker.Received.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/NetworkMarker.Received.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/NetworkMarker.Received.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/NetworkMarker.Received": { "documentation": "Fired when the server has finished replicating the world to the client.", "keys": { "Connect": "@roblox/globaltype/NetworkMarker.Received.Connect", "ConnectParallel": "@roblox/globaltype/NetworkMarker.Received.ConnectParallel", "Once": "@roblox/globaltype/NetworkMarker.Received.Once", "Wait": "@roblox/globaltype/NetworkMarker.Received.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/NetworkMarker#Received", "code_sample": "" }, "@roblox/globaltype/TweenService": { "documentation": "Used to create Tweens which interpolate, or tween, the properties of instances.", "keys": { "Create": "@roblox/globaltype/TweenService.Create", "GetValue": "@roblox/globaltype/TweenService.GetValue", "SmoothDamp": "@roblox/globaltype/TweenService.SmoothDamp" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenService", "code_sample": "local TweenService = game:GetService(\"TweenService\")\n\nlocal part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 10, 0)\npart.Color = Color3.new(1, 0, 0)\npart.Anchored = true\npart.Parent = game.Workspace\n\nlocal goal = {}\ngoal.Position = Vector3.new(10, 10, 0)\ngoal.Color = Color3.new(0, 1, 0)\n\nlocal tweenInfo = TweenInfo.new(5)\n\nlocal tween = TweenService:Create(part, tweenInfo, goal)\n\ntween:Play()" }, "@roblox/globaltype/TweenService.Create/param/0": { "documentation": "Used to create Tweens which interpolate, or tween, the properties of instances." }, "@roblox/globaltype/TweenService.Create/param/1": { "documentation": "The Instance whose properties are to be tweened." }, "@roblox/globaltype/TweenService.Create/param/2": { "documentation": "The TweenInfo to be used." }, "@roblox/globaltype/TweenService.Create/param/3": { "documentation": "A dictionary of properties, and their target values, to be tweened." }, "@roblox/globaltype/TweenService.Create/return/0": { "documentation": "" }, "@roblox/globaltype/TweenService.Create": { "documentation": "Creates a new Tween given the object whose properties are to be tweened, a TweenInfo, and a dictionary of goal property values.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenService.Create/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/TweenService.Create/param/1" }, { "name": "tweenInfo", "documentation": "@roblox/globaltype/TweenService.Create/param/2" }, { "name": "propertyTable", "documentation": "@roblox/globaltype/TweenService.Create/param/3" } ], "returns": [ "@roblox/globaltype/TweenService.Create/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenService#Create", "code_sample": "local TweenService = game:GetService(\"TweenService\")\n\nlocal part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 10, 0)\npart.Color = Color3.new(1, 0, 0)\npart.Anchored = true\npart.Parent = game.Workspace\n\nlocal goal = {}\ngoal.Position = Vector3.new(10, 10, 0)\ngoal.Color = Color3.new(0, 1, 0)\n\nlocal tweenInfo = TweenInfo.new(5)\n\nlocal tween = TweenService:Create(part, tweenInfo, goal)\n\ntween:Play()" }, "@roblox/globaltype/TweenService.GetValue/param/0": { "documentation": "Used to create Tweens which interpolate, or tween, the properties of instances." }, "@roblox/globaltype/TweenService.GetValue/param/1": { "documentation": "An interpolation value between 0 and 1." }, "@roblox/globaltype/TweenService.GetValue/param/2": { "documentation": "The easing style to use." }, "@roblox/globaltype/TweenService.GetValue/param/3": { "documentation": "The easing direction to use." }, "@roblox/globaltype/TweenService.GetValue/return/0": { "documentation": "A new alpha value generated from the given easing style and direction." }, "@roblox/globaltype/TweenService.GetValue": { "documentation": "Calculates a new alpha given an EasingStyle and EasingDirection.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenService.GetValue/param/0" }, { "name": "alpha", "documentation": "@roblox/globaltype/TweenService.GetValue/param/1" }, { "name": "easingStyle", "documentation": "@roblox/globaltype/TweenService.GetValue/param/2" }, { "name": "easingDirection", "documentation": "@roblox/globaltype/TweenService.GetValue/param/3" } ], "returns": [ "@roblox/globaltype/TweenService.GetValue/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenService#GetValue", "code_sample": "" }, "@roblox/globaltype/TweenService.SmoothDamp/param/0": { "documentation": "Used to create Tweens which interpolate, or tween, the properties of instances." }, "@roblox/globaltype/TweenService.SmoothDamp/param/1": { "documentation": "The current value to smooth." }, "@roblox/globaltype/TweenService.SmoothDamp/param/2": { "documentation": "The target value to reach." }, "@roblox/globaltype/TweenService.SmoothDamp/param/3": { "documentation": "The current velocity with which the current value should approach the target value. You shouldn't modify this value between calls yourself, it's used to store the stateful velocity. In most cases, initialize this with 0, zero, zero, or identity depending on the type, or if needed, with your initial velocity." }, "@roblox/globaltype/TweenService.SmoothDamp/param/4": { "documentation": "The duration over which the total smoothing operation should take place. Note that since this is a damped spring, there's no guarantee current will be exactly target after this time, but it will be close. Smaller values result in quicker smoothing." }, "@roblox/globaltype/TweenService.SmoothDamp/param/5": { "documentation": "The maximum speed at which the current value should approach the target value. Leaving this nil defaults to huge, meaning the velocity isn't clamped." }, "@roblox/globaltype/TweenService.SmoothDamp/param/6": { "documentation": "The rate at which the smoothing operation should be applied. If left nil, the current engine delta time will be used." }, "@roblox/globaltype/TweenService.SmoothDamp/return/0": { "documentation": "The new value and new velocity calculated from the smoothing operation." }, "@roblox/globaltype/TweenService.SmoothDamp": { "documentation": "Smoothly interpolates a value towards a target, simulating a critically damped spring.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/0" }, { "name": "current", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/1" }, { "name": "target", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/2" }, { "name": "velocity", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/3" }, { "name": "smoothTime", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/4" }, { "name": "maxSpeed", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/5" }, { "name": "dt", "documentation": "@roblox/globaltype/TweenService.SmoothDamp/param/6" } ], "returns": [ "@roblox/globaltype/TweenService.SmoothDamp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TweenService#SmoothDamp", "code_sample": "" }, "@roblox/globaltype/ContextActionService": { "documentation": "A service used to bind user input to contextual actions.", "keys": { "BindAction": "@roblox/globaltype/ContextActionService.BindAction", "BindActionAtPriority": "@roblox/globaltype/ContextActionService.BindActionAtPriority", "BindActionToInputTypes": "@roblox/globaltype/ContextActionService.BindActionToInputTypes", "BindActivate": "@roblox/globaltype/ContextActionService.BindActivate", "GetAllBoundActionInfo": "@roblox/globaltype/ContextActionService.GetAllBoundActionInfo", "GetBoundActionInfo": "@roblox/globaltype/ContextActionService.GetBoundActionInfo", "GetButton": "@roblox/globaltype/ContextActionService.GetButton", "GetCurrentLocalToolIcon": "@roblox/globaltype/ContextActionService.GetCurrentLocalToolIcon", "SetDescription": "@roblox/globaltype/ContextActionService.SetDescription", "SetImage": "@roblox/globaltype/ContextActionService.SetImage", "SetPosition": "@roblox/globaltype/ContextActionService.SetPosition", "SetTitle": "@roblox/globaltype/ContextActionService.SetTitle", "UnbindAction": "@roblox/globaltype/ContextActionService.UnbindAction", "UnbindActivate": "@roblox/globaltype/ContextActionService.UnbindActivate", "UnbindAllActions": "@roblox/globaltype/ContextActionService.UnbindAllActions" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService", "code_sample": "" }, "@roblox/globaltype/ContextActionService.BindAction/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.BindAction/param/1": { "documentation": "A string representing the action being performed (e.g. \"HonkHorn\" or \"OpenDoor\")." }, "@roblox/globaltype/ContextActionService.BindAction/param/2": { "documentation": "The action-handling function, called with the following parameters when the bound inputs are triggered: string (actionName), UserInputState and an InputObject." }, "@roblox/globaltype/ContextActionService.BindAction/param/3": { "documentation": "Whether a GUI button should be created for the action on touch input devices." }, "@roblox/globaltype/ContextActionService.BindAction/param/4": { "documentation": "Any number of KeyCode or UserInputType representing the inputs to bind to the action." }, "@roblox/globaltype/ContextActionService.BindAction": { "documentation": "Bind user input to an action given an action handling function.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.BindAction/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.BindAction/param/1" }, { "name": "functionToBind", "documentation": "@roblox/globaltype/ContextActionService.BindAction/param/2" }, { "name": "createTouchButton", "documentation": "@roblox/globaltype/ContextActionService.BindAction/param/3" }, { "name": "inputTypes", "documentation": "@roblox/globaltype/ContextActionService.BindAction/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#BindAction", "code_sample": "" }, "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/1": { "documentation": "A string representing the action being performed (e.g. \"HonkHorn\" or \"OpenDoor\")." }, "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/2": { "documentation": "The action-handling function, called with the following parameters when the bound inputs are triggered: string (actionName), UserInputState and an InputObject." }, "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/3": { "documentation": "Whether a GUI button should be created for the action on touch input devices." }, "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/4": { "documentation": "The priority level at which the action should be bound (higher considered before lower)." }, "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/5": { "documentation": "Any number of Enum.KeyCode or Enum.UserInputType representing the inputs to bind to the action." }, "@roblox/globaltype/ContextActionService.BindActionAtPriority": { "documentation": "Behaves like BindAction but also allows a priority to be assigned to the bound action for overlapping input types (higher before lower).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/1" }, { "name": "functionToBind", "documentation": "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/2" }, { "name": "createTouchButton", "documentation": "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/3" }, { "name": "priorityLevel", "documentation": "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/4" }, { "name": "inputTypes", "documentation": "@roblox/globaltype/ContextActionService.BindActionAtPriority/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#BindActionAtPriority", "code_sample": "" }, "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/2": { "documentation": "" }, "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/3": { "documentation": "" }, "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/4": { "documentation": "" }, "@roblox/globaltype/ContextActionService.BindActionToInputTypes": { "documentation": "Deprecated: This item has been superseded by ContextActionService:BindAction() which should be used in all new work.
Binds functionToBind to input events such as key presses, mouse movement, or controller input.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/1" }, { "name": "functionToBind", "documentation": "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/2" }, { "name": "createTouchButton", "documentation": "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/3" }, { "name": "inputTypes", "documentation": "@roblox/globaltype/ContextActionService.BindActionToInputTypes/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#BindActionToInputTypes", "code_sample": "" }, "@roblox/globaltype/ContextActionService.BindActivate/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.BindActivate/param/1": { "documentation": "Must be Keyboard or Gamepad1 through Gamepad8." }, "@roblox/globaltype/ContextActionService.BindActivate/param/2": { "documentation": "" }, "@roblox/globaltype/ContextActionService.BindActivate": { "documentation": "Bind a KeyCode with a specific UserInputType to trigger Tool.Activation and ClickDetector events.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.BindActivate/param/0" }, { "name": "userInputTypeForActivation", "documentation": "@roblox/globaltype/ContextActionService.BindActivate/param/1" }, { "name": "keyCodesForActivation", "documentation": "@roblox/globaltype/ContextActionService.BindActivate/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#BindActivate", "code_sample": "" }, "@roblox/globaltype/ContextActionService.GetAllBoundActionInfo/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.GetAllBoundActionInfo/return/0": { "documentation": "" }, "@roblox/globaltype/ContextActionService.GetAllBoundActionInfo": { "documentation": "Get a table of information about all bound actions (key is the name passed to BindAction, value is a table from GetBoundActionInfo when called with the key).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.GetAllBoundActionInfo/param/0" } ], "returns": [ "@roblox/globaltype/ContextActionService.GetAllBoundActionInfo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#GetAllBoundActionInfo", "code_sample": "" }, "@roblox/globaltype/ContextActionService.GetBoundActionInfo/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.GetBoundActionInfo/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.GetBoundActionInfo/return/0": { "documentation": "" }, "@roblox/globaltype/ContextActionService.GetBoundActionInfo": { "documentation": "Get a table of information about a bound action given its name originally passed to BindAction.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.GetBoundActionInfo/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.GetBoundActionInfo/param/1" } ], "returns": [ "@roblox/globaltype/ContextActionService.GetBoundActionInfo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#GetBoundActionInfo", "code_sample": "" }, "@roblox/globaltype/ContextActionService.GetButton/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.GetButton/param/1": { "documentation": "The name of the action originally passed to BindAction." }, "@roblox/globaltype/ContextActionService.GetButton/return/0": { "documentation": "An ImageButton created by BindAction." }, "@roblox/globaltype/ContextActionService.GetButton": { "documentation": "Retrieves a ImageButton of a bound action that had a touch input button created.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.GetButton/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.GetButton/param/1" } ], "returns": [ "@roblox/globaltype/ContextActionService.GetButton/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#GetButton", "code_sample": "" }, "@roblox/globaltype/ContextActionService.GetCurrentLocalToolIcon/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.GetCurrentLocalToolIcon/return/0": { "documentation": "A content string from the Tool's TextureId, or nil if one could not be found." }, "@roblox/globaltype/ContextActionService.GetCurrentLocalToolIcon": { "documentation": "Return the BackpackItem.TextureId of a Tool currently equipped by the Player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.GetCurrentLocalToolIcon/param/0" } ], "returns": [ "@roblox/globaltype/ContextActionService.GetCurrentLocalToolIcon/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#GetCurrentLocalToolIcon", "code_sample": "" }, "@roblox/globaltype/ContextActionService.SetDescription/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.SetDescription/param/1": { "documentation": "The name of the action originally passed to BindAction." }, "@roblox/globaltype/ContextActionService.SetDescription/param/2": { "documentation": "A text description of the action, such as \"Honk the car's horn\" or \"Open the inventory\"." }, "@roblox/globaltype/ContextActionService.SetDescription": { "documentation": "Given the name of a bound action with a touch button, sets the description of the action.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.SetDescription/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.SetDescription/param/1" }, { "name": "description", "documentation": "@roblox/globaltype/ContextActionService.SetDescription/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#SetDescription", "code_sample": "" }, "@roblox/globaltype/ContextActionService.SetImage/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.SetImage/param/1": { "documentation": "The name of the action originally passed to BindAction." }, "@roblox/globaltype/ContextActionService.SetImage/param/2": { "documentation": "The value to which the Image property should be set." }, "@roblox/globaltype/ContextActionService.SetImage": { "documentation": "If actionName key contains a bound action, then image is set as the image of the touch button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.SetImage/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.SetImage/param/1" }, { "name": "image", "documentation": "@roblox/globaltype/ContextActionService.SetImage/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#SetImage", "code_sample": "" }, "@roblox/globaltype/ContextActionService.SetPosition/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.SetPosition/param/1": { "documentation": "The name of the action originally passed to BindAction." }, "@roblox/globaltype/ContextActionService.SetPosition/param/2": { "documentation": "The position within the ContextButtonFrame." }, "@roblox/globaltype/ContextActionService.SetPosition": { "documentation": "Given the name of a bound action with a touch button, sets the position of the button within the ContextButtonFrame.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.SetPosition/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.SetPosition/param/1" }, { "name": "position", "documentation": "@roblox/globaltype/ContextActionService.SetPosition/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#SetPosition", "code_sample": "" }, "@roblox/globaltype/ContextActionService.SetTitle/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.SetTitle/param/1": { "documentation": "The name of the action originally passed to BindAction." }, "@roblox/globaltype/ContextActionService.SetTitle/param/2": { "documentation": "The text to display on the button." }, "@roblox/globaltype/ContextActionService.SetTitle": { "documentation": "Given the name of a bound action with a touch button, sets the text shown on the button.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.SetTitle/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.SetTitle/param/1" }, { "name": "title", "documentation": "@roblox/globaltype/ContextActionService.SetTitle/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#SetTitle", "code_sample": "" }, "@roblox/globaltype/ContextActionService.UnbindAction/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.UnbindAction/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.UnbindAction": { "documentation": "Unbind an action from input given its name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.UnbindAction/param/0" }, { "name": "actionName", "documentation": "@roblox/globaltype/ContextActionService.UnbindAction/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#UnbindAction", "code_sample": "" }, "@roblox/globaltype/ContextActionService.UnbindActivate/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.UnbindActivate/param/1": { "documentation": "The same UserInputType originally sent to BindActivate." }, "@roblox/globaltype/ContextActionService.UnbindActivate/param/2": { "documentation": "The same KeyCode originally sent to BindActivate." }, "@roblox/globaltype/ContextActionService.UnbindActivate": { "documentation": "Unbind a KeyCode with a specific UserInputType from triggering Tool.Activation when bound with ContextActionService:BindActivate().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.UnbindActivate/param/0" }, { "name": "userInputTypeForActivation", "documentation": "@roblox/globaltype/ContextActionService.UnbindActivate/param/1" }, { "name": "keyCodeForActivation", "documentation": "@roblox/globaltype/ContextActionService.UnbindActivate/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#UnbindActivate", "code_sample": "" }, "@roblox/globaltype/ContextActionService.UnbindAllActions/param/0": { "documentation": "A service used to bind user input to contextual actions." }, "@roblox/globaltype/ContextActionService.UnbindAllActions": { "documentation": "Removes all functions bound. No actionNames will remain. All touch buttons will be removed.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.UnbindAllActions/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#UnbindAllActions", "code_sample": "" }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolEquipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolEquipped": { "documentation": "Fires when the current player equips a Tool.", "keys": { "Connect": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Connect", "ConnectParallel": "@roblox/globaltype/ContextActionService.LocalToolEquipped.ConnectParallel", "Once": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Once", "Wait": "@roblox/globaltype/ContextActionService.LocalToolEquipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#LocalToolEquipped", "code_sample": "" }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/ContextActionService.LocalToolUnequipped": { "documentation": "Fires when the current player unequips a Tool.", "keys": { "Connect": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Connect", "ConnectParallel": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.ConnectParallel", "Once": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Once", "Wait": "@roblox/globaltype/ContextActionService.LocalToolUnequipped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ContextActionService#LocalToolUnequipped", "code_sample": "" }, "@roblox/globaltype/AudioTremolo": { "documentation": "Creates a trembling effect on a sound by varying the volume of the sound up and down.", "keys": { "Bypass": "@roblox/globaltype/AudioTremolo.Bypass", "Depth": "@roblox/globaltype/AudioTremolo.Depth", "Duty": "@roblox/globaltype/AudioTremolo.Duty", "Frequency": "@roblox/globaltype/AudioTremolo.Frequency", "Shape": "@roblox/globaltype/AudioTremolo.Shape", "Skew": "@roblox/globaltype/AudioTremolo.Skew", "Square": "@roblox/globaltype/AudioTremolo.Square", "GetConnectedWires": "@roblox/globaltype/AudioTremolo.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioTremolo.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioTremolo.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Bypass": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Depth": { "documentation": "Controls how much the volume will raise and lower.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Depth", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Duty": { "documentation": "Controls how long the effect will be active during one volume oscillation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Duty", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Frequency": { "documentation": "Sets how often the effect will oscillate the volume.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Frequency", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Shape": { "documentation": "Controls the shape of the low frequency oscillations.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Shape", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Skew": { "documentation": "Time-skews the low frequency oscillations cycle.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Skew", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.Square": { "documentation": "Flatness of the low frequency oscillations shape.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#Square", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.GetConnectedWires/param/0": { "documentation": "Creates a trembling effect on a sound by varying the volume of the sound up and down." }, "@roblox/globaltype/AudioTremolo.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.GetConnectedWires": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioTremolo.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioTremolo.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.GetInputPins/param/0": { "documentation": "Creates a trembling effect on a sound by varying the volume of the sound up and down." }, "@roblox/globaltype/AudioTremolo.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioTremolo.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.GetOutputPins/param/0": { "documentation": "Creates a trembling effect on a sound by varying the volume of the sound up and down." }, "@roblox/globaltype/AudioTremolo.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioTremolo.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioTremolo.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTremolo.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTremolo.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTremolo.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTremolo.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTremolo.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioTremolo.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioTremolo.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioTremolo.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioTremolo.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioTremolo.WiringChanged": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/AudioTremolo.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioTremolo.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioTremolo.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioTremolo.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#WiringChanged", "code_sample": "" }, "@roblox/globaltype/ControllerPartSensor": { "documentation": "A SensorBase that outputs data about another BasePart based on Humanoid floor and ladder detection logic.", "keys": { "HitFrame": "@roblox/globaltype/ControllerPartSensor.HitFrame", "HitNormal": "@roblox/globaltype/ControllerPartSensor.HitNormal", "SearchDistance": "@roblox/globaltype/ControllerPartSensor.SearchDistance", "SensedPart": "@roblox/globaltype/ControllerPartSensor.SensedPart", "SensorMode": "@roblox/globaltype/ControllerPartSensor.SensorMode" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor", "code_sample": "" }, "@roblox/globaltype/ControllerPartSensor.HitFrame": { "documentation": "The position in world space where the sensor hit the ControllerPartSensor.SensedPart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#HitFrame", "code_sample": "" }, "@roblox/globaltype/ControllerPartSensor.HitNormal": { "documentation": "The surface normal at the position where the sensor hit the ControllerPartSensor.SensedPart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#HitNormal", "code_sample": "" }, "@roblox/globaltype/ControllerPartSensor.SearchDistance": { "documentation": "The distance from the sensor's parent BasePart to use when sensing other parts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#SearchDistance", "code_sample": "" }, "@roblox/globaltype/ControllerPartSensor.SensedPart": { "documentation": "A reference to the BasePart hit by the sensor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#SensedPart", "code_sample": "" }, "@roblox/globaltype/ControllerPartSensor.SensorMode": { "documentation": "Determines what behavior this SensorBase uses when sensing other parts.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerPartSensor#SensorMode", "code_sample": "" }, "@roblox/globaltype/ManualSurfaceJointInstance": { "documentation": "Deprecated:
ManualSurfaceJointInstance is the base class for ManualGlue and ManualWeld.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ManualSurfaceJointInstance", "code_sample": "" }, "@roblox/globaltype/InputAction": { "documentation": "Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using InputBinding.", "keys": { "BoolState": "@roblox/globaltype/InputAction.BoolState", "Direction1DState": "@roblox/globaltype/InputAction.Direction1DState", "Direction2DState": "@roblox/globaltype/InputAction.Direction2DState", "Direction3DState": "@roblox/globaltype/InputAction.Direction3DState", "Enabled": "@roblox/globaltype/InputAction.Enabled", "Type": "@roblox/globaltype/InputAction.Type", "Fire": "@roblox/globaltype/InputAction.Fire", "GetState": "@roblox/globaltype/InputAction.GetState" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction", "code_sample": "" }, "@roblox/globaltype/InputAction.BoolState": { "documentation": "Non-scriptable read-only property useful for debugging Bool input actions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#BoolState", "code_sample": "" }, "@roblox/globaltype/InputAction.Direction1DState": { "documentation": "Non-scriptable read-only property useful for debugging Direction1D input actions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Direction1DState", "code_sample": "" }, "@roblox/globaltype/InputAction.Direction2DState": { "documentation": "Non-scriptable read-only property useful for debugging Direction2D input actions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Direction2DState", "code_sample": "" }, "@roblox/globaltype/InputAction.Direction3DState": { "documentation": "Non-scriptable read-only property useful for debugging Direction3D input actions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Direction3DState", "code_sample": "" }, "@roblox/globaltype/InputAction.Enabled": { "documentation": "Determines if the InputAction is enabled or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Enabled", "code_sample": "" }, "@roblox/globaltype/InputAction.Type": { "documentation": "Specifies what type of input value the action is expecting.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Type", "code_sample": "" }, "@roblox/globaltype/InputAction.Fire/param/0": { "documentation": "Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using InputBinding." }, "@roblox/globaltype/InputAction.Fire/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Fire": { "documentation": "Updates the InputAction to the given state and fires the appropriate signals.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Fire/param/0" }, { "name": "state", "documentation": "@roblox/globaltype/InputAction.Fire/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Fire", "code_sample": "" }, "@roblox/globaltype/InputAction.GetState/param/0": { "documentation": "Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using InputBinding." }, "@roblox/globaltype/InputAction.GetState/return/0": { "documentation": "The current state of InputAction." }, "@roblox/globaltype/InputAction.GetState": { "documentation": "Returns the current state of the InputAction.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.GetState/param/0" } ], "returns": [ "@roblox/globaltype/InputAction.GetState/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#GetState", "code_sample": "" }, "@roblox/globaltype/InputAction.Pressed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Pressed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Pressed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Pressed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.Pressed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.Pressed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Pressed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Pressed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Pressed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.Pressed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.Pressed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Pressed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Pressed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Pressed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.Pressed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.Pressed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Pressed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Pressed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/InputAction.Pressed": { "documentation": "Fires only when the InputAction.Type is set to Bool on a state transition from false to true.", "keys": { "Connect": "@roblox/globaltype/InputAction.Pressed.Connect", "ConnectParallel": "@roblox/globaltype/InputAction.Pressed.ConnectParallel", "Once": "@roblox/globaltype/InputAction.Pressed.Once", "Wait": "@roblox/globaltype/InputAction.Pressed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Pressed", "code_sample": "" }, "@roblox/globaltype/InputAction.Released.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Released.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Released.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Released.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.Released.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.Released.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Released.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Released.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Released.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.Released.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.Released.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Released.Once/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.Released.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Released.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.Released.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.Released.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.Released.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.Released.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/InputAction.Released": { "documentation": "Fires only when the InputAction.Type is set to Bool on a state transition from true to false.", "keys": { "Connect": "@roblox/globaltype/InputAction.Released.Connect", "ConnectParallel": "@roblox/globaltype/InputAction.Released.ConnectParallel", "Once": "@roblox/globaltype/InputAction.Released.Once", "Wait": "@roblox/globaltype/InputAction.Released.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#Released", "code_sample": "" }, "@roblox/globaltype/InputAction.StateChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.StateChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.StateChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.StateChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.StateChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.StateChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.StateChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.StateChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.StateChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.StateChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.StateChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.StateChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/InputAction.StateChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.StateChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InputAction.StateChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/InputAction.StateChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InputAction.StateChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InputAction.StateChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/InputAction.StateChanged": { "documentation": "Fires for all InputActionType types whenever the state changes, except if the state attempts to transition to the same state.", "keys": { "Connect": "@roblox/globaltype/InputAction.StateChanged.Connect", "ConnectParallel": "@roblox/globaltype/InputAction.StateChanged.ConnectParallel", "Once": "@roblox/globaltype/InputAction.StateChanged.Once", "Wait": "@roblox/globaltype/InputAction.StateChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InputAction#StateChanged", "code_sample": "" }, "@roblox/globaltype/CanvasGroup": { "documentation": "Blends descendants as a group with color/transparency.", "keys": { "GroupColor3": "@roblox/globaltype/CanvasGroup.GroupColor3", "GroupTransparency": "@roblox/globaltype/CanvasGroup.GroupTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CanvasGroup", "code_sample": "" }, "@roblox/globaltype/CanvasGroup.GroupColor3": { "documentation": "Color tint that applies to all descendants.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CanvasGroup#GroupColor3", "code_sample": "" }, "@roblox/globaltype/CanvasGroup.GroupTransparency": { "documentation": "Transparency that applies to all descendants.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CanvasGroup#GroupTransparency", "code_sample": "" }, "@roblox/globaltype/UITextSizeConstraint": { "documentation": "Ensures that the size of text rendered by certain GuiObject classes lies within the range described by MaxTextSize and MinTextSize.", "keys": { "MaxTextSize": "@roblox/globaltype/UITextSizeConstraint.MaxTextSize", "MinTextSize": "@roblox/globaltype/UITextSizeConstraint.MinTextSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITextSizeConstraint", "code_sample": "" }, "@roblox/globaltype/UITextSizeConstraint.MaxTextSize": { "documentation": "The largest size in pixels the font is allowed to be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITextSizeConstraint#MaxTextSize", "code_sample": "" }, "@roblox/globaltype/UITextSizeConstraint.MinTextSize": { "documentation": "The smallest size in pixels the font is allowed to be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UITextSizeConstraint#MinTextSize", "code_sample": "" }, "@roblox/globaltype/LineHandleAdornment": { "documentation": "A line-shaped handle that can be adorned to a BasePart.", "keys": { "Length": "@roblox/globaltype/LineHandleAdornment.Length", "Thickness": "@roblox/globaltype/LineHandleAdornment.Thickness" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineHandleAdornment", "code_sample": "" }, "@roblox/globaltype/LineHandleAdornment.Length": { "documentation": "Length of the line.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineHandleAdornment#Length", "code_sample": "" }, "@roblox/globaltype/LineHandleAdornment.Thickness": { "documentation": "Thickness of the line in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/LineHandleAdornment#Thickness", "code_sample": "" }, "@roblox/globaltype/Sound": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place.", "keys": { "AudioContent": "@roblox/globaltype/Sound.AudioContent", "ChannelCount": "@roblox/globaltype/Sound.ChannelCount", "EmitterSize": "@roblox/globaltype/Sound.EmitterSize", "IsLoaded": "@roblox/globaltype/Sound.IsLoaded", "IsMutedForCapture": "@roblox/globaltype/Sound.IsMutedForCapture", "IsPaused": "@roblox/globaltype/Sound.IsPaused", "IsPlaying": "@roblox/globaltype/Sound.IsPlaying", "isPlaying": "@roblox/globaltype/Sound.isPlaying", "Looped": "@roblox/globaltype/Sound.Looped", "LoopRegion": "@roblox/globaltype/Sound.LoopRegion", "MaxDistance": "@roblox/globaltype/Sound.MaxDistance", "MinDistance": "@roblox/globaltype/Sound.MinDistance", "Pitch": "@roblox/globaltype/Sound.Pitch", "PlaybackLoudness": "@roblox/globaltype/Sound.PlaybackLoudness", "PlaybackRegion": "@roblox/globaltype/Sound.PlaybackRegion", "PlaybackRegionsEnabled": "@roblox/globaltype/Sound.PlaybackRegionsEnabled", "PlaybackSpeed": "@roblox/globaltype/Sound.PlaybackSpeed", "Playing": "@roblox/globaltype/Sound.Playing", "PlayOnRemove": "@roblox/globaltype/Sound.PlayOnRemove", "RollOffMaxDistance": "@roblox/globaltype/Sound.RollOffMaxDistance", "RollOffMinDistance": "@roblox/globaltype/Sound.RollOffMinDistance", "RollOffMode": "@roblox/globaltype/Sound.RollOffMode", "SoundGroup": "@roblox/globaltype/Sound.SoundGroup", "SoundId": "@roblox/globaltype/Sound.SoundId", "TimeLength": "@roblox/globaltype/Sound.TimeLength", "TimePosition": "@roblox/globaltype/Sound.TimePosition", "Volume": "@roblox/globaltype/Sound.Volume", "Pause": "@roblox/globaltype/Sound.Pause", "pause": "@roblox/globaltype/Sound.pause", "Play": "@roblox/globaltype/Sound.Play", "play": "@roblox/globaltype/Sound.play", "Resume": "@roblox/globaltype/Sound.Resume", "Stop": "@roblox/globaltype/Sound.Stop", "stop": "@roblox/globaltype/Sound.stop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound", "code_sample": "local part = Instance.new(\"Part\")\npart.Anchored = true\npart.Position = Vector3.new(0, 3, 0)\npart.BrickColor = BrickColor.new(\"Bright red\")\npart.Name = \"MusicBox\"\npart.Parent = workspace\n\n-- create a sound\nlocal sound = Instance.new(\"Sound\", part)\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.EmitterSize = 5 -- decrease the emitter size (for earlier volume drop off)\nsound.Looped = true\nsound.Parent = part\n\nlocal clickDetector = Instance.new(\"ClickDetector\")\nclickDetector.Parent = part\n\n-- toggle the sound playing / not playing\nclickDetector.MouseClick:Connect(function()\n\tif not sound.IsPlaying then\n\t\tpart.BrickColor = BrickColor.new(\"Bright green\")\n\t\tsound:Play()\n\telse\n\t\tpart.BrickColor = BrickColor.new(\"Bright red\")\n\t\tsound:Stop()\n\tend\nend)" }, "@roblox/globaltype/Sound.AudioContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#AudioContent", "code_sample": "" }, "@roblox/globaltype/Sound.ChannelCount": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#ChannelCount", "code_sample": "" }, "@roblox/globaltype/Sound.EmitterSize": { "documentation": "Deprecated: This property has deprecated in favor of Sound.RollOffMinDistance and Sound.RollOffMaxDistance which should be used instead in new work.
The minimum distance, in studs, at which a 3D Sound (direct child of a BasePart or Attachment) will begin to attenuate (decrease in volume).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#EmitterSize", "code_sample": "local part = Instance.new(\"Part\")\npart.Anchored = true\npart.Position = Vector3.new(0, 3, 0)\npart.BrickColor = BrickColor.new(\"Bright red\")\npart.Name = \"MusicBox\"\npart.Parent = workspace\n\n-- create a sound\nlocal sound = Instance.new(\"Sound\", part)\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.EmitterSize = 5 -- decrease the emitter size (for earlier volume drop off)\nsound.Looped = true\nsound.Parent = part\n\nlocal clickDetector = Instance.new(\"ClickDetector\")\nclickDetector.Parent = part\n\n-- toggle the sound playing / not playing\nclickDetector.MouseClick:Connect(function()\n\tif not sound.IsPlaying then\n\t\tpart.BrickColor = BrickColor.new(\"Bright green\")\n\t\tsound:Play()\n\telse\n\t\tpart.BrickColor = BrickColor.new(\"Bright red\")\n\t\tsound:Stop()\n\tend\nend)" }, "@roblox/globaltype/Sound.IsLoaded": { "documentation": "This property is true when the Sound has loaded from Roblox servers and is ready to play.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#IsLoaded", "code_sample": "local sound = script.Parent.Sound\n\nif not sound.IsLoaded then\n\tsound.Loaded:Wait()\nend\n\nprint(\"The sound has loaded!\")" }, "@roblox/globaltype/Sound.IsMutedForCapture": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#IsMutedForCapture", "code_sample": "" }, "@roblox/globaltype/Sound.IsPaused": { "documentation": "Read-only property which returns true when the Sound is not playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#IsPaused", "code_sample": "local sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.Looped = true\nsound.Parent = workspace\n\nif not sound.isLoaded then\n\tsound.Loaded:Wait()\nend\n\nsound:Play()\nprint(sound.IsPlaying, sound.IsPaused) -- true, false\n\ntask.wait(2)\nsound:Pause()\nprint(sound.IsPlaying, sound.IsPaused) -- false, true\n\ntask.wait(2)\nsound:Play()\nprint(sound.IsPlaying, sound.IsPaused) -- true, false\n\ntask.wait(2)\nsound:Stop()\nprint(sound.IsPlaying, sound.IsPaused) -- false, true" }, "@roblox/globaltype/Sound.IsPlaying": { "documentation": "Read-only property which returns true when the Sound is playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#IsPlaying", "code_sample": "local sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.Looped = true\nsound.Parent = workspace\n\nif not sound.isLoaded then\n\tsound.Loaded:Wait()\nend\n\nsound:Play()\nprint(sound.IsPlaying, sound.IsPaused) -- true, false\n\ntask.wait(2)\nsound:Pause()\nprint(sound.IsPlaying, sound.IsPaused) -- false, true\n\ntask.wait(2)\nsound:Play()\nprint(sound.IsPlaying, sound.IsPaused) -- true, false\n\ntask.wait(2)\nsound:Stop()\nprint(sound.IsPlaying, sound.IsPaused) -- false, true" }, "@roblox/globaltype/Sound.isPlaying": { "documentation": "Deprecated: This deprecated property is a variant of Sound.IsPlaying which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#isPlaying", "code_sample": "" }, "@roblox/globaltype/Sound.Looped": { "documentation": "Sets whether or not the Sound repeats once it has finished playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Looped", "code_sample": "local function loopNTimes(sound, numberOfLoops)\n\tif not sound.IsPlaying then\n\t\tsound.Looped = true\n\t\tlocal connection = nil\n\t\tconnection = sound.DidLoop:Connect(function(_soundId, numOfTimesLooped)\n\t\t\tprint(numOfTimesLooped)\n\t\t\tif numOfTimesLooped >= numberOfLoops then\n\t\t\t\t-- disconnect the connection\n\t\t\t\tconnection:Disconnect()\n\t\t\t\t-- stop the sound\n\t\t\t\tsound:Stop()\n\t\t\tend\n\t\tend)\n\t\tsound:Play()\n\tend\nend\n\nlocal sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://0\"\n\nloopNTimes(sound, 5)" }, "@roblox/globaltype/Sound.LoopRegion": { "documentation": "A range denoting a desired loop start and loop end within the PlaybackRegion, in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#LoopRegion", "code_sample": "" }, "@roblox/globaltype/Sound.MaxDistance": { "documentation": "Deprecated: This property has deprecated in favor of Sound.RollOffMinDistance and Sound.RollOffMaxDistance which should be used instead in new work.
The maximum distance, in studs, a client's listener can be from the Sound\\s origin and still hear it. Only applies to Sounds parented to a Part or Attachment (3D sounds).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#MaxDistance", "code_sample": "" }, "@roblox/globaltype/Sound.MinDistance": { "documentation": "Deprecated: MinDistance has been superseded by Sound.EmitterSize, whose name better describes this properties behavior.
The minimum distance at which a 3D Sound (direct child of a BasePart or Attachment) will begin to attenuate. Effectively, the emitter size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#MinDistance", "code_sample": "" }, "@roblox/globaltype/Sound.Pitch": { "documentation": "Deprecated: This property has been deprecated in favor of Sound.PlaybackSpeed whose name suits the behavior better.
Sets how high pitched and fast a Sound is when it is played. The greater the integer, the higher and faster the Sound is.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Pitch", "code_sample": "" }, "@roblox/globaltype/Sound.PlaybackLoudness": { "documentation": "A number between 0 and 1000 indicating how loud the Sound is currently playing back.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#PlaybackLoudness", "code_sample": "" }, "@roblox/globaltype/Sound.PlaybackRegion": { "documentation": "A range denoting a desired start and stop time within the TimeLength, in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#PlaybackRegion", "code_sample": "" }, "@roblox/globaltype/Sound.PlaybackRegionsEnabled": { "documentation": "If true, this property gives your Sound access to the PlaybackRegion and LoopRegion properties which can more-accurately control its playback.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#PlaybackRegionsEnabled", "code_sample": "" }, "@roblox/globaltype/Sound.PlaybackSpeed": { "documentation": "Determines the speed at which a Sound will play, with higher values causing the sound to play faster and at a higher pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#PlaybackSpeed", "code_sample": "local sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.Looped = true\nsound.Parent = workspace\n\nsound:Play()\ntask.wait(10)\nsound.PlaybackSpeed = 3 -- 3x faster\ntask.wait(5)\nsound.PlaybackSpeed = 0.5 -- 2x slower\ntask.wait(5)\nsound.PlaybackSpeed = 1 -- default" }, "@roblox/globaltype/Sound.Playing": { "documentation": "Indicates whether the Sound is currently playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Playing", "code_sample": "local sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.Looped = true\nsound.Parent = workspace\n\nprint(\"playing sound\")\nsound.Playing = true\n\ntask.wait(10)\n\nprint(\"stopping sound\")\nsound.Playing = false\n\ntask.wait(5)\n\nsound.Playing = true\nlocal timePosition = sound.TimePosition\nprint(\"resumed at time position: \" .. tostring(timePosition)) -- c. 10 seconds" }, "@roblox/globaltype/Sound.PlayOnRemove": { "documentation": "When true, the Sound will play when it is removed from the experience.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#PlayOnRemove", "code_sample": "" }, "@roblox/globaltype/Sound.RollOffMaxDistance": { "documentation": "The maximum distance, in studs, a client's listener can be from the sound's origin and still hear it. Only applies to Sounds parented to a BasePart or Attachment.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#RollOffMaxDistance", "code_sample": "" }, "@roblox/globaltype/Sound.RollOffMinDistance": { "documentation": "The minimum distance, in studs, at which a Sound which is parented to a BasePart or Attachment will begin to attenuate (decrease in volume).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#RollOffMinDistance", "code_sample": "" }, "@roblox/globaltype/Sound.RollOffMode": { "documentation": "Controls how the volume of a Sound which is parented to a BasePart or Attachment attenuates (fades out) as the distance between the listener and parent changes.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#RollOffMode", "code_sample": "" }, "@roblox/globaltype/Sound.SoundGroup": { "documentation": "The SoundGroup that is linked to this Sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#SoundGroup", "code_sample": "" }, "@roblox/globaltype/Sound.SoundId": { "documentation": "Content ID of the sound file to associate with the Sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#SoundId", "code_sample": "" }, "@roblox/globaltype/Sound.TimeLength": { "documentation": "The length of the Sound in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#TimeLength", "code_sample": "local function playForDuration(sound, duration)\n\tif not sound.IsLoaded then\n\t\tsound.Loaded:wait()\n\tend\n\tlocal speed = sound.TimeLength / duration\n\tsound.PlaybackSpeed = speed\n\tsound:Play()\nend\n\nlocal sound = script.Parent\nplayForDuration(sound, 5)" }, "@roblox/globaltype/Sound.TimePosition": { "documentation": "Progress of the Sound in seconds. Can be changed to move the playback position of the Sound both before and during playback.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#TimePosition", "code_sample": "local sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://9120386436\"\nsound.Parent = workspace\n\nsound.TimePosition = 30\n\nsound:Play()\n\ntask.wait(5)\n\nsound.TimePosition = 100\n\ntask.wait(5)\n\nsound.TimePosition = 0" }, "@roblox/globaltype/Sound.Volume": { "documentation": "The volume of the Sound.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Volume", "code_sample": "" }, "@roblox/globaltype/Sound.Pause/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.Pause": { "documentation": "Pauses playback of the Sound if it is playing.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Pause", "code_sample": "" }, "@roblox/globaltype/Sound.pause/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.pause": { "documentation": "Deprecated: This deprecated function is a variant of Sound:Pause() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#pause", "code_sample": "" }, "@roblox/globaltype/Sound.Play/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.Play": { "documentation": "Plays the Sound.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Play", "code_sample": "" }, "@roblox/globaltype/Sound.play/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.play": { "documentation": "Deprecated: This deprecated function is a variant of Sound:Play() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#play", "code_sample": "" }, "@roblox/globaltype/Sound.Resume/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.Resume": { "documentation": "Resumes the Sound.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Resume/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Resume", "code_sample": "" }, "@roblox/globaltype/Sound.Stop/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.Stop": { "documentation": "Stops the Sound.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Stop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Stop", "code_sample": "" }, "@roblox/globaltype/Sound.stop/param/0": { "documentation": "An object that emits sound. This object can be placed within a BasePart or Attachment to emit a sound from a particular position within a place or world, or it can be attached elsewhere to play the sound at a constant volume throughout the entire place." }, "@roblox/globaltype/Sound.stop": { "documentation": "Deprecated: This deprecated function is a variant of Sound:Stop() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.stop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#stop", "code_sample": "" }, "@roblox/globaltype/Sound.DidLoop.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.DidLoop.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.DidLoop.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.DidLoop.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.DidLoop.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.DidLoop.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.DidLoop.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.DidLoop.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.DidLoop.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.DidLoop.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.DidLoop.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.DidLoop.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.DidLoop.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.DidLoop.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.DidLoop.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.DidLoop.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.DidLoop.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.DidLoop.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.DidLoop": { "documentation": "Fires whenever the Sound loops.", "keys": { "Connect": "@roblox/globaltype/Sound.DidLoop.Connect", "ConnectParallel": "@roblox/globaltype/Sound.DidLoop.ConnectParallel", "Once": "@roblox/globaltype/Sound.DidLoop.Once", "Wait": "@roblox/globaltype/Sound.DidLoop.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#DidLoop", "code_sample": "local function loopNTimes(sound, numberOfLoops)\n\tif not sound.IsPlaying then\n\t\tsound.Looped = true\n\t\tlocal connection = nil\n\t\tconnection = sound.DidLoop:Connect(function(_soundId, numOfTimesLooped)\n\t\t\tprint(numOfTimesLooped)\n\t\t\tif numOfTimesLooped >= numberOfLoops then\n\t\t\t\t-- disconnect the connection\n\t\t\t\tconnection:Disconnect()\n\t\t\t\t-- stop the sound\n\t\t\t\tsound:Stop()\n\t\t\tend\n\t\tend)\n\t\tsound:Play()\n\tend\nend\n\nlocal sound = Instance.new(\"Sound\")\nsound.SoundId = \"rbxassetid://0\"\n\nloopNTimes(sound, 5)" }, "@roblox/globaltype/Sound.Ended.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Ended.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Ended.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Ended.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Ended.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Ended.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Ended.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Ended.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Ended.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Ended.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Ended.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Ended.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Ended.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Ended.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Ended.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Ended.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Ended.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Ended.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.Ended": { "documentation": "Fires when the Sound has completed playback and stopped.", "keys": { "Connect": "@roblox/globaltype/Sound.Ended.Connect", "ConnectParallel": "@roblox/globaltype/Sound.Ended.ConnectParallel", "Once": "@roblox/globaltype/Sound.Ended.Once", "Wait": "@roblox/globaltype/Sound.Ended.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Ended", "code_sample": "" }, "@roblox/globaltype/Sound.Loaded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Loaded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Loaded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Loaded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Loaded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Loaded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Loaded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Loaded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Loaded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Loaded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Loaded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Loaded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Loaded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Loaded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Loaded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Loaded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Loaded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Loaded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.Loaded": { "documentation": "Fires when the Sound is loaded.", "keys": { "Connect": "@roblox/globaltype/Sound.Loaded.Connect", "ConnectParallel": "@roblox/globaltype/Sound.Loaded.ConnectParallel", "Once": "@roblox/globaltype/Sound.Loaded.Once", "Wait": "@roblox/globaltype/Sound.Loaded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Loaded", "code_sample": "local sound = script.Parent.Sound\n\nif not sound.IsLoaded then\n\tsound.Loaded:Wait()\nend\n\nprint(\"The sound has loaded!\")" }, "@roblox/globaltype/Sound.Paused.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Paused.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Paused.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Paused.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Paused.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Paused.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Paused.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Paused.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Paused.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Paused.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Paused.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Paused.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Paused.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Paused.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Paused.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Paused.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Paused.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Paused.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.Paused": { "documentation": "Fires whenever the Sound is paused using Pause().", "keys": { "Connect": "@roblox/globaltype/Sound.Paused.Connect", "ConnectParallel": "@roblox/globaltype/Sound.Paused.ConnectParallel", "Once": "@roblox/globaltype/Sound.Paused.Once", "Wait": "@roblox/globaltype/Sound.Paused.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Paused", "code_sample": "" }, "@roblox/globaltype/Sound.Played.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Played.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Played.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Played.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Played.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Played.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Played.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Played.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Played.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Played.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Played.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Played.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Played.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Played.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Played.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Played.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Played.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Played.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.Played": { "documentation": "Fires whenever the Sound is played using Play().", "keys": { "Connect": "@roblox/globaltype/Sound.Played.Connect", "ConnectParallel": "@roblox/globaltype/Sound.Played.ConnectParallel", "Once": "@roblox/globaltype/Sound.Played.Once", "Wait": "@roblox/globaltype/Sound.Played.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Played", "code_sample": "" }, "@roblox/globaltype/Sound.Resumed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Resumed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Resumed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Resumed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Resumed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Resumed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Resumed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Resumed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Resumed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Resumed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Resumed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Resumed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Resumed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Resumed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Resumed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Resumed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Resumed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Resumed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.Resumed": { "documentation": "Fires when the Sound is resumed using Resume().", "keys": { "Connect": "@roblox/globaltype/Sound.Resumed.Connect", "ConnectParallel": "@roblox/globaltype/Sound.Resumed.ConnectParallel", "Once": "@roblox/globaltype/Sound.Resumed.Once", "Wait": "@roblox/globaltype/Sound.Resumed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Resumed", "code_sample": "" }, "@roblox/globaltype/Sound.Stopped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Stopped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Stopped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Stopped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Stopped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Stopped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Stopped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Stopped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Stopped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Stopped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Stopped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Stopped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Sound.Stopped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Stopped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Sound.Stopped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Sound.Stopped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Sound.Stopped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Sound.Stopped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Sound.Stopped": { "documentation": "Fires when the Sound is stopped through using Stop().", "keys": { "Connect": "@roblox/globaltype/Sound.Stopped.Connect", "ConnectParallel": "@roblox/globaltype/Sound.Stopped.ConnectParallel", "Once": "@roblox/globaltype/Sound.Stopped.Once", "Wait": "@roblox/globaltype/Sound.Stopped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sound#Stopped", "code_sample": "" }, "@roblox/globaltype/Hopper": { "documentation": "Deprecated: Hopper has been replaced by StarterPack and should not be used in new work.
Hopper is the original name of the StarterPack service.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Hopper", "code_sample": "" }, "@roblox/globaltype/VisualizationModeService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VisualizationModeService", "code_sample": "" }, "@roblox/globaltype/Sparkles": { "documentation": "A particle emitter with the visual aesthetic of sparkles.", "keys": { "Color": "@roblox/globaltype/Sparkles.Color", "Enabled": "@roblox/globaltype/Sparkles.Enabled", "LocalTransparencyModifier": "@roblox/globaltype/Sparkles.LocalTransparencyModifier", "SparkleColor": "@roblox/globaltype/Sparkles.SparkleColor", "TimeScale": "@roblox/globaltype/Sparkles.TimeScale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sparkles", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterSpawned(character)\n\tlocal hrp = character:WaitForChild(\"HumanoidRootPart\")\n\t-- Add sparkles that are colored to the player's torso color\n\tlocal sparkles = Instance.new(\"Sparkles\")\n\tsparkles.Parent = hrp\n\tsparkles.SparkleColor = character:WaitForChild(\"Body Colors\").TorsoColor.Color\n\tsparkles.Enabled = true\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterSpawned)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Sparkles.Color": { "documentation": "Determines the color of the sparkle particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sparkles#Color", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterSpawned(character)\n\tlocal hrp = character:WaitForChild(\"HumanoidRootPart\")\n\t-- Add sparkles that are colored to the player's torso color\n\tlocal sparkles = Instance.new(\"Sparkles\")\n\tsparkles.Parent = hrp\n\tsparkles.SparkleColor = character:WaitForChild(\"Body Colors\").TorsoColor.Color\n\tsparkles.Enabled = true\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterSpawned)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Sparkles.Enabled": { "documentation": "Determines whether sparkles are emit.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sparkles#Enabled", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterSpawned(character)\n\tlocal hrp = character:WaitForChild(\"HumanoidRootPart\")\n\t-- Add sparkles that are colored to the player's torso color\n\tlocal sparkles = Instance.new(\"Sparkles\")\n\tsparkles.Parent = hrp\n\tsparkles.SparkleColor = character:WaitForChild(\"Body Colors\").TorsoColor.Color\n\tsparkles.Enabled = true\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterSpawned)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Sparkles.LocalTransparencyModifier": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sparkles#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Sparkles.SparkleColor": { "documentation": "Determines the color of the sparkle particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sparkles#SparkleColor", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterSpawned(character)\n\tlocal hrp = character:WaitForChild(\"HumanoidRootPart\")\n\t-- Add sparkles that are colored to the player's torso color\n\tlocal sparkles = Instance.new(\"Sparkles\")\n\tsparkles.Parent = hrp\n\tsparkles.SparkleColor = character:WaitForChild(\"Body Colors\").TorsoColor.Color\n\tsparkles.Enabled = true\nend\n\nlocal function onPlayerAdded(player)\n\tplayer.CharacterAdded:Connect(onCharacterSpawned)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Sparkles.TimeScale": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sparkles#TimeScale", "code_sample": "" }, "@roblox/globaltype/OpenCloudApiV1": { "documentation": "Deprecated: This class is deprecated and should not be used for new work. Use HttpService instead and see the In-experience HTTP requests guide.", "keys": { "CreateModel": "@roblox/globaltype/OpenCloudApiV1.CreateModel", "CreateUserNotificationAsync": "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1", "code_sample": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateModel/param/0": { "documentation": "Deprecated: This class is deprecated and should not be used for new work. Use HttpService instead and see the In-experience HTTP requests guide." }, "@roblox/globaltype/OpenCloudApiV1.CreateModel/param/1": { "documentation": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateModel/return/0": { "documentation": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateModel": { "documentation": "Deprecated: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/OpenCloudApiV1.CreateModel/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/OpenCloudApiV1.CreateModel/param/1" } ], "returns": [ "@roblox/globaltype/OpenCloudApiV1.CreateModel/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1#CreateModel", "code_sample": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/param/0": { "documentation": "Deprecated: This class is deprecated and should not be used for new work. Use HttpService instead and see the In-experience HTTP requests guide." }, "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/param/1": { "documentation": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/param/2": { "documentation": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/return/0": { "documentation": "" }, "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync": { "documentation": "Deprecated: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/param/0" }, { "name": "user", "documentation": "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/param/1" }, { "name": "userNotification", "documentation": "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/param/2" } ], "returns": [ "@roblox/globaltype/OpenCloudApiV1.CreateUserNotificationAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/OpenCloudApiV1#CreateUserNotificationAsync", "code_sample": "" }, "@roblox/globaltype/CompositeValueCurve": { "documentation": "An animation curve that groups child FloatCurves which each animate a different component of a non-unary value.", "keys": { "CurveType": "@roblox/globaltype/CompositeValueCurve.CurveType", "GetValueAtTime": "@roblox/globaltype/CompositeValueCurve.GetValueAtTime", "GetComponentCurves": "@roblox/globaltype/CompositeValueCurve.GetComponentCurves" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve", "code_sample": "" }, "@roblox/globaltype/CompositeValueCurve.CurveType": { "documentation": "The type of value animated by this CompositeValueCurve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#CurveType", "code_sample": "" }, "@roblox/globaltype/CompositeValueCurve.GetValueAtTime/param/0": { "documentation": "An animation curve that groups child FloatCurves which each animate a different component of a non-unary value." }, "@roblox/globaltype/CompositeValueCurve.GetValueAtTime/param/1": { "documentation": "Time at which to get the value." }, "@roblox/globaltype/CompositeValueCurve.GetValueAtTime/return/0": { "documentation": "The value of the curve at the passed time." }, "@roblox/globaltype/CompositeValueCurve.GetValueAtTime": { "documentation": "Returns the sampled animated value at the passed time argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CompositeValueCurve.GetValueAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/CompositeValueCurve.GetValueAtTime/param/1" } ], "returns": [ "@roblox/globaltype/CompositeValueCurve.GetValueAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetValueAtTime", "code_sample": "" }, "@roblox/globaltype/CompositeValueCurve.GetComponentCurves/param/0": { "documentation": "An animation curve that groups child FloatCurves which each animate a different component of a non-unary value." }, "@roblox/globaltype/CompositeValueCurve.GetComponentCurves/return/0": { "documentation": "" }, "@roblox/globaltype/CompositeValueCurve.GetComponentCurves": { "documentation": "Returns the child curves with the given names for the CurveType of this CompositeValueCurve.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/CompositeValueCurve.GetComponentCurves/param/0" } ], "returns": [ "@roblox/globaltype/CompositeValueCurve.GetComponentCurves/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetComponentCurves", "code_sample": "" }, "@roblox/globaltype/AudioPlayer": { "documentation": "Used to play audio assets.", "keys": { "Asset": "@roblox/globaltype/AudioPlayer.Asset", "AssetId": "@roblox/globaltype/AudioPlayer.AssetId", "AudioContent": "@roblox/globaltype/AudioPlayer.AudioContent", "AutoLoad": "@roblox/globaltype/AudioPlayer.AutoLoad", "AutoPlay": "@roblox/globaltype/AudioPlayer.AutoPlay", "IsMutedForCapture": "@roblox/globaltype/AudioPlayer.IsMutedForCapture", "IsPlaying": "@roblox/globaltype/AudioPlayer.IsPlaying", "IsReady": "@roblox/globaltype/AudioPlayer.IsReady", "Looping": "@roblox/globaltype/AudioPlayer.Looping", "LoopRegion": "@roblox/globaltype/AudioPlayer.LoopRegion", "PlaybackRegion": "@roblox/globaltype/AudioPlayer.PlaybackRegion", "PlaybackSpeed": "@roblox/globaltype/AudioPlayer.PlaybackSpeed", "TimeLength": "@roblox/globaltype/AudioPlayer.TimeLength", "TimePosition": "@roblox/globaltype/AudioPlayer.TimePosition", "Volume": "@roblox/globaltype/AudioPlayer.Volume", "GetConnectedWires": "@roblox/globaltype/AudioPlayer.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioPlayer.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioPlayer.GetOutputPins", "GetWaveformAsync": "@roblox/globaltype/AudioPlayer.GetWaveformAsync", "Play": "@roblox/globaltype/AudioPlayer.Play", "Stop": "@roblox/globaltype/AudioPlayer.Stop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer", "code_sample": "local audioPlayer: AudioPlayer = Instance.new(\"AudioPlayer\")\naudioPlayer.Parent = workspace\naudioPlayer.AssetId = \"rbxassetid://9112854440\"\n\nlocal deviceOutput = Instance.new(\"AudioDeviceOutput\")\ndeviceOutput.Parent = workspace\n\nlocal wire = Instance.new(\"Wire\")\nwire.Parent = workspace\n\nwire.SourceInstance = audioPlayer\nwire.TargetInstance = deviceOutput\n\naudioPlayer:Play()" }, "@roblox/globaltype/AudioPlayer.Asset": { "documentation": "The asset to be loaded into the AudioPlayer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Asset", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.AssetId": { "documentation": "Deprecated: This property is deprecated; use Asset instead.
The asset to be loaded into the AudioPlayer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AssetId", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.AudioContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AudioContent", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.AutoLoad": { "documentation": "Controls whether Asset loads automatically once assigned.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoLoad", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.AutoPlay": { "documentation": "Denotes whether this AudioPlayer starts playing as soon as it spawns in for the first time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoPlay", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.IsMutedForCapture": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#IsMutedForCapture", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.IsPlaying": { "documentation": "Denotes whether this AudioPlayer is currently playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#IsPlaying", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.IsReady": { "documentation": "Denotes whether this AudioPlayer is loaded, buffered, and ready to play.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#IsReady", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.Looping": { "documentation": "Controls whether this AudioPlayer loops.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Looping", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.LoopRegion": { "documentation": "A range, in seconds, denoting a desired loop start and loop end within the PlaybackRegion of this AudioPlayer.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#LoopRegion", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.PlaybackRegion": { "documentation": "Range in seconds denoting a desired start time (minimum) and stop time (maximum) within the TimeLength.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#PlaybackRegion", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.PlaybackSpeed": { "documentation": "Controls how quickly the asset will be played, which controls its pitch.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#PlaybackSpeed", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.TimeLength": { "documentation": "Denotes the length of the loaded asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#TimeLength", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.TimePosition": { "documentation": "Tracks the current position of the playhead within the asset.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#TimePosition", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.Volume": { "documentation": "Controls how loudly the asset will be played.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Volume", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.GetConnectedWires/param/0": { "documentation": "Used to play audio assets." }, "@roblox/globaltype/AudioPlayer.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioPlayer.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioPlayer.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.GetInputPins/param/0": { "documentation": "Used to play audio assets." }, "@roblox/globaltype/AudioPlayer.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioPlayer.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.GetOutputPins/param/0": { "documentation": "Used to play audio assets." }, "@roblox/globaltype/AudioPlayer.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioPlayer.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.GetWaveformAsync/param/0": { "documentation": "Used to play audio assets." }, "@roblox/globaltype/AudioPlayer.GetWaveformAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetWaveformAsync/param/2": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetWaveformAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.GetWaveformAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.GetWaveformAsync/param/0" }, { "name": "timeRange", "documentation": "@roblox/globaltype/AudioPlayer.GetWaveformAsync/param/1" }, { "name": "samples", "documentation": "@roblox/globaltype/AudioPlayer.GetWaveformAsync/param/2" } ], "returns": [ "@roblox/globaltype/AudioPlayer.GetWaveformAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetWaveformAsync", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.Play/param/0": { "documentation": "Used to play audio assets." }, "@roblox/globaltype/AudioPlayer.Play": { "documentation": "Plays the AudioPlayer from wherever its TimePosition is.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Play", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.Stop/param/0": { "documentation": "Used to play audio assets." }, "@roblox/globaltype/AudioPlayer.Stop": { "documentation": "Stops the AudioPlayer wherever its TimePosition is.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Stop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Stop", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.Ended.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Ended.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.Ended.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Ended.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.Ended.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Ended.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Ended.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.Ended.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Ended.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.Ended.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Ended.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Ended.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.Ended.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Ended.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.Ended.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Ended.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Ended.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Ended.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Ended": { "documentation": "Fires when the AudioPlayer has completed playback and stopped.", "keys": { "Connect": "@roblox/globaltype/AudioPlayer.Ended.Connect", "ConnectParallel": "@roblox/globaltype/AudioPlayer.Ended.ConnectParallel", "Once": "@roblox/globaltype/AudioPlayer.Ended.Once", "Wait": "@roblox/globaltype/AudioPlayer.Ended.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Ended", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.Looped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Looped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.Looped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Looped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.Looped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Looped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Looped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.Looped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Looped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.Looped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Looped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Looped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.Looped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Looped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.Looped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Looped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.Looped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.Looped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.Looped": { "documentation": "Fires when the AudioPlayer loops.", "keys": { "Connect": "@roblox/globaltype/AudioPlayer.Looped.Connect", "ConnectParallel": "@roblox/globaltype/AudioPlayer.Looped.ConnectParallel", "Once": "@roblox/globaltype/AudioPlayer.Looped.Once", "Wait": "@roblox/globaltype/AudioPlayer.Looped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Looped", "code_sample": "" }, "@roblox/globaltype/AudioPlayer.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioPlayer.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioPlayer.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioPlayer.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioPlayer.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioPlayer via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioPlayer.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioPlayer.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioPlayer.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioPlayer.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#WiringChanged", "code_sample": "" }, "@roblox/globaltype/Flag": { "documentation": "Deprecated: The Flag and FlagStand objects were created to allow developers to make 'capture the flag' style games quickly. However they have been deprecated and developers are advised to design their own systems which will be more flexible and reliable.
The Flag object helps you make 'capture the flag' style games.", "keys": { "TeamColor": "@roblox/globaltype/Flag.TeamColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Flag", "code_sample": "" }, "@roblox/globaltype/Flag.TeamColor": { "documentation": "The Team this flag is for. Corresponds with the TeamColors in the Teams service.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Flag#TeamColor", "code_sample": "" }, "@roblox/globaltype/DataStoreIncrementOptions": { "documentation": "Specifies additional parameters for a GlobalDataStore:IncrementAsync() call.", "keys": { "GetMetadata": "@roblox/globaltype/DataStoreIncrementOptions.GetMetadata", "SetMetadata": "@roblox/globaltype/DataStoreIncrementOptions.SetMetadata" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreIncrementOptions", "code_sample": "" }, "@roblox/globaltype/DataStoreIncrementOptions.GetMetadata/param/0": { "documentation": "Specifies additional parameters for a GlobalDataStore:IncrementAsync() call." }, "@roblox/globaltype/DataStoreIncrementOptions.GetMetadata/return/0": { "documentation": "Metadata associated with this DataStoreIncrementOptions instance." }, "@roblox/globaltype/DataStoreIncrementOptions.GetMetadata": { "documentation": "Gets the custom metadata set with this DataStoreIncrementOptions instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreIncrementOptions.GetMetadata/param/0" } ], "returns": [ "@roblox/globaltype/DataStoreIncrementOptions.GetMetadata/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreIncrementOptions#GetMetadata", "code_sample": "" }, "@roblox/globaltype/DataStoreIncrementOptions.SetMetadata/param/0": { "documentation": "Specifies additional parameters for a GlobalDataStore:IncrementAsync() call." }, "@roblox/globaltype/DataStoreIncrementOptions.SetMetadata/param/1": { "documentation": "Metadata values to set for the key." }, "@roblox/globaltype/DataStoreIncrementOptions.SetMetadata": { "documentation": "Sets custom metadata to be associated with the key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DataStoreIncrementOptions.SetMetadata/param/0" }, { "name": "attributes", "documentation": "@roblox/globaltype/DataStoreIncrementOptions.SetMetadata/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataStoreIncrementOptions#SetMetadata", "code_sample": "" }, "@roblox/globaltype/TremoloSoundEffect": { "documentation": "Creates a trembling effect on a sound by varying the volume of the sound up and down.", "keys": { "Depth": "@roblox/globaltype/TremoloSoundEffect.Depth", "Duty": "@roblox/globaltype/TremoloSoundEffect.Duty", "Frequency": "@roblox/globaltype/TremoloSoundEffect.Frequency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TremoloSoundEffect", "code_sample": "" }, "@roblox/globaltype/TremoloSoundEffect.Depth": { "documentation": "Controls how much the volume will raise and lower.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TremoloSoundEffect#Depth", "code_sample": "" }, "@roblox/globaltype/TremoloSoundEffect.Duty": { "documentation": "Controls how long during one volume oscillation the effect will be active.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TremoloSoundEffect#Duty", "code_sample": "" }, "@roblox/globaltype/TremoloSoundEffect.Frequency": { "documentation": "Sets how often the effect will oscillate the volume.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TremoloSoundEffect#Frequency", "code_sample": "" }, "@roblox/globaltype/DialogChoice": { "documentation": "Used to craft the further choices available to players who have started a dialog conversation with an NPC.", "keys": { "GoodbyeChoiceActive": "@roblox/globaltype/DialogChoice.GoodbyeChoiceActive", "GoodbyeDialog": "@roblox/globaltype/DialogChoice.GoodbyeDialog", "ResponseDialog": "@roblox/globaltype/DialogChoice.ResponseDialog", "UserDialog": "@roblox/globaltype/DialogChoice.UserDialog" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DialogChoice", "code_sample": "" }, "@roblox/globaltype/DialogChoice.GoodbyeChoiceActive": { "documentation": "Toggles whether the goodbye option will be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DialogChoice#GoodbyeChoiceActive", "code_sample": "" }, "@roblox/globaltype/DialogChoice.GoodbyeDialog": { "documentation": "Sets the sentence that the dialog will show to the player when the chat ends.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DialogChoice#GoodbyeDialog", "code_sample": "" }, "@roblox/globaltype/DialogChoice.ResponseDialog": { "documentation": "Sets what the NPC will say when the player chooses this DialogChoice.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DialogChoice#ResponseDialog", "code_sample": "" }, "@roblox/globaltype/DialogChoice.UserDialog": { "documentation": "Sets what the player will say when they choose this DialogChoice.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DialogChoice#UserDialog", "code_sample": "" }, "@roblox/globaltype/FaceControls": { "documentation": "The FaceControls object defines a set of properties for controlling the facial expressions of a Dynamic Head.", "keys": { "ChinRaiser": "@roblox/globaltype/FaceControls.ChinRaiser", "ChinRaiserUpperLip": "@roblox/globaltype/FaceControls.ChinRaiserUpperLip", "Corrugator": "@roblox/globaltype/FaceControls.Corrugator", "EyesLookDown": "@roblox/globaltype/FaceControls.EyesLookDown", "EyesLookLeft": "@roblox/globaltype/FaceControls.EyesLookLeft", "EyesLookRight": "@roblox/globaltype/FaceControls.EyesLookRight", "EyesLookUp": "@roblox/globaltype/FaceControls.EyesLookUp", "FlatPucker": "@roblox/globaltype/FaceControls.FlatPucker", "Funneler": "@roblox/globaltype/FaceControls.Funneler", "JawDrop": "@roblox/globaltype/FaceControls.JawDrop", "JawLeft": "@roblox/globaltype/FaceControls.JawLeft", "JawRight": "@roblox/globaltype/FaceControls.JawRight", "LeftBrowLowerer": "@roblox/globaltype/FaceControls.LeftBrowLowerer", "LeftCheekPuff": "@roblox/globaltype/FaceControls.LeftCheekPuff", "LeftCheekRaiser": "@roblox/globaltype/FaceControls.LeftCheekRaiser", "LeftDimpler": "@roblox/globaltype/FaceControls.LeftDimpler", "LeftEyeClosed": "@roblox/globaltype/FaceControls.LeftEyeClosed", "LeftEyeUpperLidRaiser": "@roblox/globaltype/FaceControls.LeftEyeUpperLidRaiser", "LeftInnerBrowRaiser": "@roblox/globaltype/FaceControls.LeftInnerBrowRaiser", "LeftLipCornerDown": "@roblox/globaltype/FaceControls.LeftLipCornerDown", "LeftLipCornerPuller": "@roblox/globaltype/FaceControls.LeftLipCornerPuller", "LeftLipStretcher": "@roblox/globaltype/FaceControls.LeftLipStretcher", "LeftLowerLipDepressor": "@roblox/globaltype/FaceControls.LeftLowerLipDepressor", "LeftNoseWrinkler": "@roblox/globaltype/FaceControls.LeftNoseWrinkler", "LeftOuterBrowRaiser": "@roblox/globaltype/FaceControls.LeftOuterBrowRaiser", "LeftUpperLipRaiser": "@roblox/globaltype/FaceControls.LeftUpperLipRaiser", "LipPresser": "@roblox/globaltype/FaceControls.LipPresser", "LipsTogether": "@roblox/globaltype/FaceControls.LipsTogether", "LowerLipSuck": "@roblox/globaltype/FaceControls.LowerLipSuck", "MouthLeft": "@roblox/globaltype/FaceControls.MouthLeft", "MouthRight": "@roblox/globaltype/FaceControls.MouthRight", "Pucker": "@roblox/globaltype/FaceControls.Pucker", "RightBrowLowerer": "@roblox/globaltype/FaceControls.RightBrowLowerer", "RightCheekPuff": "@roblox/globaltype/FaceControls.RightCheekPuff", "RightCheekRaiser": "@roblox/globaltype/FaceControls.RightCheekRaiser", "RightDimpler": "@roblox/globaltype/FaceControls.RightDimpler", "RightEyeClosed": "@roblox/globaltype/FaceControls.RightEyeClosed", "RightEyeUpperLidRaiser": "@roblox/globaltype/FaceControls.RightEyeUpperLidRaiser", "RightInnerBrowRaiser": "@roblox/globaltype/FaceControls.RightInnerBrowRaiser", "RightLipCornerDown": "@roblox/globaltype/FaceControls.RightLipCornerDown", "RightLipCornerPuller": "@roblox/globaltype/FaceControls.RightLipCornerPuller", "RightLipStretcher": "@roblox/globaltype/FaceControls.RightLipStretcher", "RightLowerLipDepressor": "@roblox/globaltype/FaceControls.RightLowerLipDepressor", "RightNoseWrinkler": "@roblox/globaltype/FaceControls.RightNoseWrinkler", "RightOuterBrowRaiser": "@roblox/globaltype/FaceControls.RightOuterBrowRaiser", "RightUpperLipRaiser": "@roblox/globaltype/FaceControls.RightUpperLipRaiser", "TongueDown": "@roblox/globaltype/FaceControls.TongueDown", "TongueOut": "@roblox/globaltype/FaceControls.TongueOut", "TongueUp": "@roblox/globaltype/FaceControls.TongueUp", "UpperLipSuck": "@roblox/globaltype/FaceControls.UpperLipSuck" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls", "code_sample": "" }, "@roblox/globaltype/FaceControls.ChinRaiser": { "documentation": "Raises the chin up; moves the lower lip upwards.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#ChinRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.ChinRaiserUpperLip": { "documentation": "Moves the upper lip when ChinRaiser is engaged and touching the upper lip.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#ChinRaiserUpperLip", "code_sample": "" }, "@roblox/globaltype/FaceControls.Corrugator": { "documentation": "Brings the left and right brows inward together.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#Corrugator", "code_sample": "" }, "@roblox/globaltype/FaceControls.EyesLookDown": { "documentation": "Moves gaze down. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookDown", "code_sample": "" }, "@roblox/globaltype/FaceControls.EyesLookLeft": { "documentation": "Moves gaze left. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookLeft", "code_sample": "" }, "@roblox/globaltype/FaceControls.EyesLookRight": { "documentation": "Moves gaze right. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookRight", "code_sample": "" }, "@roblox/globaltype/FaceControls.EyesLookUp": { "documentation": "Moves gaze up. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#EyesLookUp", "code_sample": "" }, "@roblox/globaltype/FaceControls.FlatPucker": { "documentation": "Also known as lip tightener; brings the corners of the mouth inward and pressing the lips back against the teeth.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#FlatPucker", "code_sample": "" }, "@roblox/globaltype/FaceControls.Funneler": { "documentation": "Makes a 'O' shape with the mouth.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#Funneler", "code_sample": "" }, "@roblox/globaltype/FaceControls.JawDrop": { "documentation": "Lowers the jaw downward opening the mouth. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#JawDrop", "code_sample": "" }, "@roblox/globaltype/FaceControls.JawLeft": { "documentation": "Moves mouth and jaw to the left (character left).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#JawLeft", "code_sample": "" }, "@roblox/globaltype/FaceControls.JawRight": { "documentation": "Moves mouth and jaw to the right (character right).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#JawRight", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftBrowLowerer": { "documentation": "Lowers the left brow down.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftBrowLowerer", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftCheekPuff": { "documentation": "Puffs up the left cheek.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftCheekPuff", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftCheekRaiser": { "documentation": "Squints the left eye.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftCheekRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftDimpler": { "documentation": "Moves the corners of the mouth back in Z.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftDimpler", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftEyeClosed": { "documentation": "Closes the left eyelid. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftEyeClosed", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftEyeUpperLidRaiser": { "documentation": "Raises the left eyelid upwards to reveal more of the eye white above the iris.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftEyeUpperLidRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftInnerBrowRaiser": { "documentation": "Raises the interior half of the left brow upwards.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftInnerBrowRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftLipCornerDown": { "documentation": "Lowers the corners of the mouth downwards in a frown.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLipCornerDown", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftLipCornerPuller": { "documentation": "Raises the corners of the mouth upwards in a smile. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLipCornerPuller", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftLipStretcher": { "documentation": "Stretches the corners of the mouth apart. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLipStretcher", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftLowerLipDepressor": { "documentation": "Lowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftLowerLipDepressor", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftNoseWrinkler": { "documentation": "Raise the left nostril, pulls the brow down slightly, and wrinkles on the side of the nose.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftNoseWrinkler", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftOuterBrowRaiser": { "documentation": "Raises the outer part of the left brow upwards.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftOuterBrowRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.LeftUpperLipRaiser": { "documentation": "Raises the left upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LeftUpperLipRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.LipPresser": { "documentation": "Presses the lips together.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LipPresser", "code_sample": "" }, "@roblox/globaltype/FaceControls.LipsTogether": { "documentation": "Brings the lips together relative to JawDrop. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LipsTogether", "code_sample": "" }, "@roblox/globaltype/FaceControls.LowerLipSuck": { "documentation": "Rolls the lower lip up over the teeth.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#LowerLipSuck", "code_sample": "" }, "@roblox/globaltype/FaceControls.MouthLeft": { "documentation": "Moves the mouth left.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#MouthLeft", "code_sample": "" }, "@roblox/globaltype/FaceControls.MouthRight": { "documentation": "Moves the mouth right.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#MouthRight", "code_sample": "" }, "@roblox/globaltype/FaceControls.Pucker": { "documentation": "Makes a kiss-like shape with the mouth. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#Pucker", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightBrowLowerer": { "documentation": "Lowers the right brow down.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightBrowLowerer", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightCheekPuff": { "documentation": "Puffs up the right cheek.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightCheekPuff", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightCheekRaiser": { "documentation": "Squints the right eye.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightCheekRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightDimpler": { "documentation": "Moves the corners of the mouth back in Z.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightDimpler", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightEyeClosed": { "documentation": "Closes the right eyelid. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightEyeClosed", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightEyeUpperLidRaiser": { "documentation": "Raises the right eyelid upwards to reveal more of the eye white above the iris.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightEyeUpperLidRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightInnerBrowRaiser": { "documentation": "Raises the interior half of the right brow upwards.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightInnerBrowRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightLipCornerDown": { "documentation": "Lowers the corners of the mouth downwards in a frown.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLipCornerDown", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightLipCornerPuller": { "documentation": "Raises the corners of the mouth upwards in a smile. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLipCornerPuller", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightLipStretcher": { "documentation": "Stretches the corners of the mouth apart. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLipStretcher", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightLowerLipDepressor": { "documentation": "Lowers the lower lip down away from the upper lip revealing the lower teeth. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightLowerLipDepressor", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightNoseWrinkler": { "documentation": "Raises the right nostril, pulls the brow down slightly, and wrinkles on the side of the nose.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightNoseWrinkler", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightOuterBrowRaiser": { "documentation": "Raises the outer part of the right brow upwards.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightOuterBrowRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.RightUpperLipRaiser": { "documentation": "Raises the right upper lip away from the lower lip revealing the upper teeth. This is a required pose for avatars.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#RightUpperLipRaiser", "code_sample": "" }, "@roblox/globaltype/FaceControls.TongueDown": { "documentation": "Bends the tongue down.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#TongueDown", "code_sample": "" }, "@roblox/globaltype/FaceControls.TongueOut": { "documentation": "Extends the tip of the tongue out of the mouth.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#TongueOut", "code_sample": "" }, "@roblox/globaltype/FaceControls.TongueUp": { "documentation": "Bends the tongue up.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#TongueUp", "code_sample": "" }, "@roblox/globaltype/FaceControls.UpperLipSuck": { "documentation": "Rolls the upper lip around the teeth.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FaceControls#UpperLipSuck", "code_sample": "" }, "@roblox/globaltype/SpawnerService": { "documentation": "An internal service that is responsible for the behavior of SpawnLocations. Its functionality is not accessible to developers.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpawnerService", "code_sample": "" }, "@roblox/globaltype/Smoke": { "documentation": "A particle emitter with the visual aesthetic of smoke.", "keys": { "Color": "@roblox/globaltype/Smoke.Color", "Enabled": "@roblox/globaltype/Smoke.Enabled", "LocalTransparencyModifier": "@roblox/globaltype/Smoke.LocalTransparencyModifier", "Opacity": "@roblox/globaltype/Smoke.Opacity", "RiseVelocity": "@roblox/globaltype/Smoke.RiseVelocity", "Size": "@roblox/globaltype/Smoke.Size", "TimeScale": "@roblox/globaltype/Smoke.TimeScale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke", "code_sample": "local function recurseForFire(object)\n\t-- Check if we found a Fire object that has no Smoke\n\tif object:IsA(\"Fire\") and not object.Parent:FindFirstChildOfClass(\"Smoke\") then\n\t\t-- Create a smoke effect for this fire\n\t\tlocal smoke = Instance.new(\"Smoke\")\n\t\tsmoke.Color = Color3.new(0, 0, 0)\n\t\tsmoke.Opacity = 0.15\n\t\tsmoke.RiseVelocity = 4\n\t\tsmoke.Size = object.Size / 4\n\t\tsmoke.Parent = object.Parent\n\tend\n\t-- Continue search for Fire objects\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecurseForFire(child)\n\tend\nend\n\nrecurseForFire(workspace)" }, "@roblox/globaltype/Smoke.Color": { "documentation": "Determines the color of the smoke particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#Color", "code_sample": "local function recurseForFire(object)\n\t-- Check if we found a Fire object that has no Smoke\n\tif object:IsA(\"Fire\") and not object.Parent:FindFirstChildOfClass(\"Smoke\") then\n\t\t-- Create a smoke effect for this fire\n\t\tlocal smoke = Instance.new(\"Smoke\")\n\t\tsmoke.Color = Color3.new(0, 0, 0)\n\t\tsmoke.Opacity = 0.15\n\t\tsmoke.RiseVelocity = 4\n\t\tsmoke.Size = object.Size / 4\n\t\tsmoke.Parent = object.Parent\n\tend\n\t-- Continue search for Fire objects\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecurseForFire(child)\n\tend\nend\n\nrecurseForFire(workspace)" }, "@roblox/globaltype/Smoke.Enabled": { "documentation": "Determines whether smoke particles emit.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#Enabled", "code_sample": "local function recurseForFire(object)\n\t-- Check if we found a Fire object that has no Smoke\n\tif object:IsA(\"Fire\") and not object.Parent:FindFirstChildOfClass(\"Smoke\") then\n\t\t-- Create a smoke effect for this fire\n\t\tlocal smoke = Instance.new(\"Smoke\")\n\t\tsmoke.Color = Color3.new(0, 0, 0)\n\t\tsmoke.Opacity = 0.15\n\t\tsmoke.RiseVelocity = 4\n\t\tsmoke.Size = object.Size / 4\n\t\tsmoke.Parent = object.Parent\n\tend\n\t-- Continue search for Fire objects\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecurseForFire(child)\n\tend\nend\n\nrecurseForFire(workspace)" }, "@roblox/globaltype/Smoke.LocalTransparencyModifier": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Smoke.Opacity": { "documentation": "Determines how opaque smoke particles render.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#Opacity", "code_sample": "local function recurseForFire(object)\n\t-- Check if we found a Fire object that has no Smoke\n\tif object:IsA(\"Fire\") and not object.Parent:FindFirstChildOfClass(\"Smoke\") then\n\t\t-- Create a smoke effect for this fire\n\t\tlocal smoke = Instance.new(\"Smoke\")\n\t\tsmoke.Color = Color3.new(0, 0, 0)\n\t\tsmoke.Opacity = 0.15\n\t\tsmoke.RiseVelocity = 4\n\t\tsmoke.Size = object.Size / 4\n\t\tsmoke.Parent = object.Parent\n\tend\n\t-- Continue search for Fire objects\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecurseForFire(child)\n\tend\nend\n\nrecurseForFire(workspace)" }, "@roblox/globaltype/Smoke.RiseVelocity": { "documentation": "Determines the velocity of the smoke particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#RiseVelocity", "code_sample": "local function recurseForFire(object)\n\t-- Check if we found a Fire object that has no Smoke\n\tif object:IsA(\"Fire\") and not object.Parent:FindFirstChildOfClass(\"Smoke\") then\n\t\t-- Create a smoke effect for this fire\n\t\tlocal smoke = Instance.new(\"Smoke\")\n\t\tsmoke.Color = Color3.new(0, 0, 0)\n\t\tsmoke.Opacity = 0.15\n\t\tsmoke.RiseVelocity = 4\n\t\tsmoke.Size = object.Size / 4\n\t\tsmoke.Parent = object.Parent\n\tend\n\t-- Continue search for Fire objects\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecurseForFire(child)\n\tend\nend\n\nrecurseForFire(workspace)" }, "@roblox/globaltype/Smoke.Size": { "documentation": "Determines the size of newly emit smoke particles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#Size", "code_sample": "local function recurseForFire(object)\n\t-- Check if we found a Fire object that has no Smoke\n\tif object:IsA(\"Fire\") and not object.Parent:FindFirstChildOfClass(\"Smoke\") then\n\t\t-- Create a smoke effect for this fire\n\t\tlocal smoke = Instance.new(\"Smoke\")\n\t\tsmoke.Color = Color3.new(0, 0, 0)\n\t\tsmoke.Opacity = 0.15\n\t\tsmoke.RiseVelocity = 4\n\t\tsmoke.Size = object.Size / 4\n\t\tsmoke.Parent = object.Parent\n\tend\n\t-- Continue search for Fire objects\n\tfor _, child in pairs(object:GetChildren()) do\n\t\trecurseForFire(child)\n\tend\nend\n\nrecurseForFire(workspace)" }, "@roblox/globaltype/Smoke.TimeScale": { "documentation": "Value between 0-1 that controls the speed of the particle effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Smoke#TimeScale", "code_sample": "" }, "@roblox/globaltype/StarterPlayerScripts": { "documentation": "A container for objects to be copied to a Player's PlayerScripts when they join a game.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/StarterPlayerScripts", "code_sample": "" }, "@roblox/globaltype/ControllerBase": { "documentation": "", "keys": { "Active": "@roblox/globaltype/ControllerBase.Active", "BalanceRigidityEnabled": "@roblox/globaltype/ControllerBase.BalanceRigidityEnabled", "MoveSpeedFactor": "@roblox/globaltype/ControllerBase.MoveSpeedFactor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerBase", "code_sample": "" }, "@roblox/globaltype/ControllerBase.Active": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerBase#Active", "code_sample": "" }, "@roblox/globaltype/ControllerBase.BalanceRigidityEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerBase#BalanceRigidityEnabled", "code_sample": "" }, "@roblox/globaltype/ControllerBase.MoveSpeedFactor": { "documentation": "The value multiplied by the ControllerManager.BaseMoveSpeed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ControllerBase#MoveSpeedFactor", "code_sample": "" }, "@roblox/globaltype/AudioEmitter": { "documentation": "Emits audio streams into the world.", "keys": { "AcousticSimulationEnabled": "@roblox/globaltype/AudioEmitter.AcousticSimulationEnabled", "AngleAttenuation": "@roblox/globaltype/AudioEmitter.AngleAttenuation", "AudioInteractionGroup": "@roblox/globaltype/AudioEmitter.AudioInteractionGroup", "DistanceAttenuation": "@roblox/globaltype/AudioEmitter.DistanceAttenuation", "PositionOverride": "@roblox/globaltype/AudioEmitter.PositionOverride", "SimulationFidelity": "@roblox/globaltype/AudioEmitter.SimulationFidelity", "GetAngleAttenuation": "@roblox/globaltype/AudioEmitter.GetAngleAttenuation", "GetAudibilityFor": "@roblox/globaltype/AudioEmitter.GetAudibilityFor", "GetConnectedWires": "@roblox/globaltype/AudioEmitter.GetConnectedWires", "GetDistanceAttenuation": "@roblox/globaltype/AudioEmitter.GetDistanceAttenuation", "GetInputPins": "@roblox/globaltype/AudioEmitter.GetInputPins", "GetInteractingListeners": "@roblox/globaltype/AudioEmitter.GetInteractingListeners", "GetOutputPins": "@roblox/globaltype/AudioEmitter.GetOutputPins", "SetAngleAttenuation": "@roblox/globaltype/AudioEmitter.SetAngleAttenuation", "SetDistanceAttenuation": "@roblox/globaltype/AudioEmitter.SetDistanceAttenuation" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter", "code_sample": "local part1: BasePart = workspace.Speakers.Left\nlocal part2: BasePart = workspace.Speakers.Right\nlocal player: AudioPlayer = workspace.AudioPlayer\n\nlocal leftEmitter = Instance.new(\"AudioEmitter\")\nlocal rightEmitter = Instance.new(\"AudioEmitter\")\nlocal toLeft = Instance.new(\"Wire\")\nlocal toRight = Instance.new(\"Wire\")\n\nleftEmitter.Parent = part1\nrightEmitter.Parent = part2\n\ntoLeft.Parent = leftEmitter\ntoLeft.SourceInstance = player\ntoLeft.TargetInstance = leftEmitter\n\ntoRight.Parent = rightEmitter\ntoRight.SourceInstance = player\ntoRight.TargetInstance = rightEmitter\n\nplayer:Play()" }, "@roblox/globaltype/AudioEmitter.AcousticSimulationEnabled": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#AcousticSimulationEnabled", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.AngleAttenuation": { "documentation": "Represents how the perceived volume of the emitted sound changes based on the angle between a AudioListener and the LookVector associated with the AudioEmitter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#AngleAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.AudioInteractionGroup": { "documentation": "Controls which AudioListeners are capable of hearing this AudioEmitter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#AudioInteractionGroup", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.DistanceAttenuation": { "documentation": "Represents how the perceived volume of the emitted sound changes as the distance between a AudioListener and the AudioEmitter increases.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#DistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.PositionOverride": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#PositionOverride", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.SimulationFidelity": { "documentation": "Deprecated:
Controls how detailed the audio simulation should be for this AudioEmitter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SimulationFidelity", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetAngleAttenuation/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetAngleAttenuation/return/0": { "documentation": "Table mapping angle to volume, as described above." }, "@roblox/globaltype/AudioEmitter.GetAngleAttenuation": { "documentation": "Gets the angle attenuation curve that the AudioEmitter is using, or an empty table if it's using the default curve.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetAngleAttenuation/param/0" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetAngleAttenuation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetAngleAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetAudibilityFor/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetAudibilityFor/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetAudibilityFor/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetAudibilityFor": { "documentation": "Calculates how audible this emitter is for a particular AudioListener.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetAudibilityFor/param/0" }, { "name": "listener", "documentation": "@roblox/globaltype/AudioEmitter.GetAudibilityFor/param/1" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetAudibilityFor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetAudibilityFor", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetConnectedWires/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioEmitter.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetDistanceAttenuation/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetDistanceAttenuation/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetDistanceAttenuation": { "documentation": "Gets the distance attenuation curve that the AudioEmitter is using, or an empty table if it's using the default curve.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetDistanceAttenuation/param/0" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetDistanceAttenuation/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetDistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetInputPins/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetInteractingListeners/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetInteractingListeners/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetInteractingListeners": { "documentation": "Lists all AudioListeners that are capable of hearing this emitter.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetInteractingListeners/param/0" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetInteractingListeners/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetInteractingListeners", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.GetOutputPins/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioEmitter.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.SetAngleAttenuation/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.SetAngleAttenuation/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.SetAngleAttenuation": { "documentation": "Sets the angle attenuation curve that the AudioEmitter should use, or uses a constant curve of volume 1 if none is provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.SetAngleAttenuation/param/0" }, { "name": "curve", "documentation": "@roblox/globaltype/AudioEmitter.SetAngleAttenuation/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SetAngleAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.SetDistanceAttenuation/param/0": { "documentation": "Emits audio streams into the world." }, "@roblox/globaltype/AudioEmitter.SetDistanceAttenuation/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.SetDistanceAttenuation": { "documentation": "Sets the distance attenuation curve that the AudioEmitter should use, or uses an inverse rolloff curve if none is provided.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.SetDistanceAttenuation/param/0" }, { "name": "curve", "documentation": "@roblox/globaltype/AudioEmitter.SetDistanceAttenuation/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#SetDistanceAttenuation", "code_sample": "" }, "@roblox/globaltype/AudioEmitter.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEmitter.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEmitter.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEmitter.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEmitter.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEmitter.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioEmitter.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioEmitter.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioEmitter.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioEmitter.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioEmitter.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioEmitter via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioEmitter.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioEmitter.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioEmitter.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioEmitter.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#WiringChanged", "code_sample": "" }, "@roblox/globaltype/DoubleConstrainedValue": { "documentation": "Deprecated: The DoubleConstrainedValue object has been deprecated as developers can now use the math.clamp() function to constrain values.
An instance which is used to create a number value which can never be less than the MinValue or more than the MaxValue.", "keys": { "ConstrainedValue": "@roblox/globaltype/DoubleConstrainedValue.ConstrainedValue", "MaxValue": "@roblox/globaltype/DoubleConstrainedValue.MaxValue", "MinValue": "@roblox/globaltype/DoubleConstrainedValue.MinValue", "Value": "@roblox/globaltype/DoubleConstrainedValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue", "code_sample": "" }, "@roblox/globaltype/DoubleConstrainedValue.ConstrainedValue": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue#ConstrainedValue", "code_sample": "" }, "@roblox/globaltype/DoubleConstrainedValue.MaxValue": { "documentation": "The highest number that the DoubleConstrainedValue.Value property can be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue#MaxValue", "code_sample": "" }, "@roblox/globaltype/DoubleConstrainedValue.MinValue": { "documentation": "The lowest number that the DoubleConstrainedValue.Value property can be.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue#MinValue", "code_sample": "" }, "@roblox/globaltype/DoubleConstrainedValue.Value": { "documentation": "Used to hold a number value between DoubleConstrainedValue.MinValue and DoubleConstrainedValue.MaxValue.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue#Value", "code_sample": "" }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DoubleConstrainedValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.Changed": { "documentation": "Fired whenever the DoubleConstrainedValue.Value of the DoubleConstrainedValue is changed.", "keys": { "Connect": "@roblox/globaltype/DoubleConstrainedValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/DoubleConstrainedValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/DoubleConstrainedValue.Changed.Once", "Wait": "@roblox/globaltype/DoubleConstrainedValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue#Changed", "code_sample": "workspace.DoubleConstrainedValue.Changed:Connect(function(newValue)\n\tprint(newValue)\nend)\n\nworkspace.DoubleConstrainedValue.Value = 2" }, "@roblox/globaltype/DoubleConstrainedValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/DoubleConstrainedValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/DoubleConstrainedValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/DoubleConstrainedValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/DoubleConstrainedValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/DoubleConstrainedValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/DoubleConstrainedValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of DoubleConstrainedValue.Changed which has also been deprecated. Neither event should be used in new work.", "keys": { "Connect": "@roblox/globaltype/DoubleConstrainedValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/DoubleConstrainedValue.changed.ConnectParallel", "Once": "@roblox/globaltype/DoubleConstrainedValue.changed.Once", "Wait": "@roblox/globaltype/DoubleConstrainedValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DoubleConstrainedValue#changed", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration": { "documentation": "Configures properties of the optional channel tabs in the default chat window.", "keys": { "AbsolutePosition": "@roblox/globaltype/ChannelTabsConfiguration.AbsolutePosition", "AbsoluteSize": "@roblox/globaltype/ChannelTabsConfiguration.AbsoluteSize", "BackgroundColor3": "@roblox/globaltype/ChannelTabsConfiguration.BackgroundColor3", "BackgroundTransparency": "@roblox/globaltype/ChannelTabsConfiguration.BackgroundTransparency", "Enabled": "@roblox/globaltype/ChannelTabsConfiguration.Enabled", "FontFace": "@roblox/globaltype/ChannelTabsConfiguration.FontFace", "HoverBackgroundColor3": "@roblox/globaltype/ChannelTabsConfiguration.HoverBackgroundColor3", "SelectedTabTextColor3": "@roblox/globaltype/ChannelTabsConfiguration.SelectedTabTextColor3", "TextColor3": "@roblox/globaltype/ChannelTabsConfiguration.TextColor3", "TextSize": "@roblox/globaltype/ChannelTabsConfiguration.TextSize", "TextStrokeColor3": "@roblox/globaltype/ChannelTabsConfiguration.TextStrokeColor3", "TextStrokeTransparency": "@roblox/globaltype/ChannelTabsConfiguration.TextStrokeTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.AbsolutePosition": { "documentation": "Actual screen position of the channel tab bar, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#AbsolutePosition", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.AbsoluteSize": { "documentation": "Actual screen size of the channel tab bar, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#AbsoluteSize", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.BackgroundColor3": { "documentation": "Background color of the channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#BackgroundColor3", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.BackgroundTransparency": { "documentation": "Background transparency of the channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#BackgroundTransparency", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.Enabled": { "documentation": "Whether to show the channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#Enabled", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.FontFace": { "documentation": "Font used to render text in the channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#FontFace", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.HoverBackgroundColor3": { "documentation": "Background color of a channel tab when hovering over it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#HoverBackgroundColor3", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.SelectedTabTextColor3": { "documentation": "Color of text in a selected tab.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#SelectedTabTextColor3", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.TextColor3": { "documentation": "Color of text in an unselected tab.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#TextColor3", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.TextSize": { "documentation": "Size of the text in channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#TextSize", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.TextStrokeColor3": { "documentation": "Color of the text stroke for text in channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#TextStrokeColor3", "code_sample": "" }, "@roblox/globaltype/ChannelTabsConfiguration.TextStrokeTransparency": { "documentation": "Transparency of the text stroke for text in channel tabs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ChannelTabsConfiguration#TextStrokeTransparency", "code_sample": "" }, "@roblox/globaltype/TeleportService": { "documentation": "Enables transporting Players between places and servers.", "keys": { "CustomizedTeleportUI": "@roblox/globaltype/TeleportService.CustomizedTeleportUI", "GetArrivingTeleportGui": "@roblox/globaltype/TeleportService.GetArrivingTeleportGui", "GetLocalPlayerTeleportData": "@roblox/globaltype/TeleportService.GetLocalPlayerTeleportData", "GetPlayerPlaceInstanceAsync": "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync", "GetTeleportSetting": "@roblox/globaltype/TeleportService.GetTeleportSetting", "PromptExperienceDetailsAsync": "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync", "ReserveServerAsync": "@roblox/globaltype/TeleportService.ReserveServerAsync", "ReserveServer": "@roblox/globaltype/TeleportService.ReserveServer", "SetTeleportGui": "@roblox/globaltype/TeleportService.SetTeleportGui", "SetTeleportSetting": "@roblox/globaltype/TeleportService.SetTeleportSetting", "Teleport": "@roblox/globaltype/TeleportService.Teleport", "TeleportAsync": "@roblox/globaltype/TeleportService.TeleportAsync", "TeleportPartyAsync": "@roblox/globaltype/TeleportService.TeleportPartyAsync", "TeleportToPlaceInstance": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance", "TeleportToPrivateServer": "@roblox/globaltype/TeleportService.TeleportToPrivateServer", "TeleportToSpawnByName": "@roblox/globaltype/TeleportService.TeleportToSpawnByName" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService", "code_sample": "" }, "@roblox/globaltype/TeleportService.CustomizedTeleportUI": { "documentation": "Deprecated: This item is deprecated since the default message it controls has been removed. Do not use it for new work.
No longer functional.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#CustomizedTeleportUI", "code_sample": "" }, "@roblox/globaltype/TeleportService.GetArrivingTeleportGui/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.GetArrivingTeleportGui/return/0": { "documentation": "The customLoadingScreen the LocalPlayer arrived into the place with." }, "@roblox/globaltype/TeleportService.GetArrivingTeleportGui": { "documentation": "Returns the customLoadingScreen the LocalPlayer arrived into the place with.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.GetArrivingTeleportGui/param/0" } ], "returns": [ "@roblox/globaltype/TeleportService.GetArrivingTeleportGui/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetArrivingTeleportGui", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\nlocal Players = game:GetService(\"Players\")\nlocal ReplicatedFirst = game:GetService(\"ReplicatedFirst\")\n\nlocal customLoadingScreen = TeleportService:GetArrivingTeleportGui()\nif customLoadingScreen then\n\tlocal playerGui = Players.LocalPlayer:WaitForChild(\"PlayerGui\")\n\tReplicatedFirst:RemoveDefaultLoadingScreen()\n\tcustomLoadingScreen.Parent = playerGui\n\ttask.wait(5)\n\tcustomLoadingScreen:Destroy()\nend" }, "@roblox/globaltype/TeleportService.GetLocalPlayerTeleportData/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.GetLocalPlayerTeleportData/return/0": { "documentation": "The teleport data the Players.LocalPlayer arrived into the place with." }, "@roblox/globaltype/TeleportService.GetLocalPlayerTeleportData": { "documentation": "Returns the teleportData the Players.LocalPlayer arrived into the place with.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.GetLocalPlayerTeleportData/param/0" } ], "returns": [ "@roblox/globaltype/TeleportService.GetLocalPlayerTeleportData/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetLocalPlayerTeleportData", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\n\nlocal teleportData = TeleportService:GetLocalPlayerTeleportData()\n\nprint(\"Local player arrived with this data:\", teleportData)" }, "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync/param/1": { "documentation": "The Player.UserId of the Player." }, "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync/return/0": { "documentation": "See the table above." }, "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync": { "documentation": "Returns the PlaceId and JobId of the server the user with the given UserId is in provided it is in the same game as the current place.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync/param/1" } ], "returns": [ "@roblox/globaltype/TeleportService.GetPlayerPlaceInstanceAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetPlayerPlaceInstanceAsync", "code_sample": "" }, "@roblox/globaltype/TeleportService.GetTeleportSetting/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.GetTeleportSetting/param/1": { "documentation": "The key the value was stored under using TeleportService:SetTeleportSetting()." }, "@roblox/globaltype/TeleportService.GetTeleportSetting/return/0": { "documentation": "The value stored under the given key." }, "@roblox/globaltype/TeleportService.GetTeleportSetting": { "documentation": "Retrieves a teleport setting saved using TeleportService:SetTeleportSetting() using the given key.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.GetTeleportSetting/param/0" }, { "name": "setting", "documentation": "@roblox/globaltype/TeleportService.GetTeleportSetting/param/1" } ], "returns": [ "@roblox/globaltype/TeleportService.GetTeleportSetting/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetTeleportSetting", "code_sample": "" }, "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/param/1": { "documentation": "The Player to be presented the prompt." }, "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/param/2": { "documentation": "DataModel.UniverseId of the experience to be presented to the Player" }, "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/return/0": { "documentation": "PromptExperienceDetailsResult" }, "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync": { "documentation": "Prompts a Player with information about the specified experience. The player can choose to teleport to the target experience through the prompt.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/param/1" }, { "name": "universeId", "documentation": "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/param/2" } ], "returns": [ "@roblox/globaltype/TeleportService.PromptExperienceDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#PromptExperienceDetailsAsync", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\nlocal success, result = pcall(function()\n\tTeleportService:PromptExperienceDetailsAsync(player, 8357232245)\nend)\nif not success then\n\twarn(\"Error prompting experience details: \" .. tostring(result))\nend\n\nif result == Enum.PromptExperienceDetailsResult.PromptClosed then\n\tprint(\"Player closed the experience details prompt\")\nelseif result == Enum.PromptExperienceDetailsResult.TeleportAttempted then\n\tprint(\"Player chose to teleport to the experience\")\nend" }, "@roblox/globaltype/TeleportService.ReserveServerAsync/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.ReserveServerAsync/param/1": { "documentation": "The DataModel.PlaceId of the place the reserved server is being created for." }, "@roblox/globaltype/TeleportService.ReserveServerAsync/return/0": { "documentation": "The server access code required by TeleportService:TeleportToPrivateServer() and the DataModel.PrivateServerId for the reserved server." }, "@roblox/globaltype/TeleportService.ReserveServerAsync": { "documentation": "Returns an access code that can be used to teleport players to a reserved server, along with the DataModel.PrivateServerId for it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.ReserveServerAsync/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.ReserveServerAsync/param/1" } ], "returns": [ "@roblox/globaltype/TeleportService.ReserveServerAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServerAsync", "code_sample": "" }, "@roblox/globaltype/TeleportService.ReserveServer/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.ReserveServer/param/1": { "documentation": "The DataModel.PlaceId of the place the reserved server is being created for." }, "@roblox/globaltype/TeleportService.ReserveServer/return/0": { "documentation": "The server access code required by TeleportService:TeleportToPrivateServer() and the DataModel.PrivateServerId for the reserved server." }, "@roblox/globaltype/TeleportService.ReserveServer": { "documentation": "Deprecated:
Returns an access code that can be used to teleport players to a reserved server, along with the DataModel.PrivateServerId for it.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.ReserveServer/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.ReserveServer/param/1" } ], "returns": [ "@roblox/globaltype/TeleportService.ReserveServer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServer", "code_sample": "" }, "@roblox/globaltype/TeleportService.SetTeleportGui/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.SetTeleportGui/param/1": { "documentation": "The loading ScreenGui that is to be displayed during teleportation." }, "@roblox/globaltype/TeleportService.SetTeleportGui": { "documentation": "Sets the custom teleport GUI that will be shown to the local user during teleportation, prior to the teleport being invoked.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.SetTeleportGui/param/0" }, { "name": "gui", "documentation": "@roblox/globaltype/TeleportService.SetTeleportGui/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#SetTeleportGui", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal Players = game:GetService(\"Players\")\n\nlocal playerGui = Players.LocalPlayer:WaitForChild(\"PlayerGui\")\n\nlocal PLACE_ID = 0 -- replace here\nlocal loadingGui = ReplicatedStorage:FindFirstChild(\"LoadingGui\")\n\n-- parent the loading gui for this place\nloadingGui.Parent = playerGui\n\n-- set the loading gui for the destination place\nTeleportService:SetTeleportGui(loadingGui)\n\nTeleportService:Teleport(PLACE_ID)" }, "@roblox/globaltype/TeleportService.SetTeleportSetting/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.SetTeleportSetting/param/1": { "documentation": "The key to store the value under. This key can be used to retrieve the value using TeleportService:GetTeleportSetting()." }, "@roblox/globaltype/TeleportService.SetTeleportSetting/param/2": { "documentation": "The value to store." }, "@roblox/globaltype/TeleportService.SetTeleportSetting": { "documentation": "Stores a value under a given key that persists across all teleportations in the same game.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.SetTeleportSetting/param/0" }, { "name": "setting", "documentation": "@roblox/globaltype/TeleportService.SetTeleportSetting/param/1" }, { "name": "value", "documentation": "@roblox/globaltype/TeleportService.SetTeleportSetting/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#SetTeleportSetting", "code_sample": "" }, "@roblox/globaltype/TeleportService.Teleport/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.Teleport/param/1": { "documentation": "The ID of the place to teleport to." }, "@roblox/globaltype/TeleportService.Teleport/param/2": { "documentation": "The Player to teleport, if this function is being called from the client this defaults to the Players.LocalPlayer." }, "@roblox/globaltype/TeleportService.Teleport/param/3": { "documentation": "Optional data to be passed to the destination place. Can be retrieved using TeleportService:GetLocalPlayerTeleportData()." }, "@roblox/globaltype/TeleportService.Teleport/param/4": { "documentation": "Optional custom loading screen to be placed in the CoreGui at the destination place. Can be retrieved using TeleportService:GetArrivingTeleportGui()." }, "@roblox/globaltype/TeleportService.Teleport": { "documentation": "Teleports a Player to the place associated with the given placeId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.Teleport/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.Teleport/param/1" }, { "name": "player", "documentation": "@roblox/globaltype/TeleportService.Teleport/param/2" }, { "name": "teleportData", "documentation": "@roblox/globaltype/TeleportService.Teleport/param/3" }, { "name": "customLoadingScreen", "documentation": "@roblox/globaltype/TeleportService.Teleport/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#Teleport", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal Players = game:GetService(\"Players\")\n\nlocal playerGui = Players.LocalPlayer:WaitForChild(\"PlayerGui\")\n\nlocal PLACE_ID = 0 -- replace here\nlocal loadingGui = ReplicatedStorage:FindFirstChild(\"LoadingGui\")\n\n-- parent the loading gui for this place\nloadingGui.Parent = playerGui\n\n-- set the loading gui for the destination place\nTeleportService:SetTeleportGui(loadingGui)\n\nTeleportService:Teleport(PLACE_ID)" }, "@roblox/globaltype/TeleportService.TeleportAsync/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.TeleportAsync/param/1": { "documentation": "The place ID the player(s) should be teleported to." }, "@roblox/globaltype/TeleportService.TeleportAsync/param/2": { "documentation": "An array of the player(s) to teleport." }, "@roblox/globaltype/TeleportService.TeleportAsync/param/3": { "documentation": "An optional TeleportOptions object containing additional arguments to the TeleportService:TeleportAsync() call. If this is not passed, no result will be returned." }, "@roblox/globaltype/TeleportService.TeleportAsync/return/0": { "documentation": "If a TeleportOptions parameter is passed, this will be a TeleportAsyncResult object that provides information about the final teleport destination." }, "@roblox/globaltype/TeleportService.TeleportAsync": { "documentation": "The all-encompassing method to teleport a player or group of players from one server to another.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportAsync/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.TeleportAsync/param/1" }, { "name": "players", "documentation": "@roblox/globaltype/TeleportService.TeleportAsync/param/2" }, { "name": "teleportOptions", "documentation": "@roblox/globaltype/TeleportService.TeleportAsync/param/3" } ], "returns": [ "@roblox/globaltype/TeleportService.TeleportAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportAsync", "code_sample": "" }, "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/1": { "documentation": "The ID of the place to teleport to." }, "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/2": { "documentation": "An array containing the Players to teleport." }, "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/3": { "documentation": "Optional data to be passed to the destination place. Can be retrieved using TeleportService:GetLocalPlayerTeleportData()." }, "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/4": { "documentation": "Optional custom loading screen to be placed in the CoreGui at the destination place. Can be retrieved using TeleportService:GetArrivingTeleportGui()." }, "@roblox/globaltype/TeleportService.TeleportPartyAsync/return/0": { "documentation": "The DataModel.JobId of the server instance the Players were teleported to." }, "@roblox/globaltype/TeleportService.TeleportPartyAsync": { "documentation": "Teleports a group of Players to the same server of the place with the given PlaceId, returning the JobId of the server instance they were teleported to.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/1" }, { "name": "players", "documentation": "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/2" }, { "name": "teleportData", "documentation": "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/3" }, { "name": "customLoadingScreen", "documentation": "@roblox/globaltype/TeleportService.TeleportPartyAsync/param/4" } ], "returns": [ "@roblox/globaltype/TeleportService.TeleportPartyAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportPartyAsync", "code_sample": "local Players = game:GetService(\"Players\")\nlocal TeleportService = game:GetService(\"TeleportService\")\n\nlocal PLACE_ID = 0 -- replace\nlocal playerList = Players:GetPlayers()\n\nlocal success, result = pcall(function()\n\treturn TeleportService:TeleportPartyAsync(PLACE_ID, playerList)\nend)\n\nif success then\n\tlocal jobId = result\n\tprint(\"Players teleported to\", jobId)\nelse\n\twarn(result)\nend" }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/1": { "documentation": "The ID of the place to teleport to." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/2": { "documentation": "The DataModel.JobId of the server instance to teleport to." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/3": { "documentation": "The Player to teleport, if this function is being called from the client this defaults to the Players.LocalPlayer." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/4": { "documentation": "Optional name of the SpawnLocation to spawn at." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/5": { "documentation": "Optional data to be passed to the destination place. Can be retrieved using TeleportService:GetLocalPlayerTeleportData()." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/6": { "documentation": "Optional custom loading screen to be placed in the CoreGui at the destination place. Can be retrieved using TeleportService:GetArrivingTeleportGui()." }, "@roblox/globaltype/TeleportService.TeleportToPlaceInstance": { "documentation": "Teleports a Player to the server instance associated with the given placeId and instanceId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/1" }, { "name": "instanceId", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/2" }, { "name": "player", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/3" }, { "name": "spawnName", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/4" }, { "name": "teleportData", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/5" }, { "name": "customLoadingScreen", "documentation": "@roblox/globaltype/TeleportService.TeleportToPlaceInstance/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPlaceInstance", "code_sample": "" }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/1": { "documentation": "The ID of the place to teleport to." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/2": { "documentation": "The reserved server access code returned by TeleportService:ReserveServerAsync()." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/3": { "documentation": "An array of Players to teleport." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/4": { "documentation": "Optional name of the SpawnLocation to spawn at." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/5": { "documentation": "Optional data to be passed to the destination place. Can be retrieved using TeleportService:GetLocalPlayerTeleportData()." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/6": { "documentation": "Optional custom loading screen to be placed in the CoreGui at the destination place. Can be retrieved using TeleportService:GetArrivingTeleportGui()." }, "@roblox/globaltype/TeleportService.TeleportToPrivateServer": { "documentation": "Teleport a group of Players to a reserved server created using TeleportService:ReserveServerAsync().", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/1" }, { "name": "reservedServerAccessCode", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/2" }, { "name": "players", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/3" }, { "name": "spawnName", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/4" }, { "name": "teleportData", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/5" }, { "name": "customLoadingScreen", "documentation": "@roblox/globaltype/TeleportService.TeleportToPrivateServer/param/6" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPrivateServer", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\nlocal Players = game:GetService(\"Players\")\nlocal DataStoreService = game:GetService(\"DataStoreService\")\n\nlocal dataStore = DataStoreService:GetGlobalDataStore()\n\n-- Get the saved code\nlocal code = dataStore:GetAsync(\"ReservedServer\")\nif typeof(code) ~= \"string\" then -- None saved, create one\n\tcode = TeleportService:ReserveServerAsync(game.PlaceId)\n\tdataStore:SetAsync(\"ReservedServer\", code)\nend\n\nlocal function joined(player)\n\tplayer.Chatted:Connect(function(message)\n\t\tif message == \"reserved\" then\n\t\t\tTeleportService:TeleportToPrivateServer(game.PlaceId, code, { player })\n\t\tend\n\tend)\nend\n\nPlayers.PlayerAdded:Connect(joined)" }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/0": { "documentation": "Enables transporting Players between places and servers." }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/1": { "documentation": "The ID of the place to teleport to." }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/2": { "documentation": "The name of the SpawnLocation to spawn at." }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/3": { "documentation": "The Player to teleport, if this function is being called from the client this defaults to the Players.LocalPlayer." }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/4": { "documentation": "Optional data to be passed to the destination place. Can be retrieved using TeleportService:GetLocalPlayerTeleportData()." }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/5": { "documentation": "Optional custom loading screen to be placed in the CoreGui at the destination place. Can be retrieved using TeleportService:GetArrivingTeleportGui()." }, "@roblox/globaltype/TeleportService.TeleportToSpawnByName": { "documentation": "A variant of TeleportService:Teleport() that causes the Player to spawn at a SpawnLocation of the given name at the destination place.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/0" }, { "name": "placeId", "documentation": "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/1" }, { "name": "spawnName", "documentation": "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/2" }, { "name": "player", "documentation": "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/3" }, { "name": "teleportData", "documentation": "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/4" }, { "name": "customLoadingScreen", "documentation": "@roblox/globaltype/TeleportService.TeleportToSpawnByName/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToSpawnByName", "code_sample": "local TeleportService = game:GetService(\"TeleportService\")\n\nTeleportService:TeleportToSpawnByName(1818, \"TeleportSpawn\")" }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport": { "documentation": "Fires when the LocalPlayer enters the place following a teleport.", "keys": { "Connect": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Connect", "ConnectParallel": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.ConnectParallel", "Once": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Once", "Wait": "@roblox/globaltype/TeleportService.LocalPlayerArrivedFromTeleport.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#LocalPlayerArrivedFromTeleport", "code_sample": "" }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TeleportService.TeleportInitFailed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.TeleportInitFailed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TeleportService.TeleportInitFailed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TeleportService.TeleportInitFailed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TeleportService.TeleportInitFailed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TeleportService.TeleportInitFailed": { "documentation": "Fires when a teleport fails to start, leaving the player in their current server.", "keys": { "Connect": "@roblox/globaltype/TeleportService.TeleportInitFailed.Connect", "ConnectParallel": "@roblox/globaltype/TeleportService.TeleportInitFailed.ConnectParallel", "Once": "@roblox/globaltype/TeleportService.TeleportInitFailed.Once", "Wait": "@roblox/globaltype/TeleportService.TeleportInitFailed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportInitFailed", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService": { "documentation": "A service to support developer avatar creators.", "keys": { "AutoSetupAvatarAsync": "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync", "GenerateAvatar2DPreviewAsync": "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync", "GenerateAvatarAsync": "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync", "GetBatchTokenDetailsAsync": "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync", "GetValidationRules": "@roblox/globaltype/AvatarCreationService.GetValidationRules", "LoadAvatar2DPreviewAsync": "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync", "LoadGeneratedAvatarAsync": "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync", "PrepareAvatarForPreviewAsync": "@roblox/globaltype/AvatarCreationService.PrepareAvatarForPreviewAsync", "PromptCreateAvatarAssetAsync": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync", "PromptCreateAvatarAsync": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync", "PromptSelectAvatarGenerationImageAsync": "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync", "RequestAvatarGenerationSessionAsync": "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync", "ValidateUGCAccessoryAsync": "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync", "ValidateUGCBodyPartAsync": "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync", "ValidateUGCFullBodyAsync": "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/1": { "documentation": "The Player that the avatar is being set up for." }, "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/2": { "documentation": "The humanoid Model that will be set up as an avatar." }, "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/3": { "documentation": "Optional callback function that will be invoked periodically with a progressInfo table with the overall progress (from 0 to 1). Type: (progressInfo: { Progress: number }) -> ()" }, "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/return/0": { "documentation": "A unique identifier for the generated avatar." }, "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync": { "documentation": "Automatically sets up a custom Model as an avatar asset.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/1" }, { "name": "model", "documentation": "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/2" }, { "name": "progressCallback", "documentation": "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/param/3" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.AutoSetupAvatarAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync/param/1": { "documentation": "A table of arguments for 2D preview generation. Type: avatarGeneration2dPreviewParams: {SessionId: string, FileId: string, TextPrompt: string?}" }, "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync/return/0": { "documentation": "A string previewId" }, "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync": { "documentation": "Creates a 2D avatar preview and returns a previewId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync/param/0" }, { "name": "avatarGeneration2dPreviewParams", "documentation": "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.GenerateAvatar2DPreviewAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatar2DPreviewAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync/param/1": { "documentation": "A table of arguments for generating an avatar. Type: avatarGenerationParams: {SessionId: string, PreviewId: string}" }, "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync/return/0": { "documentation": "A string generationId." }, "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync": { "documentation": "Generates an avatar and returns a generationId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync/param/0" }, { "name": "avatarGenerationParams", "documentation": "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.GenerateAvatarAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GenerateAvatarAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync/param/1": { "documentation": "The list of avatar creation token IDs to get details of." }, "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync/return/0": { "documentation": "Array of avatar creation token details as outlined above." }, "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync": { "documentation": "Gets the avatar creation token details for a list of avatar creation tokens at once.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync/param/0" }, { "name": "tokenIds", "documentation": "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.GetBatchTokenDetailsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GetBatchTokenDetailsAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.GetValidationRules/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.GetValidationRules/return/0": { "documentation": "Dictionary of validation rules as detailed above." }, "@roblox/globaltype/AvatarCreationService.GetValidationRules": { "documentation": "Gets data regarding rules that assets must abide by to pass UGC validation.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.GetValidationRules/param/0" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.GetValidationRules/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#GetValidationRules", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync/param/1": { "documentation": "Load the preview generated from GenerateAvatar2DPreviewAsync()." }, "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync/return/0": { "documentation": "An EditableImage containing the preview image." }, "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync": { "documentation": "Load an AvatarGeneration 2D preview on the client from a previewId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync/param/0" }, { "name": "previewId", "documentation": "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.LoadAvatar2DPreviewAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadAvatar2DPreviewAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync/param/1": { "documentation": "A unique string that identifies the generated avatar, as returned by AutoSetupAvatarAsync()." }, "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync/return/0": { "documentation": "The HumanoidDescription of the generated avatar, which includes all the generated instances and properties." }, "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync": { "documentation": "Loads a generated avatar using an avatar generation ID.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync/param/0" }, { "name": "generationId", "documentation": "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.LoadGeneratedAvatarAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#LoadGeneratedAvatarAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.PrepareAvatarForPreviewAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.PrepareAvatarForPreviewAsync/param/1": { "documentation": "The Model containing MeshPart children with WrapDeformer instances that require HSR data updating for preview." }, "@roblox/globaltype/AvatarCreationService.PrepareAvatarForPreviewAsync": { "documentation": "Prepares in-experience avatar for preview.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.PrepareAvatarForPreviewAsync/param/0" }, { "name": "humanoidModel", "documentation": "@roblox/globaltype/AvatarCreationService.PrepareAvatarForPreviewAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PrepareAvatarForPreviewAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/1": { "documentation": "The ID of a creation token. The token must be valid in that the universe the method is called from is the same universe the token was created for. Furthermore, the token creator must maintain ID verification and Roblox Premium. To create a token for utilization in this API, follow the token creation process. The token's creation type must match the AvatarAssetType passed in to the method." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/2": { "documentation": "The Player intended to be presented with the creation prompt." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/3": { "documentation": "The Instance of the avatar asset intended for creation." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/4": { "documentation": "The AvatarAssetType of the expected creation. This must match the creation type of the provided token." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync": { "documentation": "Prompts a Player to purchase and create an avatar asset from an Instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/0" }, { "name": "tokenId", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/1" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/2" }, { "name": "assetInstance", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/3" }, { "name": "assetType", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/param/4" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAssetAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateAvatarAssetAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/1": { "documentation": "The ID of an avatar creation token. The token must be valid in that the universe the method is called from is the same universe the token was created for. Furthermore, the token creator must maintain ID verification and Roblox Premium. To create a token for utilization in this API, follow the token creation process." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/2": { "documentation": "The Player intended to be presented with the creation prompt." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/3": { "documentation": "The HumanoidDescription of the avatar intended for creation." }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync": { "documentation": "Prompts a Player to purchase and create an avatar from a HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/0" }, { "name": "tokenId", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/1" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/2" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/param/3" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.PromptCreateAvatarAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptCreateAvatarAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync/param/1": { "documentation": "The Player to prompt for taking a selfie." }, "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync/return/0": { "documentation": "A string FileId of the selfie." }, "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync": { "documentation": "Prompt the Player to take a selfie and return the FileId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync/param/1" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.PromptSelectAvatarGenerationImageAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#PromptSelectAvatarGenerationImageAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/param/1": { "documentation": "The Player to request an AvatarGeneration session for." }, "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/param/2": { "documentation": "Callback function that is invoked with a SessionInfo table, with information about the session. Type: (SessionInfo: { SessionId: string, Allowed2DGenerations: number, Allowed3DGenerations: number, SessionTime: number }) -> ()" }, "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/return/0": { "documentation": "A tuple containing a RBXScriptConnection that can be used to cancel the session request and the estimated wait time in seconds." }, "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync": { "documentation": "Request an AvatarGeneration session for a Player.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/param/1" }, { "name": "callback", "documentation": "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.RequestAvatarGenerationSessionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#RequestAvatarGenerationSessionAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/1": { "documentation": "The Player validation is completed for." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/2": { "documentation": "The instance validation is run on." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/3": { "documentation": "AccessoryType the instance is expected to be. Expects Eyebrow, Eyelash, or Hair." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync": { "documentation": "Studio only. Runs UGC validation for an AccessoryType.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/1" }, { "name": "accessory", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/2" }, { "name": "accessoryType", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/param/3" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.ValidateUGCAccessoryAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#ValidateUGCAccessoryAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/1": { "documentation": "The Player validation is completed for." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/2": { "documentation": "The instance validation is run on." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/3": { "documentation": "BodyPart the instance is expected to be." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync": { "documentation": "Studio only. Runs UGC validation for an BodyPart.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/1" }, { "name": "instance", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/2" }, { "name": "bodyPart", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/param/3" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.ValidateUGCBodyPartAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#ValidateUGCBodyPartAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/param/0": { "documentation": "A service to support developer avatar creators." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/param/1": { "documentation": "The Player validation is completed for." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/param/2": { "documentation": "HumanoidDescription representing the body that validation is run on." }, "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/return/0": { "documentation": "A tuple containing, in order: " }, "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync": { "documentation": "Studio only. Runs UGC validation for a whole body.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/param/1" }, { "name": "humanoidDescription", "documentation": "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/param/2" } ], "returns": [ "@roblox/globaltype/AvatarCreationService.ValidateUGCFullBodyAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#ValidateUGCFullBodyAsync", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted": { "documentation": "Fires when an in-experience-created avatar asset's moderation status has been updated from pending.", "keys": { "Connect": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Once", "Wait": "@roblox/globaltype/AvatarCreationService.AvatarAssetModerationCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarAssetModerationCompleted", "code_sample": "" }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted": { "documentation": "Fires when an in-experience-created avatar's moderation status has been updated from pending.", "keys": { "Connect": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Connect", "ConnectParallel": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.ConnectParallel", "Once": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Once", "Wait": "@roblox/globaltype/AvatarCreationService.AvatarModerationCompleted.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AvatarModerationCompleted", "code_sample": "" }, "@roblox/globaltype/HeightmapImporterService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HeightmapImporterService", "code_sample": "" }, "@roblox/globaltype/TeamCreateService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TeamCreateService", "code_sample": "" }, "@roblox/globaltype/AudioChorus": { "documentation": "Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.", "keys": { "Bypass": "@roblox/globaltype/AudioChorus.Bypass", "Depth": "@roblox/globaltype/AudioChorus.Depth", "Mix": "@roblox/globaltype/AudioChorus.Mix", "Rate": "@roblox/globaltype/AudioChorus.Rate", "GetConnectedWires": "@roblox/globaltype/AudioChorus.GetConnectedWires", "GetInputPins": "@roblox/globaltype/AudioChorus.GetInputPins", "GetOutputPins": "@roblox/globaltype/AudioChorus.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus", "code_sample": "" }, "@roblox/globaltype/AudioChorus.Bypass": { "documentation": "Whether audio streams are passed-through unaffected by this effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#Bypass", "code_sample": "" }, "@roblox/globaltype/AudioChorus.Depth": { "documentation": "Controls the maximum delay time of the copied streams in the chorus effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#Depth", "code_sample": "" }, "@roblox/globaltype/AudioChorus.Mix": { "documentation": "Controls the balance of plain input stream to modified output stream.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#Mix", "code_sample": "" }, "@roblox/globaltype/AudioChorus.Rate": { "documentation": "Controls the rate of pitch modulations.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#Rate", "code_sample": "" }, "@roblox/globaltype/AudioChorus.GetConnectedWires/param/0": { "documentation": "Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices." }, "@roblox/globaltype/AudioChorus.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChorus.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChorus.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/AudioChorus.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/AudioChorus.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/AudioChorus.GetInputPins/param/0": { "documentation": "Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices." }, "@roblox/globaltype/AudioChorus.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChorus.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioChorus.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetInputPins", "code_sample": "" }, "@roblox/globaltype/AudioChorus.GetOutputPins/param/0": { "documentation": "Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices." }, "@roblox/globaltype/AudioChorus.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/AudioChorus.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/AudioChorus.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/AudioChorus.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChorus.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChorus.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChorus.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChorus.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChorus.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChorus.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChorus.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AudioChorus.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AudioChorus.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AudioChorus.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AudioChorus.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AudioChorus.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the AudioChorus via a Wire.", "keys": { "Connect": "@roblox/globaltype/AudioChorus.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/AudioChorus.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/AudioChorus.WiringChanged.Once", "Wait": "@roblox/globaltype/AudioChorus.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AudioChorus#WiringChanged", "code_sample": "" }, "@roblox/globaltype/Pants": { "documentation": "Displays a Pants texture from the Roblox website to display on a Humanoid rig.", "keys": { "PantsTemplate": "@roblox/globaltype/Pants.PantsTemplate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pants", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function replaceClothes(player)\n\tlocal character = player.Character\n\tif character then\n\t\t-- look for shirts / pants\n\t\tlocal shirt = character:FindFirstChildOfClass(\"Shirt\")\n\t\tlocal pants = character:FindFirstChildOfClass(\"Pants\")\n\t\t-- create shirts / pants if they don't exist\n\t\tif not shirt then\n\t\t\tshirt = Instance.new(\"Shirt\")\n\t\t\tshirt.Parent = character\n\t\tend\n\t\tif not pants then\n\t\t\tpants = Instance.new(\"Pants\")\n\t\t\tpants.Parent = character\n\t\tend\n\t\t-- reset shirt / pants content ids\n\t\tshirt.ShirtTemplate = \"http://www.roblox.com/asset/?id=83326831\"\n\t\tpants.PantsTemplate = \"http://www.roblox.com/asset/?id=10045638\"\n\tend\nend\n\nfor _index, player in ipairs(Players:GetPlayers()) do\n\treplaceClothes(player)\nend" }, "@roblox/globaltype/Pants.PantsTemplate": { "documentation": "Determines the texture of the Pants.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Pants#PantsTemplate", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function replaceClothes(player)\n\tlocal character = player.Character\n\tif character then\n\t\t-- look for shirts / pants\n\t\tlocal shirt = character:FindFirstChildOfClass(\"Shirt\")\n\t\tlocal pants = character:FindFirstChildOfClass(\"Pants\")\n\t\t-- create shirts / pants if they don't exist\n\t\tif not shirt then\n\t\t\tshirt = Instance.new(\"Shirt\")\n\t\t\tshirt.Parent = character\n\t\tend\n\t\tif not pants then\n\t\t\tpants = Instance.new(\"Pants\")\n\t\t\tpants.Parent = character\n\t\tend\n\t\t-- reset shirt / pants content ids\n\t\tshirt.ShirtTemplate = \"http://www.roblox.com/asset/?id=83326831\"\n\t\tpants.PantsTemplate = \"http://www.roblox.com/asset/?id=10045638\"\n\tend\nend\n\nfor _index, player in ipairs(Players:GetPlayers()) do\n\treplaceClothes(player)\nend" }, "@roblox/globaltype/VideoDisplay": { "documentation": "A GUI object that displays video content from a connected VideoPlayer.", "keys": { "ResampleMode": "@roblox/globaltype/VideoDisplay.ResampleMode", "ScaleType": "@roblox/globaltype/VideoDisplay.ScaleType", "TileSize": "@roblox/globaltype/VideoDisplay.TileSize", "VideoColor3": "@roblox/globaltype/VideoDisplay.VideoColor3", "VideoRectOffset": "@roblox/globaltype/VideoDisplay.VideoRectOffset", "VideoRectSize": "@roblox/globaltype/VideoDisplay.VideoRectSize", "VideoTransparency": "@roblox/globaltype/VideoDisplay.VideoTransparency", "GetConnectedWires": "@roblox/globaltype/VideoDisplay.GetConnectedWires", "GetInputPins": "@roblox/globaltype/VideoDisplay.GetInputPins", "GetOutputPins": "@roblox/globaltype/VideoDisplay.GetOutputPins" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.ResampleMode": { "documentation": "Selects the texture resampling mode for the VideoDisplay.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#ResampleMode", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.ScaleType": { "documentation": "Determines how a video will scale if displayed in a UI element whose aspect ratio differs from the source video.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#ScaleType", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.TileSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#TileSize", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.VideoColor3": { "documentation": "Determines how a rendered video will be colorized.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoColor3", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.VideoRectOffset": { "documentation": "The offset in pixels of the sub-area of a video to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoRectOffset", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.VideoRectSize": { "documentation": "Determines the size in pixels of the sub-area of a video to be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoRectSize", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.VideoTransparency": { "documentation": "Determines the transparency of the rendered video.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#VideoTransparency", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.GetConnectedWires/param/0": { "documentation": "A GUI object that displays video content from a connected VideoPlayer." }, "@roblox/globaltype/VideoDisplay.GetConnectedWires/param/1": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.GetConnectedWires/return/0": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.GetConnectedWires": { "documentation": "Returns an array of Wires that are connected to the specified pin.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.GetConnectedWires/param/0" }, { "name": "pin", "documentation": "@roblox/globaltype/VideoDisplay.GetConnectedWires/param/1" } ], "returns": [ "@roblox/globaltype/VideoDisplay.GetConnectedWires/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetConnectedWires", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.GetInputPins/param/0": { "documentation": "A GUI object that displays video content from a connected VideoPlayer." }, "@roblox/globaltype/VideoDisplay.GetInputPins/return/0": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.GetInputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.GetInputPins/param/0" } ], "returns": [ "@roblox/globaltype/VideoDisplay.GetInputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetInputPins", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.GetOutputPins/param/0": { "documentation": "A GUI object that displays video content from a connected VideoPlayer." }, "@roblox/globaltype/VideoDisplay.GetOutputPins/return/0": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.GetOutputPins": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.GetOutputPins/param/0" } ], "returns": [ "@roblox/globaltype/VideoDisplay.GetOutputPins/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetOutputPins", "code_sample": "" }, "@roblox/globaltype/VideoDisplay.WiringChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoDisplay.WiringChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.WiringChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoDisplay.WiringChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoDisplay.WiringChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.WiringChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoDisplay.WiringChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoDisplay.WiringChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoDisplay.WiringChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoDisplay.WiringChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoDisplay.WiringChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoDisplay.WiringChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoDisplay.WiringChanged": { "documentation": "Fires when another instance is connected to or disconnected from the VideoDisplay via a Wire.", "keys": { "Connect": "@roblox/globaltype/VideoDisplay.WiringChanged.Connect", "ConnectParallel": "@roblox/globaltype/VideoDisplay.WiringChanged.ConnectParallel", "Once": "@roblox/globaltype/VideoDisplay.WiringChanged.Once", "Wait": "@roblox/globaltype/VideoDisplay.WiringChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#WiringChanged", "code_sample": "" }, "@roblox/globaltype/Motor": { "documentation": "Makes a movable JointInstance between two parts.", "keys": { "CurrentAngle": "@roblox/globaltype/Motor.CurrentAngle", "DesiredAngle": "@roblox/globaltype/Motor.DesiredAngle", "MaxVelocity": "@roblox/globaltype/Motor.MaxVelocity", "SetDesiredAngle": "@roblox/globaltype/Motor.SetDesiredAngle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor", "code_sample": "" }, "@roblox/globaltype/Motor.CurrentAngle": { "documentation": "Displays the current rotation of the motor in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor#CurrentAngle", "code_sample": "" }, "@roblox/globaltype/Motor.DesiredAngle": { "documentation": "The desired angle to turn the motor to in radians.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor#DesiredAngle", "code_sample": "" }, "@roblox/globaltype/Motor.MaxVelocity": { "documentation": "The maximum velocity the motor can use to reach Motor.DesiredAngle measured in radians per physics frame (1/60th of a second).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor#MaxVelocity", "code_sample": "" }, "@roblox/globaltype/Motor.SetDesiredAngle/param/0": { "documentation": "Makes a movable JointInstance between two parts." }, "@roblox/globaltype/Motor.SetDesiredAngle/param/1": { "documentation": "" }, "@roblox/globaltype/Motor.SetDesiredAngle": { "documentation": "Sets Motor.DesiredAngle of the motor.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Motor.SetDesiredAngle/param/0" }, { "name": "value", "documentation": "@roblox/globaltype/Motor.SetDesiredAngle/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Motor#SetDesiredAngle", "code_sample": "" }, "@roblox/globaltype/VideoSampler": { "documentation": "An object for sampling frames from video content.", "keys": { "TimeLength": "@roblox/globaltype/VideoSampler.TimeLength", "VideoContent": "@roblox/globaltype/VideoSampler.VideoContent", "GetSamplesAtTimesAsync": "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoSampler", "code_sample": "" }, "@roblox/globaltype/VideoSampler.TimeLength": { "documentation": "The length of the VideoContent in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoSampler#TimeLength", "code_sample": "" }, "@roblox/globaltype/VideoSampler.VideoContent": { "documentation": "The asset loaded into the VideoSampler.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoSampler#VideoContent", "code_sample": "" }, "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync/param/0": { "documentation": "An object for sampling frames from video content." }, "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync/param/1": { "documentation": "An array of requested timestamps in seconds for which to retrieve image frames. Each timestamp should be a number between 0 and TimeLength." }, "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync/return/0": { "documentation": "An array of dictionary or nil values for each requested timestamp. If a requested timestamp is out of range or the VideoSampler was unable to produce a sample, the corresponding entry in the returned array will be nil. Each dictionary contains the following keys: " }, "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync": { "documentation": "Gets image frames at the specified timestamps.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync/param/0" }, { "name": "times", "documentation": "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync/param/1" } ], "returns": [ "@roblox/globaltype/VideoSampler.GetSamplesAtTimesAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoSampler#GetSamplesAtTimesAsync", "code_sample": "" }, "@roblox/globaltype/CreatorStoreService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CreatorStoreService", "code_sample": "" }, "@roblox/globaltype/HapticEffect": { "documentation": "", "keys": { "Looped": "@roblox/globaltype/HapticEffect.Looped", "Position": "@roblox/globaltype/HapticEffect.Position", "Radius": "@roblox/globaltype/HapticEffect.Radius", "Type": "@roblox/globaltype/HapticEffect.Type", "Waveform": "@roblox/globaltype/HapticEffect.Waveform", "Play": "@roblox/globaltype/HapticEffect.Play", "SetWaveformKeys": "@roblox/globaltype/HapticEffect.SetWaveformKeys", "Stop": "@roblox/globaltype/HapticEffect.Stop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Looped": { "documentation": "Whether the haptic effect loops continuously.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Looped", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Position": { "documentation": "Along with Radius, specifies the impact position relative to the input device and, effectively, how broadly that impact effects nearby motors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Position", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Radius": { "documentation": "Along with Position, specifies the impact radius relative to the input device and, effectively, how broadly that impact effects nearby motors.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Radius", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Type": { "documentation": "HapticEffectType describing the haptic type.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Type", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Waveform": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Waveform", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Play/param/0": { "documentation": "" }, "@roblox/globaltype/HapticEffect.Play": { "documentation": "Plays the haptic effect.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Play", "code_sample": "" }, "@roblox/globaltype/HapticEffect.SetWaveformKeys/param/0": { "documentation": "" }, "@roblox/globaltype/HapticEffect.SetWaveformKeys/param/1": { "documentation": "" }, "@roblox/globaltype/HapticEffect.SetWaveformKeys": { "documentation": "Defines a custom waveform as a table and applies it to the haptic. 
This method takes in an array of `FloatCurveKey` objects.
", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.SetWaveformKeys/param/0" }, { "name": "keys", "documentation": "@roblox/globaltype/HapticEffect.SetWaveformKeys/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#SetWaveformKeys", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Stop/param/0": { "documentation": "" }, "@roblox/globaltype/HapticEffect.Stop": { "documentation": "Stops the haptic effect.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.Stop/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Stop", "code_sample": "" }, "@roblox/globaltype/HapticEffect.Ended.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HapticEffect.Ended.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/HapticEffect.Ended.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.Ended.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HapticEffect.Ended.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/HapticEffect.Ended.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HapticEffect.Ended.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/HapticEffect.Ended.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.Ended.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HapticEffect.Ended.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/HapticEffect.Ended.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HapticEffect.Ended.Once/param/1": { "documentation": "" }, "@roblox/globaltype/HapticEffect.Ended.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.Ended.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/HapticEffect.Ended.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/HapticEffect.Ended.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/HapticEffect.Ended.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HapticEffect.Ended.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/HapticEffect.Ended": { "documentation": "Fires when the HapticEffect has completed playback and stopped.", "keys": { "Connect": "@roblox/globaltype/HapticEffect.Ended.Connect", "ConnectParallel": "@roblox/globaltype/HapticEffect.Ended.ConnectParallel", "Once": "@roblox/globaltype/HapticEffect.Ended.Once", "Wait": "@roblox/globaltype/HapticEffect.Ended.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Ended", "code_sample": "" }, "@roblox/globaltype/TextChatService": { "documentation": "A service handling in-experience text chat.", "keys": { "ChatTranslationEnabled": "@roblox/globaltype/TextChatService.ChatTranslationEnabled", "ChatVersion": "@roblox/globaltype/TextChatService.ChatVersion", "CreateDefaultCommands": "@roblox/globaltype/TextChatService.CreateDefaultCommands", "CreateDefaultTextChannels": "@roblox/globaltype/TextChatService.CreateDefaultTextChannels", "CanUserChatAsync": "@roblox/globaltype/TextChatService.CanUserChatAsync", "CanUsersChatAsync": "@roblox/globaltype/TextChatService.CanUsersChatAsync", "CanUsersDirectChatAsync": "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync", "DisplayBubble": "@roblox/globaltype/TextChatService.DisplayBubble", "OnBubbleAdded": "@roblox/globaltype/TextChatService.OnBubbleAdded", "OnChatWindowAdded": "@roblox/globaltype/TextChatService.OnChatWindowAdded", "OnIncomingMessage": "@roblox/globaltype/TextChatService.OnIncomingMessage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService", "code_sample": "" }, "@roblox/globaltype/TextChatService.ChatTranslationEnabled": { "documentation": "Determines whether a user has chat translation enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#ChatTranslationEnabled", "code_sample": "" }, "@roblox/globaltype/TextChatService.ChatVersion": { "documentation": "Determines whether to fully enable TextChatService or revert to the legacy chat system.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#ChatVersion", "code_sample": "" }, "@roblox/globaltype/TextChatService.CreateDefaultCommands": { "documentation": "Determines whether TextChatService should create default TextChatCommands.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#CreateDefaultCommands", "code_sample": "" }, "@roblox/globaltype/TextChatService.CreateDefaultTextChannels": { "documentation": "Determines whether TextChatService should create default TextChannels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#CreateDefaultTextChannels", "code_sample": "" }, "@roblox/globaltype/TextChatService.CanUserChatAsync/param/0": { "documentation": "A service handling in-experience text chat." }, "@roblox/globaltype/TextChatService.CanUserChatAsync/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.CanUserChatAsync/return/0": { "documentation": "" }, "@roblox/globaltype/TextChatService.CanUserChatAsync": { "documentation": "Determines whether a user has permission to chat in experiences.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.CanUserChatAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/TextChatService.CanUserChatAsync/param/1" } ], "returns": [ "@roblox/globaltype/TextChatService.CanUserChatAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUserChatAsync", "code_sample": "" }, "@roblox/globaltype/TextChatService.CanUsersChatAsync/param/0": { "documentation": "A service handling in-experience text chat." }, "@roblox/globaltype/TextChatService.CanUsersChatAsync/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.CanUsersChatAsync/param/2": { "documentation": "" }, "@roblox/globaltype/TextChatService.CanUsersChatAsync/return/0": { "documentation": "" }, "@roblox/globaltype/TextChatService.CanUsersChatAsync": { "documentation": "Determines whether or not two users would receive messages between each other.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.CanUsersChatAsync/param/0" }, { "name": "userIdFrom", "documentation": "@roblox/globaltype/TextChatService.CanUsersChatAsync/param/1" }, { "name": "userIdTo", "documentation": "@roblox/globaltype/TextChatService.CanUsersChatAsync/param/2" } ], "returns": [ "@roblox/globaltype/TextChatService.CanUsersChatAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersChatAsync", "code_sample": "" }, "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/param/0": { "documentation": "A service handling in-experience text chat." }, "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/param/1": { "documentation": "The user who would have initiated the direct chat request. If the requesterUserId is not in the current server, this method will error." }, "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/param/2": { "documentation": "A list of users who the requesterUserId would like to chat with directly. Users not in the current server are ignored." }, "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/return/0": { "documentation": "A list of users who could participate in the direct chat request. If none of the users can direct chat with the requesterUserId, the result is an empty array." }, "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync": { "documentation": "Determines whether a user has permission to chat directly with other users in experiences based on factors such as their parental control settings.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/param/0" }, { "name": "requesterUserId", "documentation": "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/param/1" }, { "name": "userIds", "documentation": "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/param/2" } ], "returns": [ "@roblox/globaltype/TextChatService.CanUsersDirectChatAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersDirectChatAsync", "code_sample": "" }, "@roblox/globaltype/TextChatService.DisplayBubble/param/0": { "documentation": "A service handling in-experience text chat." }, "@roblox/globaltype/TextChatService.DisplayBubble/param/1": { "documentation": "The part or character that the bubble to be displayed above." }, "@roblox/globaltype/TextChatService.DisplayBubble/param/2": { "documentation": "The text to be displayed in the chat bubble." }, "@roblox/globaltype/TextChatService.DisplayBubble": { "documentation": "Displays a chat bubble above the provided part or player character.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.DisplayBubble/param/0" }, { "name": "partOrCharacter", "documentation": "@roblox/globaltype/TextChatService.DisplayBubble/param/1" }, { "name": "message", "documentation": "@roblox/globaltype/TextChatService.DisplayBubble/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#DisplayBubble", "code_sample": "" }, "@roblox/globaltype/TextChatService.OnBubbleAdded/param/0": { "documentation": "The incoming TextChatMessage." }, "@roblox/globaltype/TextChatService.OnBubbleAdded/param/1": { "documentation": "The part or character the bubble chat message is attached to." }, "@roblox/globaltype/TextChatService.OnBubbleAdded/return/0": { "documentation": "If a BubbleChatMessageProperties is returned, its properties override the BubbleChatConfiguration properties." }, "@roblox/globaltype/TextChatService.OnBubbleAdded": { "documentation": "Called when a bubble chat is about to be displayed.", "params": [ { "name": "message", "documentation": "@roblox/globaltype/TextChatService.OnBubbleAdded/param/0" }, { "name": "adornee", "documentation": "@roblox/globaltype/TextChatService.OnBubbleAdded/param/1" } ], "returns": [ "@roblox/globaltype/TextChatService.OnBubbleAdded/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#OnBubbleAdded", "code_sample": "" }, "@roblox/globaltype/TextChatService.OnChatWindowAdded/param/0": { "documentation": "The incoming TextChatMessage." }, "@roblox/globaltype/TextChatService.OnChatWindowAdded/return/0": { "documentation": "If a ChatWindowMessageProperties is returned, its properties override the ChatWindowConfiguration properties." }, "@roblox/globaltype/TextChatService.OnChatWindowAdded": { "documentation": "Called when a new message is about to be displayed in the chat window. This can only be implemented on the client.", "params": [ { "name": "message", "documentation": "@roblox/globaltype/TextChatService.OnChatWindowAdded/param/0" } ], "returns": [ "@roblox/globaltype/TextChatService.OnChatWindowAdded/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#OnChatWindowAdded", "code_sample": "" }, "@roblox/globaltype/TextChatService.OnIncomingMessage/param/0": { "documentation": "The incoming TextChatMessage." }, "@roblox/globaltype/TextChatService.OnIncomingMessage/return/0": { "documentation": "If a TextChatMessageProperties is returned, those properties are merged with the TextChatMessage parameter to create a new TextChatMessage with those properties, otherwise, if nil is returned, then TextChatMessage is not changed." }, "@roblox/globaltype/TextChatService.OnIncomingMessage": { "documentation": "Called when TextChatService is receiving an incoming message.", "params": [ { "name": "message", "documentation": "@roblox/globaltype/TextChatService.OnIncomingMessage/param/0" } ], "returns": [ "@roblox/globaltype/TextChatService.OnIncomingMessage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#OnIncomingMessage", "code_sample": "" }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.BubbleDisplayed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.BubbleDisplayed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.BubbleDisplayed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.BubbleDisplayed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.BubbleDisplayed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextChatService.BubbleDisplayed": { "documentation": "Fires when TextChatService:DisplayBubble() is called.", "keys": { "Connect": "@roblox/globaltype/TextChatService.BubbleDisplayed.Connect", "ConnectParallel": "@roblox/globaltype/TextChatService.BubbleDisplayed.ConnectParallel", "Once": "@roblox/globaltype/TextChatService.BubbleDisplayed.Once", "Wait": "@roblox/globaltype/TextChatService.BubbleDisplayed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#BubbleDisplayed", "code_sample": "" }, "@roblox/globaltype/TextChatService.MessageReceived.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.MessageReceived.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.MessageReceived.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.MessageReceived.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.MessageReceived.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.MessageReceived.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.MessageReceived.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.MessageReceived.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.MessageReceived.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.MessageReceived.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.MessageReceived.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.MessageReceived.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextChatService.MessageReceived": { "documentation": "Fires when TextChannel:DisplaySystemMessage() is invoked on the client, or when the client receives a valid TextChannel:SendAsync() response from the server.", "keys": { "Connect": "@roblox/globaltype/TextChatService.MessageReceived.Connect", "ConnectParallel": "@roblox/globaltype/TextChatService.MessageReceived.ConnectParallel", "Once": "@roblox/globaltype/TextChatService.MessageReceived.Once", "Wait": "@roblox/globaltype/TextChatService.MessageReceived.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#MessageReceived", "code_sample": "" }, "@roblox/globaltype/TextChatService.SendingMessage.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.SendingMessage.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.SendingMessage.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.SendingMessage.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.SendingMessage.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.SendingMessage.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.SendingMessage.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.SendingMessage.Once/param/1": { "documentation": "" }, "@roblox/globaltype/TextChatService.SendingMessage.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/TextChatService.SendingMessage.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/TextChatService.SendingMessage.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/TextChatService.SendingMessage.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/TextChatService.SendingMessage": { "documentation": "Fires when TextChannel:SendAsync() is called by the sending client.", "keys": { "Connect": "@roblox/globaltype/TextChatService.SendingMessage.Connect", "ConnectParallel": "@roblox/globaltype/TextChatService.SendingMessage.ConnectParallel", "Once": "@roblox/globaltype/TextChatService.SendingMessage.Once", "Wait": "@roblox/globaltype/TextChatService.SendingMessage.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextChatService#SendingMessage", "code_sample": "" }, "@roblox/globaltype/CharacterMesh": { "documentation": "Modifies the appearance of an R6 body part.", "keys": { "BaseTextureId": "@roblox/globaltype/CharacterMesh.BaseTextureId", "BodyPart": "@roblox/globaltype/CharacterMesh.BodyPart", "MeshId": "@roblox/globaltype/CharacterMesh.MeshId", "OverlayTextureId": "@roblox/globaltype/CharacterMesh.OverlayTextureId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CharacterMesh", "code_sample": "" }, "@roblox/globaltype/CharacterMesh.BaseTextureId": { "documentation": "The texture of a CharacterMesh. It can be overridden by Shirts, Pants, T-Shirts, and the CharacterMesh.OverlayTextureId property.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#BaseTextureId", "code_sample": "" }, "@roblox/globaltype/CharacterMesh.BodyPart": { "documentation": "The part of the Character's body that is affected.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#BodyPart", "code_sample": "" }, "@roblox/globaltype/CharacterMesh.MeshId": { "documentation": "Used to load a mesh file, and apply it to the given BodyPart.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#MeshId", "code_sample": "" }, "@roblox/globaltype/CharacterMesh.OverlayTextureId": { "documentation": "The assetId of the overlay texture. The overlay covers Shirts, Pants, T-Shirts, and the CharacterMesh.BaseTextureId.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#OverlayTextureId", "code_sample": "" }, "@roblox/globaltype/Torque": { "documentation": "Applies constant torque to an assembly from its center of mass.", "keys": { "RelativeTo": "@roblox/globaltype/Torque.RelativeTo", "Torque": "@roblox/globaltype/Torque.Torque" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Torque", "code_sample": "" }, "@roblox/globaltype/Torque.RelativeTo": { "documentation": "The CFrame in which the torque is expressed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Torque#RelativeTo", "code_sample": "" }, "@roblox/globaltype/Torque.Torque": { "documentation": "The strength and direction of the torque.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Torque#Torque", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint": { "documentation": "Aligns two BaseParts with an animate-able kinematic or force-based joint.", "keys": { "C0": "@roblox/globaltype/AnimationConstraint.C0", "C1": "@roblox/globaltype/AnimationConstraint.C1", "IsKinematic": "@roblox/globaltype/AnimationConstraint.IsKinematic", "MaxForce": "@roblox/globaltype/AnimationConstraint.MaxForce", "MaxTorque": "@roblox/globaltype/AnimationConstraint.MaxTorque", "Part0": "@roblox/globaltype/AnimationConstraint.Part0", "Part1": "@roblox/globaltype/AnimationConstraint.Part1", "Transform": "@roblox/globaltype/AnimationConstraint.Transform" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.C0": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#C0", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.C1": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#C1", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.IsKinematic": { "documentation": "Toggles whether the constraint is kinematic or physically simulated.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#IsKinematic", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.MaxForce": { "documentation": "Maximum force magnitude the constraint can apply to achieve its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#MaxForce", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.MaxTorque": { "documentation": "Maximum torque the constraint can apply to reach its goal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#MaxTorque", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.Part0": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#Part0", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.Part1": { "documentation": "Deprecated: ", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#Part1", "code_sample": "" }, "@roblox/globaltype/AnimationConstraint.Transform": { "documentation": "Describes the current animation offset of the constraint joint.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#Transform", "code_sample": "" }, "@roblox/globaltype/ModuleScript": { "documentation": "A script type that runs once when require() is called with it. Returns exactly one value, usually a table of functions, to used by other scripts. Useful for compartmentalizing code.", "keys": { "LinkedSource": "@roblox/globaltype/ModuleScript.LinkedSource", "Source": "@roblox/globaltype/ModuleScript.Source" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModuleScript", "code_sample": "-- Tables store multiple values in one variable\nlocal MyFunctions = {}\n\n-- Add a few functions to the table\nfunction MyFunctions.foo()\n\tprint(\"Foo!\")\nend\n\nfunction MyFunctions.bar()\n\tprint(\"Bar!\")\nend\n\n-- ModuleScripts must return exactly one value\nreturn MyFunctions" }, "@roblox/globaltype/ModuleScript.LinkedSource": { "documentation": "Deprecated: This property is now replaced by packages which has greater functionality.
Used to store a URL that points to an online script source. Binds the online code to the script's Script.Source.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModuleScript#LinkedSource", "code_sample": "" }, "@roblox/globaltype/ModuleScript.Source": { "documentation": "The code to be executed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ModuleScript#Source", "code_sample": "" }, "@roblox/globaltype/SlimContentProvider": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlimContentProvider", "code_sample": "" }, "@roblox/globaltype/Explosion": { "documentation": "Applies force to BaseParts within the explosion's Explosion.BlastRadius. Breaks JointInstances and WeldConstraints between parts and kills Humanoid characters not protected by a ForceField.", "keys": { "BlastPressure": "@roblox/globaltype/Explosion.BlastPressure", "BlastRadius": "@roblox/globaltype/Explosion.BlastRadius", "DestroyJointRadiusPercent": "@roblox/globaltype/Explosion.DestroyJointRadiusPercent", "ExplosionType": "@roblox/globaltype/Explosion.ExplosionType", "LocalTransparencyModifier": "@roblox/globaltype/Explosion.LocalTransparencyModifier", "Position": "@roblox/globaltype/Explosion.Position", "TimeScale": "@roblox/globaltype/Explosion.TimeScale", "Visible": "@roblox/globaltype/Explosion.Visible" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion", "code_sample": "local explosion = Instance.new(\"Explosion\")\nexplosion.BlastRadius = 60\nexplosion.ExplosionType = Enum.ExplosionType.Craters -- damages terrain\nexplosion.Position = Vector3.new(0, 10, 0)\nexplosion.Parent = workspace" }, "@roblox/globaltype/Explosion.BlastPressure": { "documentation": "Used to determine the amount of force applied to BaseParts caught in the Explosion.BlastRadius.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#BlastPressure", "code_sample": "" }, "@roblox/globaltype/Explosion.BlastRadius": { "documentation": "This property determines the radius of the Explosion, in studs. This radius determines the area of effect of the explosion, not the size of the explosion's visuals.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#BlastRadius", "code_sample": "local explosion = Instance.new(\"Explosion\")\nexplosion.BlastRadius = 60\nexplosion.ExplosionType = Enum.ExplosionType.Craters -- damages terrain\nexplosion.Position = Vector3.new(0, 10, 0)\nexplosion.Parent = workspace" }, "@roblox/globaltype/Explosion.DestroyJointRadiusPercent": { "documentation": "Used to set the proportion of the Explosion.BlastRadius, between 0 and 1, within which all joints will be destroyed. Anything outside of this range will only have the Explosion force applied to it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#DestroyJointRadiusPercent", "code_sample": "local function onDescendantAdded(instance)\n\tif instance:IsA(\"Explosion\") then\n\t\tlocal explosion = instance\n\t\texplosion.DestroyJointRadiusPercent = 0\n\n\t\tlocal destroyJointRadiusPercent = 1\n\t\texplosion.Hit:Connect(function(part, distance)\n\t\t\t-- check the part is in range to break joints\n\t\t\tif distance <= destroyJointRadiusPercent * explosion.BlastRadius then\n\t\t\t\t-- make sure the part does not belong to a character\n\t\t\t\tif not game.Players:GetPlayerFromCharacter(part.Parent) then\n\t\t\t\t\tpart:BreakJoints()\n\t\t\t\tend\n\t\t\tend\n\t\tend)\n\tend\nend\n\nworkspace.DescendantAdded:Connect(onDescendantAdded)" }, "@roblox/globaltype/Explosion.ExplosionType": { "documentation": "This property determines how the Explosion will interact with Terrain. Used to set if explosions will cause damage to the terrain or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#ExplosionType", "code_sample": "local function onDescendantAdded(instance)\n\tif instance:IsA(\"Explosion\") then\n\t\tinstance.ExplosionType = Enum.ExplosionType.NoCraters\n\t\tinstance:GetPropertyChangedSignal(\"ExplosionType\"):Connect(function()\n\t\t\tinstance.ExplosionType = Enum.ExplosionType.NoCraters\n\t\tend)\n\tend\nend\n\nworkspace.DescendantAdded:Connect(onDescendantAdded)" }, "@roblox/globaltype/Explosion.LocalTransparencyModifier": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#LocalTransparencyModifier", "code_sample": "" }, "@roblox/globaltype/Explosion.Position": { "documentation": "This property is the position of the center of the Explosion. It is defined in world-space and not influenced by the Explosion parent.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#Position", "code_sample": "local explosion = Instance.new(\"Explosion\")\nexplosion.BlastRadius = 60\nexplosion.ExplosionType = Enum.ExplosionType.Craters -- damages terrain\nexplosion.Position = Vector3.new(0, 10, 0)\nexplosion.Parent = workspace" }, "@roblox/globaltype/Explosion.TimeScale": { "documentation": "Value between 0 and 1 that controls the speed of the particle effect.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#TimeScale", "code_sample": "" }, "@roblox/globaltype/Explosion.Visible": { "documentation": "This property determines whether or not the visual effect of an Explosion is shown or not.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#Visible", "code_sample": "local function customExplosion(position)\n\tlocal explosion = Instance.new(\"Explosion\")\n\texplosion.Position = position\n\texplosion.Visible = false\n\n\tlocal attachment = Instance.new(\"Attachment\")\n\tattachment.Position = position\n\tattachment.Parent = workspace.Terrain\n\n\tlocal particleEmitter = Instance.new(\"ParticleEmitter\")\n\tparticleEmitter.Enabled = false\n\tparticleEmitter.Parent = attachment\n\tparticleEmitter.Speed = NumberRange.new(5, 30)\n\tparticleEmitter.SpreadAngle = Vector2.new(-90, 90)\n\n\texplosion.Parent = workspace\n\tparticleEmitter:Emit(20)\n\n\ttask.delay(5, function()\n\t\tif attachment then\n\t\t\tattachment:Destroy()\n\t\tend\n\tend)\nend\n\ncustomExplosion(Vector3.new(0, 10, 0))" }, "@roblox/globaltype/Explosion.Hit.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Explosion.Hit.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Explosion.Hit.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Explosion.Hit.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Explosion.Hit.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Explosion.Hit.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Explosion.Hit.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Explosion.Hit.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Explosion.Hit.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Explosion.Hit.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Explosion.Hit.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Explosion.Hit.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Explosion.Hit.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Explosion.Hit.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Explosion.Hit.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Explosion.Hit.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Explosion.Hit.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Explosion.Hit.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Explosion.Hit": { "documentation": "Fires when the Explosion hits a BasePart within its Explosion.BlastRadius. Returns the part hit along with the distance of the part from Explosion.Position.", "keys": { "Connect": "@roblox/globaltype/Explosion.Hit.Connect", "ConnectParallel": "@roblox/globaltype/Explosion.Hit.ConnectParallel", "Once": "@roblox/globaltype/Explosion.Hit.Once", "Wait": "@roblox/globaltype/Explosion.Hit.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Explosion#Hit", "code_sample": "" }, "@roblox/globaltype/AtmosphereSensor": { "documentation": "A SensorBase that outputs data about the AirDensity and RelativeWindVelocity at the sensor's position.", "keys": { "AirDensity": "@roblox/globaltype/AtmosphereSensor.AirDensity", "RelativeWindVelocity": "@roblox/globaltype/AtmosphereSensor.RelativeWindVelocity" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AtmosphereSensor", "code_sample": "" }, "@roblox/globaltype/AtmosphereSensor.AirDensity": { "documentation": "Measures the density of the air where the sensor is positioned.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AtmosphereSensor#AirDensity", "code_sample": "" }, "@roblox/globaltype/AtmosphereSensor.RelativeWindVelocity": { "documentation": "Reports the wind velocity relative to the sensor.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AtmosphereSensor#RelativeWindVelocity", "code_sample": "" }, "@roblox/globaltype/RunningAverageItemInt": { "documentation": "Measures the runtime average of an integer value.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RunningAverageItemInt", "code_sample": "" }, "@roblox/globaltype/WedgePart": { "documentation": "A type of BasePart that has a wedge shape.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WedgePart", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration": { "documentation": "Allows for customization of text chat bubbles through TextChatService.", "keys": { "AdorneeName": "@roblox/globaltype/BubbleChatConfiguration.AdorneeName", "BackgroundColor3": "@roblox/globaltype/BubbleChatConfiguration.BackgroundColor3", "BackgroundTransparency": "@roblox/globaltype/BubbleChatConfiguration.BackgroundTransparency", "BubbleDuration": "@roblox/globaltype/BubbleChatConfiguration.BubbleDuration", "BubblesSpacing": "@roblox/globaltype/BubbleChatConfiguration.BubblesSpacing", "Enabled": "@roblox/globaltype/BubbleChatConfiguration.Enabled", "Font": "@roblox/globaltype/BubbleChatConfiguration.Font", "FontFace": "@roblox/globaltype/BubbleChatConfiguration.FontFace", "LocalPlayerStudsOffset": "@roblox/globaltype/BubbleChatConfiguration.LocalPlayerStudsOffset", "MaxBubbles": "@roblox/globaltype/BubbleChatConfiguration.MaxBubbles", "MaxDistance": "@roblox/globaltype/BubbleChatConfiguration.MaxDistance", "MinimizeDistance": "@roblox/globaltype/BubbleChatConfiguration.MinimizeDistance", "TailVisible": "@roblox/globaltype/BubbleChatConfiguration.TailVisible", "TextColor3": "@roblox/globaltype/BubbleChatConfiguration.TextColor3", "TextSize": "@roblox/globaltype/BubbleChatConfiguration.TextSize", "VerticalStudsOffset": "@roblox/globaltype/BubbleChatConfiguration.VerticalStudsOffset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.AdorneeName": { "documentation": "Body part or Attachment that bubbles will attach to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#AdorneeName", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.BackgroundColor3": { "documentation": "Background color of bubbles.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#BackgroundColor3", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.BackgroundTransparency": { "documentation": "Determines the background transparency of the default bubble chat as a number between 0 and 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#BackgroundTransparency", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.BubbleDuration": { "documentation": "Time before a bubble fades out, in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#BubbleDuration", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.BubblesSpacing": { "documentation": "Vertical space between stacked bubbles, in pixels.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#BubblesSpacing", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.Enabled": { "documentation": "Whether text chat bubbles are enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#Enabled", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.Font": { "documentation": "Font of the bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#Font", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.FontFace": { "documentation": "Font of the bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#FontFace", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.LocalPlayerStudsOffset": { "documentation": "Offset of bubbles from their adornee, in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#LocalPlayerStudsOffset", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.MaxBubbles": { "documentation": "Maximum number of text chat bubbles shown per user.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#MaxBubbles", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.MaxDistance": { "documentation": "Maximum distance from the camera that bubbles are shown.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#MaxDistance", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.MinimizeDistance": { "documentation": "Distance from the camera when bubbles turn into a single bubble with an ellipsis to indicate chatter.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#MinimizeDistance", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.TailVisible": { "documentation": "Determines if the tail at the bottom of the text chat bubbles is visible.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#TailVisible", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.TextColor3": { "documentation": "Color of bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#TextColor3", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.TextSize": { "documentation": "Size of bubble text.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#TextSize", "code_sample": "" }, "@roblox/globaltype/BubbleChatConfiguration.VerticalStudsOffset": { "documentation": "Extra space between bubbles and their adornee, in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BubbleChatConfiguration#VerticalStudsOffset", "code_sample": "" }, "@roblox/globaltype/UIComponent": { "documentation": "A base class for UI constraint and layout classes.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIComponent", "code_sample": "" }, "@roblox/globaltype/BackpackItem": { "documentation": "BackpackItem is an abstract class for backpack items such as HopperBins and Tools.", "keys": { "TextureContent": "@roblox/globaltype/BackpackItem.TextureContent", "TextureId": "@roblox/globaltype/BackpackItem.TextureId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BackpackItem", "code_sample": "" }, "@roblox/globaltype/BackpackItem.TextureContent": { "documentation": "The texture icon that is displayed for a tool in the player's backpack. Only supports asset URIs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BackpackItem#TextureContent", "code_sample": "" }, "@roblox/globaltype/BackpackItem.TextureId": { "documentation": "The texture icon that is displayed for a tool in the player's backpack.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BackpackItem#TextureId", "code_sample": "" }, "@roblox/globaltype/SessionCheckService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SessionCheckService", "code_sample": "" }, "@roblox/globaltype/VideoCapture": { "documentation": "A child class of Capture for videos.", "keys": { "FilePath": "@roblox/globaltype/VideoCapture.FilePath", "TimeLength": "@roblox/globaltype/VideoCapture.TimeLength" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoCapture", "code_sample": "" }, "@roblox/globaltype/VideoCapture.FilePath": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoCapture#FilePath", "code_sample": "" }, "@roblox/globaltype/VideoCapture.TimeLength": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoCapture#TimeLength", "code_sample": "" }, "@roblox/globaltype/InstanceFileSyncService": { "documentation": "A service for interacting with file sync from a plugin.", "keys": { "GetAllInstances": "@roblox/globaltype/InstanceFileSyncService.GetAllInstances", "GetStatus": "@roblox/globaltype/InstanceFileSyncService.GetStatus", "GetSyncedInstance": "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService", "code_sample": "" }, "@roblox/globaltype/InstanceFileSyncService.GetAllInstances/param/0": { "documentation": "A service for interacting with file sync from a plugin." }, "@roblox/globaltype/InstanceFileSyncService.GetAllInstances/return/0": { "documentation": "Returns an array of Instances." }, "@roblox/globaltype/InstanceFileSyncService.GetAllInstances": { "documentation": "Returns an array of all instances currently involved in file synchronization.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.GetAllInstances/param/0" } ], "returns": [ "@roblox/globaltype/InstanceFileSyncService.GetAllInstances/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetAllInstances", "code_sample": "" }, "@roblox/globaltype/InstanceFileSyncService.GetStatus/param/0": { "documentation": "A service for interacting with file sync from a plugin." }, "@roblox/globaltype/InstanceFileSyncService.GetStatus/param/1": { "documentation": "The instance to check." }, "@roblox/globaltype/InstanceFileSyncService.GetStatus/return/0": { "documentation": "Returns the InstanceFileSyncStatus for the instance." }, "@roblox/globaltype/InstanceFileSyncService.GetStatus": { "documentation": "Returns the synchronization status of a specific instance.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.GetStatus/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/InstanceFileSyncService.GetStatus/param/1" } ], "returns": [ "@roblox/globaltype/InstanceFileSyncService.GetStatus/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetStatus", "code_sample": "" }, "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance/param/0": { "documentation": "A service for interacting with file sync from a plugin." }, "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance/param/1": { "documentation": "The absolute path to the file." }, "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance/return/0": { "documentation": "Returns the Instance being synced to the file path, if one exists. Otherwise, returns nil." }, "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance": { "documentation": "Returns the instance corresponding to a given file path.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance/param/0" }, { "name": "filePath", "documentation": "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance/param/1" } ], "returns": [ "@roblox/globaltype/InstanceFileSyncService.GetSyncedInstance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#GetSyncedInstance", "code_sample": "" }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/InstanceFileSyncService.StatusChanged": { "documentation": "Fires when the synchronization status of an instance changes.", "keys": { "Connect": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Connect", "ConnectParallel": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.ConnectParallel", "Once": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Once", "Wait": "@roblox/globaltype/InstanceFileSyncService.StatusChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService#StatusChanged", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint": { "documentation": "The base class for constraints that allow their attachments to slide along an axis but not rotate.", "keys": { "ActuatorType": "@roblox/globaltype/SlidingBallConstraint.ActuatorType", "CurrentPosition": "@roblox/globaltype/SlidingBallConstraint.CurrentPosition", "LimitsEnabled": "@roblox/globaltype/SlidingBallConstraint.LimitsEnabled", "LinearResponsiveness": "@roblox/globaltype/SlidingBallConstraint.LinearResponsiveness", "LowerLimit": "@roblox/globaltype/SlidingBallConstraint.LowerLimit", "MotorMaxAcceleration": "@roblox/globaltype/SlidingBallConstraint.MotorMaxAcceleration", "MotorMaxForce": "@roblox/globaltype/SlidingBallConstraint.MotorMaxForce", "Restitution": "@roblox/globaltype/SlidingBallConstraint.Restitution", "ServoMaxForce": "@roblox/globaltype/SlidingBallConstraint.ServoMaxForce", "Size": "@roblox/globaltype/SlidingBallConstraint.Size", "SoftlockServoUponReachingTarget": "@roblox/globaltype/SlidingBallConstraint.SoftlockServoUponReachingTarget", "Speed": "@roblox/globaltype/SlidingBallConstraint.Speed", "TargetPosition": "@roblox/globaltype/SlidingBallConstraint.TargetPosition", "UpperLimit": "@roblox/globaltype/SlidingBallConstraint.UpperLimit", "Velocity": "@roblox/globaltype/SlidingBallConstraint.Velocity" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.ActuatorType": { "documentation": "Sets whether the translation of the SlidingBallConstraint is actuated and, if so, what kind of actuation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#ActuatorType", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.CurrentPosition": { "documentation": "The current offset between the constraint's Attachments.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#CurrentPosition", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.LimitsEnabled": { "documentation": "Sets whether the SlidingBallConstraint will limit the range of translation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#LimitsEnabled", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.LinearResponsiveness": { "documentation": "Specifies the \"sharpness\" of the linear servo motor in reaching the TargetPosition.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#LinearResponsiveness", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.LowerLimit": { "documentation": "The lower positional limit along the X axis of Attachment0 if LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#LowerLimit", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.MotorMaxAcceleration": { "documentation": "The constraint's maximum acceleration when ActuatorType is set to Motor as the constraint attempts to reach its desired Velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#MotorMaxAcceleration", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.MotorMaxForce": { "documentation": "The constraint's maximum force when ActuatorType is set to Motor, as the constraint attempts to reach its desired Velocity.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#MotorMaxForce", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.Restitution": { "documentation": "The elasticity of the constraint's Attachments when they reach the end of the range specified by UpperLimit and LowerLimit, assuming LimitsEnabled is set to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#Restitution", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.ServoMaxForce": { "documentation": "The constraint's maximum force when ActuatorType is set to Servo, as the constraint attempts to reach its desired Speed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#ServoMaxForce", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.Size": { "documentation": "The constraint's visualized size.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#Size", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.SoftlockServoUponReachingTarget": { "documentation": "Deprecated: This property should not be used in new work.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#SoftlockServoUponReachingTarget", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.Speed": { "documentation": "The constraint's desired speed when ActuatorType is set to Servo, as the constraint translates towards its TargetPosition. Measured in studs per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#Speed", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.TargetPosition": { "documentation": "The constraint's attempted target position when ActuatorType is set to Servo. Measured in studs.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#TargetPosition", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.UpperLimit": { "documentation": "The upper positional limit along the X axis of Attachment0 if LimitsEnabled is true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#UpperLimit", "code_sample": "" }, "@roblox/globaltype/SlidingBallConstraint.Velocity": { "documentation": "The constraint's attempted velocity when ActuatorType is set to Motor. Measured in studs per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SlidingBallConstraint#Velocity", "code_sample": "" }, "@roblox/globaltype/PathfindingService": { "documentation": "Used to find logical paths between two points.", "keys": { "EmptyCutoff": "@roblox/globaltype/PathfindingService.EmptyCutoff", "ComputeRawPathAsync": "@roblox/globaltype/PathfindingService.ComputeRawPathAsync", "ComputeSmoothPathAsync": "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync", "CreatePath": "@roblox/globaltype/PathfindingService.CreatePath", "FindPathAsync": "@roblox/globaltype/PathfindingService.FindPathAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingService", "code_sample": "" }, "@roblox/globaltype/PathfindingService.EmptyCutoff": { "documentation": "Deprecated: This property is deprecated, since the legacy pathfinding system using it has since been removed. Do not use it for new work.
Sets the percent of a voxel has to be occupied to be considered empty. Defaults to 0.16.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingService#EmptyCutoff", "code_sample": "" }, "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/0": { "documentation": "Used to find logical paths between two points." }, "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/1": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/2": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/3": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/return/0": { "documentation": "A Path object." }, "@roblox/globaltype/PathfindingService.ComputeRawPathAsync": { "documentation": "Deprecated: This item has been superseded by PathfindingService:FindPathAsync() which should be used in all new work instead.
Computes and returns a Path between two Vector3s. If the given MaxDistance is greater than 512, an error will be thrown. (MaxDistance is too large).", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/0" }, { "name": "start", "documentation": "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/1" }, { "name": "finish", "documentation": "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/2" }, { "name": "maxDistance", "documentation": "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/param/3" } ], "returns": [ "@roblox/globaltype/PathfindingService.ComputeRawPathAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingService#ComputeRawPathAsync", "code_sample": "" }, "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/0": { "documentation": "Used to find logical paths between two points." }, "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/1": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/2": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/3": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/return/0": { "documentation": "" }, "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync": { "documentation": "Deprecated: This item has been superseded by PathfindingService:FindPathAsync() which should be used in all new work instead.
Computes and returns a smooth Path between two Vector3s.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/0" }, { "name": "start", "documentation": "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/1" }, { "name": "finish", "documentation": "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/2" }, { "name": "maxDistance", "documentation": "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/param/3" } ], "returns": [ "@roblox/globaltype/PathfindingService.ComputeSmoothPathAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingService#ComputeSmoothPathAsync", "code_sample": "" }, "@roblox/globaltype/PathfindingService.CreatePath/param/0": { "documentation": "Used to find logical paths between two points." }, "@roblox/globaltype/PathfindingService.CreatePath/param/1": { "documentation": "Luau table which lets you fine-tune the path for the size of the agent (the humanoid that will move along the path). See above for valid keys, types, and descriptions." }, "@roblox/globaltype/PathfindingService.CreatePath/return/0": { "documentation": "A Path object." }, "@roblox/globaltype/PathfindingService.CreatePath": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PathfindingService.CreatePath/param/0" }, { "name": "agentParameters", "documentation": "@roblox/globaltype/PathfindingService.CreatePath/param/1" } ], "returns": [ "@roblox/globaltype/PathfindingService.CreatePath/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingService#CreatePath", "code_sample": "" }, "@roblox/globaltype/PathfindingService.FindPathAsync/param/0": { "documentation": "Used to find logical paths between two points." }, "@roblox/globaltype/PathfindingService.FindPathAsync/param/1": { "documentation": "Path start coordinates." }, "@roblox/globaltype/PathfindingService.FindPathAsync/param/2": { "documentation": "Path finish coordinates." }, "@roblox/globaltype/PathfindingService.FindPathAsync/return/0": { "documentation": "A Path object." }, "@roblox/globaltype/PathfindingService.FindPathAsync": { "documentation": "Finds a Path between the two provided points.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/PathfindingService.FindPathAsync/param/0" }, { "name": "start", "documentation": "@roblox/globaltype/PathfindingService.FindPathAsync/param/1" }, { "name": "finish", "documentation": "@roblox/globaltype/PathfindingService.FindPathAsync/param/2" } ], "returns": [ "@roblox/globaltype/PathfindingService.FindPathAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/PathfindingService#FindPathAsync", "code_sample": "" }, "@roblox/globaltype/UnionOperation": { "documentation": "Result of parts that have been joined together into a single solid model.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UnionOperation", "code_sample": "" }, "@roblox/globaltype/GuiBase3d": { "documentation": "An abstract class for 3D GUI elements that are rendered in the world.", "keys": { "Color": "@roblox/globaltype/GuiBase3d.Color", "Color3": "@roblox/globaltype/GuiBase3d.Color3", "Transparency": "@roblox/globaltype/GuiBase3d.Transparency", "Visible": "@roblox/globaltype/GuiBase3d.Visible" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase3d", "code_sample": "" }, "@roblox/globaltype/GuiBase3d.Color": { "documentation": "Deprecated: This property has been deprecated in favor of GuiBase3d.Color3, which allows for greater color customization and should be used in new work instead.
Sets the color of a GUI object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase3d#Color", "code_sample": "" }, "@roblox/globaltype/GuiBase3d.Color3": { "documentation": "Sets the color of this GuiBase3d object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase3d#Color3", "code_sample": "" }, "@roblox/globaltype/GuiBase3d.Transparency": { "documentation": "Sets the transparency of this GuiBase3d object.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase3d#Transparency", "code_sample": "" }, "@roblox/globaltype/GuiBase3d.Visible": { "documentation": "Determines whether this GuiBase3d object and its descendants will be displayed.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiBase3d#Visible", "code_sample": "" }, "@roblox/globaltype/RayValue": { "documentation": "A container object for a single Ray.", "keys": { "Value": "@roblox/globaltype/RayValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RayValue", "code_sample": "local partA = workspace.PartA\nlocal partB = workspace.PartB\n\nlocal origin = partA.Position\nlocal direction = partB.Position - partA.Position\nlocal ray = Ray.new(origin, direction)\n\nlocal rayValue = Instance.new(\"RayValue\")\nrayValue.Value = ray\nrayValue.Name = \"PartA-to-PartB Ray\"\nrayValue.Parent = workspace\n\n-- Raycast to find any parts in between PartA and PartB\nlocal part = workspace:FindPartOnRay(ray)\nif part then\n\tprint(\"Hit part: \" .. part:GetFullName())\nelse\n\t-- This ought to never happen, as our ray starts at PartA\n\t-- and points towards PartB, so we should always hit PartB\n\t-- or some other part.\n\tprint(\"No part hit!\")\nend" }, "@roblox/globaltype/RayValue.Value": { "documentation": "The stored Ray.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RayValue#Value", "code_sample": "" }, "@roblox/globaltype/RayValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RayValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RayValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RayValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RayValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RayValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RayValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RayValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RayValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RayValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RayValue.Changed": { "documentation": "Fired when RayValue.Value is changed.", "keys": { "Connect": "@roblox/globaltype/RayValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/RayValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/RayValue.Changed.Once", "Wait": "@roblox/globaltype/RayValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RayValue#Changed", "code_sample": "local value = Instance.new(\"RayValue\")\nvalue.Parent = workspace\n\nvalue.Changed:Connect(function(NewValue)\n\tprint(NewValue)\nend)\n\nlocal start = Vector3.new(0, 0, 0)\nlocal lookAt = Vector3.new(10, 10, 10)\nlocal ray = Ray.new(start, (lookAt - start).Unit)\nvalue.Value = ray" }, "@roblox/globaltype/RayValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/RayValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RayValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/RayValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/RayValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RayValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/RayValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/RayValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/RayValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/RayValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/RayValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RayValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/RayValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of RayValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/RayValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/RayValue.changed.ConnectParallel", "Once": "@roblox/globaltype/RayValue.changed.Once", "Wait": "@roblox/globaltype/RayValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RayValue#changed", "code_sample": "" }, "@roblox/globaltype/Stats": { "documentation": "Performance metrics for a game.", "keys": { "ContactsCount": "@roblox/globaltype/Stats.ContactsCount", "DataReceiveKbps": "@roblox/globaltype/Stats.DataReceiveKbps", "DataSendKbps": "@roblox/globaltype/Stats.DataSendKbps", "FrameTime": "@roblox/globaltype/Stats.FrameTime", "HeartbeatTime": "@roblox/globaltype/Stats.HeartbeatTime", "HeartbeatTimeMs": "@roblox/globaltype/Stats.HeartbeatTimeMs", "InstanceCount": "@roblox/globaltype/Stats.InstanceCount", "MemoryTrackingEnabled": "@roblox/globaltype/Stats.MemoryTrackingEnabled", "MovingPrimitivesCount": "@roblox/globaltype/Stats.MovingPrimitivesCount", "PhysicsReceiveKbps": "@roblox/globaltype/Stats.PhysicsReceiveKbps", "PhysicsSendKbps": "@roblox/globaltype/Stats.PhysicsSendKbps", "PhysicsStepTime": "@roblox/globaltype/Stats.PhysicsStepTime", "PhysicsStepTimeMs": "@roblox/globaltype/Stats.PhysicsStepTimeMs", "PrimitivesCount": "@roblox/globaltype/Stats.PrimitivesCount", "RenderCPUFrameTime": "@roblox/globaltype/Stats.RenderCPUFrameTime", "RenderGPUFrameTime": "@roblox/globaltype/Stats.RenderGPUFrameTime", "SceneDrawcallCount": "@roblox/globaltype/Stats.SceneDrawcallCount", "SceneTriangleCount": "@roblox/globaltype/Stats.SceneTriangleCount", "ShadowsDrawcallCount": "@roblox/globaltype/Stats.ShadowsDrawcallCount", "ShadowsTriangleCount": "@roblox/globaltype/Stats.ShadowsTriangleCount", "UI2DDrawcallCount": "@roblox/globaltype/Stats.UI2DDrawcallCount", "UI2DTriangleCount": "@roblox/globaltype/Stats.UI2DTriangleCount", "UI3DDrawcallCount": "@roblox/globaltype/Stats.UI3DDrawcallCount", "UI3DTriangleCount": "@roblox/globaltype/Stats.UI3DTriangleCount", "GetHarmonyQualityLevel": "@roblox/globaltype/Stats.GetHarmonyQualityLevel", "GetMemoryCategoryNames": "@roblox/globaltype/Stats.GetMemoryCategoryNames", "GetMemoryUsageMbAllCategories": "@roblox/globaltype/Stats.GetMemoryUsageMbAllCategories", "GetMemoryUsageMbForTag": "@roblox/globaltype/Stats.GetMemoryUsageMbForTag", "GetTotalMemoryUsageMb": "@roblox/globaltype/Stats.GetTotalMemoryUsageMb", "ResetHarmonyMemoryTarget": "@roblox/globaltype/Stats.ResetHarmonyMemoryTarget", "SetHarmonyMemoryTarget": "@roblox/globaltype/Stats.SetHarmonyMemoryTarget" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats", "code_sample": "" }, "@roblox/globaltype/Stats.ContactsCount": { "documentation": "A measurement of how many parts are currently in contact with one another.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#ContactsCount", "code_sample": "" }, "@roblox/globaltype/Stats.DataReceiveKbps": { "documentation": "In a networked game, this describes roughly how many kilobytes of data are being received by the current instance, per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#DataReceiveKbps", "code_sample": "" }, "@roblox/globaltype/Stats.DataSendKbps": { "documentation": "In a networked game, this describes roughly how many kilobytes of data are being sent by the current instance, per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#DataSendKbps", "code_sample": "" }, "@roblox/globaltype/Stats.FrameTime": { "documentation": "A measurement of how long it takes for the engine to process all tasks required to render a frame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#FrameTime", "code_sample": "" }, "@roblox/globaltype/Stats.HeartbeatTime": { "documentation": "A measurement of the total amount of time it takes for the server to update its task scheduler jobs in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#HeartbeatTime", "code_sample": "" }, "@roblox/globaltype/Stats.HeartbeatTimeMs": { "documentation": "Deprecated:
A measurement of the total amount of time it takes long it takes for Roblox to update all of its task scheduler jobs, in milliseconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#HeartbeatTimeMs", "code_sample": "" }, "@roblox/globaltype/Stats.InstanceCount": { "documentation": "A measurement of how many Instance are currently in memory.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#InstanceCount", "code_sample": "" }, "@roblox/globaltype/Stats.MemoryTrackingEnabled": { "documentation": "An indication of whether memory tracking is enabled. This is guaranteed to be unchanged until the next time the Client is started.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#MemoryTrackingEnabled", "code_sample": "" }, "@roblox/globaltype/Stats.MovingPrimitivesCount": { "documentation": "A measurement of how many physically simulated components are currently moving in the game world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#MovingPrimitivesCount", "code_sample": "" }, "@roblox/globaltype/Stats.PhysicsReceiveKbps": { "documentation": "In a networked game, this describes roughly how many kilobytes of physics data are being received by the current instance, per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#PhysicsReceiveKbps", "code_sample": "" }, "@roblox/globaltype/Stats.PhysicsSendKbps": { "documentation": "In a networked game, this describes roughly how many kilobytes of physics data are being sent by the current instance, per second.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#PhysicsSendKbps", "code_sample": "" }, "@roblox/globaltype/Stats.PhysicsStepTime": { "documentation": "A measurement of how long it takes for the physics engine to update its current state.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#PhysicsStepTime", "code_sample": "" }, "@roblox/globaltype/Stats.PhysicsStepTimeMs": { "documentation": "Deprecated:
A measurement of how long it takes for the physics engine to update its current state, in milliseconds. If this value is high, then it means the game instance is under stress from the physics simulations taking place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#PhysicsStepTimeMs", "code_sample": "" }, "@roblox/globaltype/Stats.PrimitivesCount": { "documentation": "A measurement of how many physically simulated components currently exist in the game world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#PrimitivesCount", "code_sample": "" }, "@roblox/globaltype/Stats.RenderCPUFrameTime": { "documentation": "A measurement of how long it takes for the CPU to process all of its rendering tasks for a frame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#RenderCPUFrameTime", "code_sample": "" }, "@roblox/globaltype/Stats.RenderGPUFrameTime": { "documentation": "A measurement of how long it takes for the GPU to process all of its tasks required to render a frame.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#RenderGPUFrameTime", "code_sample": "" }, "@roblox/globaltype/Stats.SceneDrawcallCount": { "documentation": "A measurement of the number of draw calls made by the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#SceneDrawcallCount", "code_sample": "" }, "@roblox/globaltype/Stats.SceneTriangleCount": { "documentation": "A measurement of the number of triangles rendered by the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#SceneTriangleCount", "code_sample": "" }, "@roblox/globaltype/Stats.ShadowsDrawcallCount": { "documentation": "A measurement of the number of draw calls being made for shadows by the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#ShadowsDrawcallCount", "code_sample": "" }, "@roblox/globaltype/Stats.ShadowsTriangleCount": { "documentation": "A measurement of the number of triangles rendered as shadows in the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#ShadowsTriangleCount", "code_sample": "" }, "@roblox/globaltype/Stats.UI2DDrawcallCount": { "documentation": "A measurement of the number of 2D draw calls made for UI elements in the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#UI2DDrawcallCount", "code_sample": "" }, "@roblox/globaltype/Stats.UI2DTriangleCount": { "documentation": "A measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#UI2DTriangleCount", "code_sample": "" }, "@roblox/globaltype/Stats.UI3DDrawcallCount": { "documentation": "A measurement of the number of 3D draw calls made for UI elements in the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#UI3DDrawcallCount", "code_sample": "" }, "@roblox/globaltype/Stats.UI3DTriangleCount": { "documentation": "A measurement of the number of triangles being rendered for 3D UI elements in the game's current scene.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#UI3DTriangleCount", "code_sample": "" }, "@roblox/globaltype/Stats.GetHarmonyQualityLevel/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.GetHarmonyQualityLevel/return/0": { "documentation": "" }, "@roblox/globaltype/Stats.GetHarmonyQualityLevel": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.GetHarmonyQualityLevel/param/0" } ], "returns": [ "@roblox/globaltype/Stats.GetHarmonyQualityLevel/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#GetHarmonyQualityLevel", "code_sample": "" }, "@roblox/globaltype/Stats.GetMemoryCategoryNames/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.GetMemoryCategoryNames/return/0": { "documentation": "" }, "@roblox/globaltype/Stats.GetMemoryCategoryNames": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.GetMemoryCategoryNames/param/0" } ], "returns": [ "@roblox/globaltype/Stats.GetMemoryCategoryNames/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryCategoryNames", "code_sample": "" }, "@roblox/globaltype/Stats.GetMemoryUsageMbAllCategories/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.GetMemoryUsageMbAllCategories/return/0": { "documentation": "" }, "@roblox/globaltype/Stats.GetMemoryUsageMbAllCategories": { "documentation": "Returns the number of megabytes that are being consumed by all available categories, or an empty array if MemoryTrackingEnabled is false.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.GetMemoryUsageMbAllCategories/param/0" } ], "returns": [ "@roblox/globaltype/Stats.GetMemoryUsageMbAllCategories/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryUsageMbAllCategories", "code_sample": "" }, "@roblox/globaltype/Stats.GetMemoryUsageMbForTag/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.GetMemoryUsageMbForTag/param/1": { "documentation": "" }, "@roblox/globaltype/Stats.GetMemoryUsageMbForTag/return/0": { "documentation": "" }, "@roblox/globaltype/Stats.GetMemoryUsageMbForTag": { "documentation": "Returns the number of megabytes that are being consumed in the specified DeveloperMemoryTag category, or 0 if MemoryTrackingEnabled is false.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.GetMemoryUsageMbForTag/param/0" }, { "name": "tag", "documentation": "@roblox/globaltype/Stats.GetMemoryUsageMbForTag/param/1" } ], "returns": [ "@roblox/globaltype/Stats.GetMemoryUsageMbForTag/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#GetMemoryUsageMbForTag", "code_sample": "" }, "@roblox/globaltype/Stats.GetTotalMemoryUsageMb/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.GetTotalMemoryUsageMb/return/0": { "documentation": "" }, "@roblox/globaltype/Stats.GetTotalMemoryUsageMb": { "documentation": "Returns the total amount of memory being consumed by the current game session, in megabytes.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.GetTotalMemoryUsageMb/param/0" } ], "returns": [ "@roblox/globaltype/Stats.GetTotalMemoryUsageMb/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#GetTotalMemoryUsageMb", "code_sample": "" }, "@roblox/globaltype/Stats.ResetHarmonyMemoryTarget/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.ResetHarmonyMemoryTarget": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.ResetHarmonyMemoryTarget/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#ResetHarmonyMemoryTarget", "code_sample": "" }, "@roblox/globaltype/Stats.SetHarmonyMemoryTarget/param/0": { "documentation": "Performance metrics for a game." }, "@roblox/globaltype/Stats.SetHarmonyMemoryTarget/param/1": { "documentation": "" }, "@roblox/globaltype/Stats.SetHarmonyMemoryTarget": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Stats.SetHarmonyMemoryTarget/param/0" }, { "name": "targetMB", "documentation": "@roblox/globaltype/Stats.SetHarmonyMemoryTarget/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Stats#SetHarmonyMemoryTarget", "code_sample": "" }, "@roblox/globaltype/MarkerCurve": { "documentation": "Represents a list of strings markers in chronological order.", "keys": { "Length": "@roblox/globaltype/MarkerCurve.Length", "GetMarkerAtIndex": "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex", "GetMarkers": "@roblox/globaltype/MarkerCurve.GetMarkers", "InsertMarkerAtTime": "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime", "RemoveMarkerAtIndex": "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarkerCurve", "code_sample": "" }, "@roblox/globaltype/MarkerCurve.Length": { "documentation": "Returns the number of markers in the MarkerCurve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarkerCurve#Length", "code_sample": "" }, "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex/param/0": { "documentation": "Represents a list of strings markers in chronological order." }, "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex/param/1": { "documentation": "" }, "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex/return/0": { "documentation": "A table containing the time and value of the marker at the provided index." }, "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex": { "documentation": "Returns the time and string value of the marker at the provided index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex/param/1" } ], "returns": [ "@roblox/globaltype/MarkerCurve.GetMarkerAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarkerCurve#GetMarkerAtIndex", "code_sample": "" }, "@roblox/globaltype/MarkerCurve.GetMarkers/param/0": { "documentation": "Represents a list of strings markers in chronological order." }, "@roblox/globaltype/MarkerCurve.GetMarkers/return/0": { "documentation": "An array of tables containing the time and value of all markers in the MarkerCurve." }, "@roblox/globaltype/MarkerCurve.GetMarkers": { "documentation": "Returns the time and string value of all markers in the MarkerCurve.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarkerCurve.GetMarkers/param/0" } ], "returns": [ "@roblox/globaltype/MarkerCurve.GetMarkers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarkerCurve#GetMarkers", "code_sample": "" }, "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/param/0": { "documentation": "Represents a list of strings markers in chronological order." }, "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/param/1": { "documentation": "Time at which the marker should be added." }, "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/param/2": { "documentation": "String value associated with this marker." }, "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/return/0": { "documentation": "A table containing a boolean and a number. The boolean is true if the call adds a new marker and false if it modifies an existing marker at the provided time. The number is the index of the added marker." }, "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime": { "documentation": "Inserts a marker with the provided string value at the provided time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/param/1" }, { "name": "marker", "documentation": "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/param/2" } ], "returns": [ "@roblox/globaltype/MarkerCurve.InsertMarkerAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarkerCurve#InsertMarkerAtTime", "code_sample": "" }, "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/param/0": { "documentation": "Represents a list of strings markers in chronological order." }, "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/param/1": { "documentation": "Index of the first marker to be removed in the MarkerCurve." }, "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/param/2": { "documentation": "How many markers to remove starting from the startingIndex." }, "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/return/0": { "documentation": "How many markers were actually removed (can be less than count if the MarkerCurve was too few markers)." }, "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex": { "documentation": "Remove several markers in the MarkerCurve starting at the provided index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/param/0" }, { "name": "startingIndex", "documentation": "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/param/1" }, { "name": "count", "documentation": "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/param/2" } ], "returns": [ "@roblox/globaltype/MarkerCurve.RemoveMarkerAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MarkerCurve#RemoveMarkerAtIndex", "code_sample": "" }, "@roblox/globaltype/SpotLight": { "documentation": "A light source that emits light directionally in the shape of a cone with a spherical base.", "keys": { "Angle": "@roblox/globaltype/SpotLight.Angle", "Face": "@roblox/globaltype/SpotLight.Face", "Range": "@roblox/globaltype/SpotLight.Range" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpotLight", "code_sample": "" }, "@roblox/globaltype/SpotLight.Angle": { "documentation": "The angle of which the light is shone from the SpotLight.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpotLight#Angle", "code_sample": "" }, "@roblox/globaltype/SpotLight.Face": { "documentation": "Sets the side of the parent that the SpotLight comes from.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpotLight#Face", "code_sample": "" }, "@roblox/globaltype/SpotLight.Range": { "documentation": "The size of the area that the SpotLight will illuminate.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SpotLight#Range", "code_sample": "" }, "@roblox/globaltype/Highlight": { "documentation": "A visual effect which you can use to call attention to a specific object within an experience.", "keys": { "Adornee": "@roblox/globaltype/Highlight.Adornee", "DepthMode": "@roblox/globaltype/Highlight.DepthMode", "Enabled": "@roblox/globaltype/Highlight.Enabled", "FillColor": "@roblox/globaltype/Highlight.FillColor", "FillTransparency": "@roblox/globaltype/Highlight.FillTransparency", "OutlineColor": "@roblox/globaltype/Highlight.OutlineColor", "OutlineTransparency": "@roblox/globaltype/Highlight.OutlineTransparency" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight", "code_sample": "" }, "@roblox/globaltype/Highlight.Adornee": { "documentation": "The Instance that the Highlight is applied to.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#Adornee", "code_sample": "" }, "@roblox/globaltype/Highlight.DepthMode": { "documentation": "Controls how the Highlight effect displays with respect to other objects in the world.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#DepthMode", "code_sample": "" }, "@roblox/globaltype/Highlight.Enabled": { "documentation": "Sets whether or not the highlight is enabled.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#Enabled", "code_sample": "" }, "@roblox/globaltype/Highlight.FillColor": { "documentation": "Sets the Color3 value of the highlight's interior.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#FillColor", "code_sample": "" }, "@roblox/globaltype/Highlight.FillTransparency": { "documentation": "Sets the transparency of the highlight's interior.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#FillTransparency", "code_sample": "" }, "@roblox/globaltype/Highlight.OutlineColor": { "documentation": "Sets the Color3 value of the highlight's outline.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#OutlineColor", "code_sample": "" }, "@roblox/globaltype/Highlight.OutlineTransparency": { "documentation": "Sets the transparency of the highlight's outline.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Highlight#OutlineTransparency", "code_sample": "" }, "@roblox/globaltype/Tween": { "documentation": "The Tween object controls the playback of an interpolation.", "keys": { "Instance": "@roblox/globaltype/Tween.Instance", "TweenInfo": "@roblox/globaltype/Tween.TweenInfo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tween", "code_sample": "local TweenService = game:GetService(\"TweenService\")\n\nlocal part = Instance.new(\"Part\")\npart.Position = Vector3.new(0, 10, 0)\npart.Color = Color3.new(1, 0, 0)\npart.Anchored = true\npart.Parent = game.Workspace\n\nlocal goal = {}\ngoal.Position = Vector3.new(10, 10, 0)\ngoal.Color = Color3.new(0, 1, 0)\n\nlocal tweenInfo = TweenInfo.new(5)\n\nlocal tween = TweenService:Create(part, tweenInfo, goal)\n\ntween:Play()" }, "@roblox/globaltype/Tween.Instance": { "documentation": "Read-only property that points to the Instance whose properties are being interpolated by the tween.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tween#Instance", "code_sample": "local TweenService = game:GetService(\"TweenService\")\n\nlocal function isInstanceAPart(tween)\n\tlocal instance = tween.Instance\n\treturn instance:IsA(\"BasePart\")\nend\n\nlocal tweenInfo = TweenInfo.new()\nlocal instance = Instance.new(\"Part\")\n\nlocal tween = TweenService:Create(instance, tweenInfo, {\n\tTransparency = 1,\n})\n\nprint(isInstanceAPart(tween))" }, "@roblox/globaltype/Tween.TweenInfo": { "documentation": "Read-only property that includes information on how the interpolation of the Tween is to be carried out.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Tween#TweenInfo", "code_sample": "-- A TweenInfo with all default parameters\nTweenInfo.new()\n\n-- A TweenInfo with its time set to 0.5 seconds.\nTweenInfo.new(0.5)\n\n-- A TweenInfo with its easing style set to Back.\nTweenInfo.new(0.5, Enum.EasingStyle.Back)\n\n-- A TweenInfo with its easing direction set to In.\nTweenInfo.new(0.5, Enum.EasingStyle.Back, Enum.EasingDirection.In)\n\n-- A TweenInfo that repeats itself 4 times.\nTweenInfo.new(0.5, Enum.EasingStyle.Back, Enum.EasingDirection.In, 4)\n\n-- A TweenInfo that reverses its interpolation after reaching its goal.\nTweenInfo.new(0.5, Enum.EasingStyle.Back, Enum.EasingDirection.In, 4, true)\n\n-- A TweenInfo that loops indefinitely.\nTweenInfo.new(0.5, Enum.EasingStyle.Back, Enum.EasingDirection.In, -1, true)\n\n-- A TweenInfo with a delay of 1 second between each interpolation.\nTweenInfo.new(0.5, Enum.EasingStyle.Back, Enum.EasingDirection.In, 4, true, 1)" }, "@roblox/globaltype/SurfaceGuiBase": { "documentation": "", "keys": { "Active": "@roblox/globaltype/SurfaceGuiBase.Active", "Adornee": "@roblox/globaltype/SurfaceGuiBase.Adornee", "Face": "@roblox/globaltype/SurfaceGuiBase.Face" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase", "code_sample": "" }, "@roblox/globaltype/SurfaceGuiBase.Active": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase#Active", "code_sample": "" }, "@roblox/globaltype/SurfaceGuiBase.Adornee": { "documentation": "BasePart on which to apply the SurfaceGui, overriding the default parent association.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase#Adornee", "code_sample": "" }, "@roblox/globaltype/SurfaceGuiBase.Face": { "documentation": "NormalId face upon which to apply the SurfaceGui.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SurfaceGuiBase#Face", "code_sample": "" }, "@roblox/globaltype/FloatCurve": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value.", "keys": { "Length": "@roblox/globaltype/FloatCurve.Length", "GetKeyAtIndex": "@roblox/globaltype/FloatCurve.GetKeyAtIndex", "GetKeyIndicesAtTime": "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime", "GetKeys": "@roblox/globaltype/FloatCurve.GetKeys", "GetValueAtTime": "@roblox/globaltype/FloatCurve.GetValueAtTime", "InsertKey": "@roblox/globaltype/FloatCurve.InsertKey", "RemoveKeyAtIndex": "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex", "SetKeys": "@roblox/globaltype/FloatCurve.SetKeys" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve", "code_sample": "" }, "@roblox/globaltype/FloatCurve.Length": { "documentation": "Number of keys in the float curve.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#Length", "code_sample": "" }, "@roblox/globaltype/FloatCurve.GetKeyAtIndex/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.GetKeyAtIndex/param/1": { "documentation": "" }, "@roblox/globaltype/FloatCurve.GetKeyAtIndex/return/0": { "documentation": "" }, "@roblox/globaltype/FloatCurve.GetKeyAtIndex": { "documentation": "Returns a copy of a key at a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.GetKeyAtIndex/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/FloatCurve.GetKeyAtIndex/param/1" } ], "returns": [ "@roblox/globaltype/FloatCurve.GetKeyAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#GetKeyAtIndex", "code_sample": "" }, "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime/param/1": { "documentation": "" }, "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime/return/0": { "documentation": "" }, "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime": { "documentation": "Returns the index of the last and first key of a period of time.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime/param/1" } ], "returns": [ "@roblox/globaltype/FloatCurve.GetKeyIndicesAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#GetKeyIndicesAtTime", "code_sample": "" }, "@roblox/globaltype/FloatCurve.GetKeys/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.GetKeys/return/0": { "documentation": "Array of FloatCurveKeys." }, "@roblox/globaltype/FloatCurve.GetKeys": { "documentation": "Returns a copy of all the keys in the FloatCurve as a Luau array of FloatCurveKeys.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.GetKeys/param/0" } ], "returns": [ "@roblox/globaltype/FloatCurve.GetKeys/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#GetKeys", "code_sample": "" }, "@roblox/globaltype/FloatCurve.GetValueAtTime/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.GetValueAtTime/param/1": { "documentation": "Time at which to sample the curve." }, "@roblox/globaltype/FloatCurve.GetValueAtTime/return/0": { "documentation": "Value of the curve at the requested time." }, "@roblox/globaltype/FloatCurve.GetValueAtTime": { "documentation": "Samples the float curve at a given time passed as argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.GetValueAtTime/param/0" }, { "name": "time", "documentation": "@roblox/globaltype/FloatCurve.GetValueAtTime/param/1" } ], "returns": [ "@roblox/globaltype/FloatCurve.GetValueAtTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#GetValueAtTime", "code_sample": "" }, "@roblox/globaltype/FloatCurve.InsertKey/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.InsertKey/param/1": { "documentation": "FloatCurveKey to insert." }, "@roblox/globaltype/FloatCurve.InsertKey/return/0": { "documentation": "(see description) ." }, "@roblox/globaltype/FloatCurve.InsertKey": { "documentation": "Adds the key passed as an argument to this curve. If a key at the same time is found, it will be replaced.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.InsertKey/param/0" }, { "name": "key", "documentation": "@roblox/globaltype/FloatCurve.InsertKey/param/1" } ], "returns": [ "@roblox/globaltype/FloatCurve.InsertKey/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#InsertKey", "code_sample": "" }, "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/param/1": { "documentation": "Starting index from which to remove keys." }, "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/param/2": { "documentation": "Number of keys to remove." }, "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/return/0": { "documentation": "Number of keys removed." }, "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex": { "documentation": "Removes a given number of keys starting from a given index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/param/0" }, { "name": "startingIndex", "documentation": "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/param/1" }, { "name": "count", "documentation": "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/param/2" } ], "returns": [ "@roblox/globaltype/FloatCurve.RemoveKeyAtIndex/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#RemoveKeyAtIndex", "code_sample": "" }, "@roblox/globaltype/FloatCurve.SetKeys/param/0": { "documentation": "A sorted list of time-value pairs that define a curve. Used to animate a single numerical value." }, "@roblox/globaltype/FloatCurve.SetKeys/param/1": { "documentation": "Array of FloatCurveKeys." }, "@roblox/globaltype/FloatCurve.SetKeys/return/0": { "documentation": "Number of keys inserted." }, "@roblox/globaltype/FloatCurve.SetKeys": { "documentation": "Resets this curve's keys using the FloatCurveKey array passed as an argument.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FloatCurve.SetKeys/param/0" }, { "name": "keys", "documentation": "@roblox/globaltype/FloatCurve.SetKeys/param/1" } ], "returns": [ "@roblox/globaltype/FloatCurve.SetKeys/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FloatCurve#SetKeys", "code_sample": "" }, "@roblox/globaltype/BodyPartDescription": { "documentation": "Describes the appearance of an avatar body part for the HumanoidDescription.", "keys": { "AssetId": "@roblox/globaltype/BodyPartDescription.AssetId", "BodyPart": "@roblox/globaltype/BodyPartDescription.BodyPart", "Color": "@roblox/globaltype/BodyPartDescription.Color", "HeadShape": "@roblox/globaltype/BodyPartDescription.HeadShape", "Instance": "@roblox/globaltype/BodyPartDescription.Instance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription", "code_sample": "" }, "@roblox/globaltype/BodyPartDescription.AssetId": { "documentation": "The asset ID that should be applied when applying this BodyPartDescription.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#AssetId", "code_sample": "" }, "@roblox/globaltype/BodyPartDescription.BodyPart": { "documentation": "The type of body part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#BodyPart", "code_sample": "" }, "@roblox/globaltype/BodyPartDescription.Color": { "documentation": "The Color3 for this body part.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#Color", "code_sample": "" }, "@roblox/globaltype/BodyPartDescription.HeadShape": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#HeadShape", "code_sample": "" }, "@roblox/globaltype/BodyPartDescription.Instance": { "documentation": "A reference to the Instance that should be applied when applying this BodyPartDescription.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#Instance", "code_sample": "" }, "@roblox/globaltype/AdService": { "documentation": "A class that allows the display of mobile video ads.", "keys": { "CreateAdRewardFromDevProductId": "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId", "GetAdAvailabilityNowAsync": "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync", "RegisterAdOpportunityAsync": "@roblox/globaltype/AdService.RegisterAdOpportunityAsync", "ShowRewardedVideoAdAsync": "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync", "ShowVideoAd": "@roblox/globaltype/AdService.ShowVideoAd", "UnregisterAdOpportunity": "@roblox/globaltype/AdService.UnregisterAdOpportunity" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService", "code_sample": "" }, "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId/param/0": { "documentation": "A class that allows the display of mobile video ads." }, "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId/param/1": { "documentation": "The ID of the developer product you want to grant as a reward." }, "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId/return/0": { "documentation": "" }, "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId": { "documentation": "Creates a reward to give users who watch an entire video ad.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId/param/0" }, { "name": "devProductId", "documentation": "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId/param/1" } ], "returns": [ "@roblox/globaltype/AdService.CreateAdRewardFromDevProductId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId", "code_sample": "" }, "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync/param/0": { "documentation": "A class that allows the display of mobile video ads." }, "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync/param/1": { "documentation": "The format of the requested ad. For example, RewardedVideo." }, "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync": { "documentation": "Checks if a video ad is available to be played to the current user inside the experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync/param/0" }, { "name": "adFormat", "documentation": "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync/param/1" } ], "returns": [ "@roblox/globaltype/AdService.GetAdAvailabilityNowAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#GetAdAvailabilityNowAsync", "code_sample": "" }, "@roblox/globaltype/AdService.RegisterAdOpportunityAsync/param/0": { "documentation": "A class that allows the display of mobile video ads." }, "@roblox/globaltype/AdService.RegisterAdOpportunityAsync/param/1": { "documentation": "" }, "@roblox/globaltype/AdService.RegisterAdOpportunityAsync/param/2": { "documentation": "The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements." }, "@roblox/globaltype/AdService.RegisterAdOpportunityAsync": { "documentation": "Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.RegisterAdOpportunityAsync/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/AdService.RegisterAdOpportunityAsync/param/1" }, { "name": "placementId", "documentation": "@roblox/globaltype/AdService.RegisterAdOpportunityAsync/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync", "code_sample": "" }, "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/0": { "documentation": "A class that allows the display of mobile video ads." }, "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/1": { "documentation": "The Player object for whom you are fetching the ad for." }, "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/2": { "documentation": "The reward object for the reward you want to grant the user who watches an ad to completion." }, "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/3": { "documentation": "The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements." }, "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/return/0": { "documentation": "" }, "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync": { "documentation": "Plays the video ad to the current user inside the experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/1" }, { "name": "reward", "documentation": "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/2" }, { "name": "placementId", "documentation": "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/param/3" } ], "returns": [ "@roblox/globaltype/AdService.ShowRewardedVideoAdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#ShowRewardedVideoAdAsync", "code_sample": "local reward = AdService:CreateAdRewardFromDevProductId(100)\nlocal result = AdService:ShowRewardedVideoAdAsync(player, reward)" }, "@roblox/globaltype/AdService.ShowVideoAd/param/0": { "documentation": "A class that allows the display of mobile video ads." }, "@roblox/globaltype/AdService.ShowVideoAd": { "documentation": "Deprecated: ShowVideoAd has been decommissioned and is no longer operational.
Show mobile video advertisements.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.ShowVideoAd/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#ShowVideoAd", "code_sample": "" }, "@roblox/globaltype/AdService.UnregisterAdOpportunity/param/0": { "documentation": "A class that allows the display of mobile video ads." }, "@roblox/globaltype/AdService.UnregisterAdOpportunity/param/1": { "documentation": "" }, "@roblox/globaltype/AdService.UnregisterAdOpportunity": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.UnregisterAdOpportunity/param/0" }, { "name": "instance", "documentation": "@roblox/globaltype/AdService.UnregisterAdOpportunity/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity", "code_sample": "" }, "@roblox/globaltype/AdService.VideoAdClosed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AdService.VideoAdClosed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/AdService.VideoAdClosed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/AdService.VideoAdClosed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AdService.VideoAdClosed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/AdService.VideoAdClosed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/AdService.VideoAdClosed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AdService.VideoAdClosed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/AdService.VideoAdClosed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/AdService.VideoAdClosed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/AdService.VideoAdClosed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AdService.VideoAdClosed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/AdService.VideoAdClosed": { "documentation": "Deprecated: VideoAdClosed has been decommissioned and is no longer operational.
Fires when an AdService video closes.", "keys": { "Connect": "@roblox/globaltype/AdService.VideoAdClosed.Connect", "ConnectParallel": "@roblox/globaltype/AdService.VideoAdClosed.ConnectParallel", "Once": "@roblox/globaltype/AdService.VideoAdClosed.Once", "Wait": "@roblox/globaltype/AdService.VideoAdClosed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AdService#VideoAdClosed", "code_sample": "" }, "@roblox/globaltype/Bone": { "documentation": "Bones are non-rendered objects that drive the movement of one or more parts for the purposes of animation, or creating clothing and characters.", "keys": { "Transform": "@roblox/globaltype/Bone.Transform", "TransformedCFrame": "@roblox/globaltype/Bone.TransformedCFrame", "TransformedWorldCFrame": "@roblox/globaltype/Bone.TransformedWorldCFrame" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Bone", "code_sample": "" }, "@roblox/globaltype/Bone.Transform": { "documentation": "Determines the current animated offset of the bone in its local space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Bone#Transform", "code_sample": "" }, "@roblox/globaltype/Bone.TransformedCFrame": { "documentation": "Describes the combined CFrame offset of the bone and the current animation offset in the bone local space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Bone#TransformedCFrame", "code_sample": "" }, "@roblox/globaltype/Bone.TransformedWorldCFrame": { "documentation": "Describes the combined CFrame offset of the bone and the current animation offset in world space.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Bone#TransformedWorldCFrame", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription": { "documentation": "", "keys": { "Chest": "@roblox/globaltype/HumanoidRigDescription.Chest", "ChestRangeMax": "@roblox/globaltype/HumanoidRigDescription.ChestRangeMax", "ChestRangeMin": "@roblox/globaltype/HumanoidRigDescription.ChestRangeMin", "ChestSize": "@roblox/globaltype/HumanoidRigDescription.ChestSize", "ChestTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.ChestTposeAdjustment", "HeadBase": "@roblox/globaltype/HumanoidRigDescription.HeadBase", "HeadBaseRangeMax": "@roblox/globaltype/HumanoidRigDescription.HeadBaseRangeMax", "HeadBaseRangeMin": "@roblox/globaltype/HumanoidRigDescription.HeadBaseRangeMin", "HeadBaseSize": "@roblox/globaltype/HumanoidRigDescription.HeadBaseSize", "HeadBaseTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.HeadBaseTposeAdjustment", "LeftAnkle": "@roblox/globaltype/HumanoidRigDescription.LeftAnkle", "LeftAnkleRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftAnkleRangeMax", "LeftAnkleRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftAnkleRangeMin", "LeftAnkleSize": "@roblox/globaltype/HumanoidRigDescription.LeftAnkleSize", "LeftAnkleTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftAnkleTposeAdjustment", "LeftClavicle": "@roblox/globaltype/HumanoidRigDescription.LeftClavicle", "LeftClavicleRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftClavicleRangeMax", "LeftClavicleRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftClavicleRangeMin", "LeftClavicleSize": "@roblox/globaltype/HumanoidRigDescription.LeftClavicleSize", "LeftClavicleTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftClavicleTposeAdjustment", "LeftElbow": "@roblox/globaltype/HumanoidRigDescription.LeftElbow", "LeftElbowRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftElbowRangeMax", "LeftElbowRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftElbowRangeMin", "LeftElbowSize": "@roblox/globaltype/HumanoidRigDescription.LeftElbowSize", "LeftElbowTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftElbowTposeAdjustment", "LeftHip": "@roblox/globaltype/HumanoidRigDescription.LeftHip", "LeftHipRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftHipRangeMax", "LeftHipRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftHipRangeMin", "LeftHipSize": "@roblox/globaltype/HumanoidRigDescription.LeftHipSize", "LeftHipTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftHipTposeAdjustment", "LeftKnee": "@roblox/globaltype/HumanoidRigDescription.LeftKnee", "LeftKneeRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftKneeRangeMax", "LeftKneeRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftKneeRangeMin", "LeftKneeSize": "@roblox/globaltype/HumanoidRigDescription.LeftKneeSize", "LeftKneeTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftKneeTposeAdjustment", "LeftShoulder": "@roblox/globaltype/HumanoidRigDescription.LeftShoulder", "LeftShoulderRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftShoulderRangeMax", "LeftShoulderRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftShoulderRangeMin", "LeftShoulderSize": "@roblox/globaltype/HumanoidRigDescription.LeftShoulderSize", "LeftShoulderTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftShoulderTposeAdjustment", "LeftToes": "@roblox/globaltype/HumanoidRigDescription.LeftToes", "LeftToesRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftToesRangeMax", "LeftToesRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftToesRangeMin", "LeftToesSize": "@roblox/globaltype/HumanoidRigDescription.LeftToesSize", "LeftToesTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftToesTposeAdjustment", "LeftWrist": "@roblox/globaltype/HumanoidRigDescription.LeftWrist", "LeftWristRangeMax": "@roblox/globaltype/HumanoidRigDescription.LeftWristRangeMax", "LeftWristRangeMin": "@roblox/globaltype/HumanoidRigDescription.LeftWristRangeMin", "LeftWristSize": "@roblox/globaltype/HumanoidRigDescription.LeftWristSize", "LeftWristTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.LeftWristTposeAdjustment", "Neck": "@roblox/globaltype/HumanoidRigDescription.Neck", "NeckRangeMax": "@roblox/globaltype/HumanoidRigDescription.NeckRangeMax", "NeckRangeMin": "@roblox/globaltype/HumanoidRigDescription.NeckRangeMin", "NeckSize": "@roblox/globaltype/HumanoidRigDescription.NeckSize", "NeckTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.NeckTposeAdjustment", "OriginOffset": "@roblox/globaltype/HumanoidRigDescription.OriginOffset", "Pelvis": "@roblox/globaltype/HumanoidRigDescription.Pelvis", "PelvisRangeMax": "@roblox/globaltype/HumanoidRigDescription.PelvisRangeMax", "PelvisRangeMin": "@roblox/globaltype/HumanoidRigDescription.PelvisRangeMin", "PelvisSize": "@roblox/globaltype/HumanoidRigDescription.PelvisSize", "PelvisTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.PelvisTposeAdjustment", "RightAnkle": "@roblox/globaltype/HumanoidRigDescription.RightAnkle", "RightAnkleRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightAnkleRangeMax", "RightAnkleRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightAnkleRangeMin", "RightAnkleSize": "@roblox/globaltype/HumanoidRigDescription.RightAnkleSize", "RightAnkleTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightAnkleTposeAdjustment", "RightClavicle": "@roblox/globaltype/HumanoidRigDescription.RightClavicle", "RightClavicleRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightClavicleRangeMax", "RightClavicleRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightClavicleRangeMin", "RightClavicleSize": "@roblox/globaltype/HumanoidRigDescription.RightClavicleSize", "RightClavicleTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightClavicleTposeAdjustment", "RightElbow": "@roblox/globaltype/HumanoidRigDescription.RightElbow", "RightElbowRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightElbowRangeMax", "RightElbowRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightElbowRangeMin", "RightElbowSize": "@roblox/globaltype/HumanoidRigDescription.RightElbowSize", "RightElbowTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightElbowTposeAdjustment", "RightHip": "@roblox/globaltype/HumanoidRigDescription.RightHip", "RightHipRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightHipRangeMax", "RightHipRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightHipRangeMin", "RightHipSize": "@roblox/globaltype/HumanoidRigDescription.RightHipSize", "RightHipTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightHipTposeAdjustment", "RightKnee": "@roblox/globaltype/HumanoidRigDescription.RightKnee", "RightKneeRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightKneeRangeMax", "RightKneeRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightKneeRangeMin", "RightKneeSize": "@roblox/globaltype/HumanoidRigDescription.RightKneeSize", "RightKneeTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightKneeTposeAdjustment", "RightShoulder": "@roblox/globaltype/HumanoidRigDescription.RightShoulder", "RightShoulderRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightShoulderRangeMax", "RightShoulderRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightShoulderRangeMin", "RightShoulderSize": "@roblox/globaltype/HumanoidRigDescription.RightShoulderSize", "RightShoulderTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightShoulderTposeAdjustment", "RightToes": "@roblox/globaltype/HumanoidRigDescription.RightToes", "RightToesRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightToesRangeMax", "RightToesRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightToesRangeMin", "RightToesSize": "@roblox/globaltype/HumanoidRigDescription.RightToesSize", "RightToesTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightToesTposeAdjustment", "RightWrist": "@roblox/globaltype/HumanoidRigDescription.RightWrist", "RightWristRangeMax": "@roblox/globaltype/HumanoidRigDescription.RightWristRangeMax", "RightWristRangeMin": "@roblox/globaltype/HumanoidRigDescription.RightWristRangeMin", "RightWristSize": "@roblox/globaltype/HumanoidRigDescription.RightWristSize", "RightWristTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RightWristTposeAdjustment", "Root": "@roblox/globaltype/HumanoidRigDescription.Root", "RootRangeMax": "@roblox/globaltype/HumanoidRigDescription.RootRangeMax", "RootRangeMin": "@roblox/globaltype/HumanoidRigDescription.RootRangeMin", "RootSize": "@roblox/globaltype/HumanoidRigDescription.RootSize", "RootTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.RootTposeAdjustment", "Waist": "@roblox/globaltype/HumanoidRigDescription.Waist", "WaistRangeMax": "@roblox/globaltype/HumanoidRigDescription.WaistRangeMax", "WaistRangeMin": "@roblox/globaltype/HumanoidRigDescription.WaistRangeMin", "WaistSize": "@roblox/globaltype/HumanoidRigDescription.WaistSize", "WaistTposeAdjustment": "@roblox/globaltype/HumanoidRigDescription.WaistTposeAdjustment", "GetJointFromName": "@roblox/globaltype/HumanoidRigDescription.GetJointFromName", "GetJointNames": "@roblox/globaltype/HumanoidRigDescription.GetJointNames", "GetR15JointNames": "@roblox/globaltype/HumanoidRigDescription.GetR15JointNames", "GetR6JointNames": "@roblox/globaltype/HumanoidRigDescription.GetR6JointNames" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.Chest": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Chest", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.ChestRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.ChestRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.ChestSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.ChestTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#ChestTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.HeadBase": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBase", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.HeadBaseRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.HeadBaseRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.HeadBaseSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.HeadBaseTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#HeadBaseTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftAnkle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkle", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftAnkleRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftAnkleRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftAnkleSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftAnkleTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftAnkleTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftClavicle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicle", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftClavicleRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftClavicleRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftClavicleSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftClavicleTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftClavicleTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftElbow": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbow", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftElbowRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftElbowRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftElbowSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftElbowTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftElbowTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftHip": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHip", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftHipRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftHipRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftHipSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftHipTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftHipTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftKnee": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKnee", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftKneeRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftKneeRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftKneeSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftKneeTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftKneeTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftShoulder": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulder", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftShoulderRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftShoulderRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftShoulderSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftShoulderTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftShoulderTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftToes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToes", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftToesRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToesRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftToesRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToesRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftToesSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToesSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftToesTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftToesTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftWrist": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWrist", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftWristRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftWristRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftWristSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.LeftWristTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#LeftWristTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.Neck": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Neck", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.NeckRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.NeckRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.NeckSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.NeckTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#NeckTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.OriginOffset": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#OriginOffset", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.Pelvis": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Pelvis", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.PelvisRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.PelvisRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.PelvisSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.PelvisTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#PelvisTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightAnkle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkle", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightAnkleRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightAnkleRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightAnkleSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightAnkleTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightAnkleTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightClavicle": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicle", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightClavicleRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightClavicleRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightClavicleSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightClavicleTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightClavicleTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightElbow": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbow", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightElbowRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightElbowRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightElbowSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightElbowTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightElbowTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightHip": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHip", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightHipRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightHipRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightHipSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightHipTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightHipTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightKnee": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKnee", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightKneeRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightKneeRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightKneeSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightKneeTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightKneeTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightShoulder": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulder", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightShoulderRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightShoulderRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightShoulderSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightShoulderTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightShoulderTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightToes": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToes", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightToesRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToesRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightToesRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToesRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightToesSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToesSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightToesTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightToesTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightWrist": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWrist", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightWristRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightWristRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightWristSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RightWristTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RightWristTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.Root": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Root", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RootRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RootRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RootSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.RootTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#RootTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.Waist": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#Waist", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.WaistRangeMax": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistRangeMax", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.WaistRangeMin": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistRangeMin", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.WaistSize": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistSize", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.WaistTposeAdjustment": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#WaistTposeAdjustment", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointFromName/param/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointFromName/param/1": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointFromName/return/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointFromName": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidRigDescription.GetJointFromName/param/0" }, { "name": "name", "documentation": "@roblox/globaltype/HumanoidRigDescription.GetJointFromName/param/1" } ], "returns": [ "@roblox/globaltype/HumanoidRigDescription.GetJointFromName/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointFromName", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointNames/param/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointNames/return/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetJointNames": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidRigDescription.GetJointNames/param/0" } ], "returns": [ "@roblox/globaltype/HumanoidRigDescription.GetJointNames/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.GetR15JointNames/param/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetR15JointNames/return/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetR15JointNames": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidRigDescription.GetR15JointNames/param/0" } ], "returns": [ "@roblox/globaltype/HumanoidRigDescription.GetR15JointNames/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames", "code_sample": "" }, "@roblox/globaltype/HumanoidRigDescription.GetR6JointNames/param/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetR6JointNames/return/0": { "documentation": "" }, "@roblox/globaltype/HumanoidRigDescription.GetR6JointNames": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/HumanoidRigDescription.GetR6JointNames/param/0" } ], "returns": [ "@roblox/globaltype/HumanoidRigDescription.GetR6JointNames/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames", "code_sample": "" }, "@roblox/globaltype/Players": { "documentation": "A service that contains presently connected Player objects.", "keys": { "BanningEnabled": "@roblox/globaltype/Players.BanningEnabled", "BubbleChat": "@roblox/globaltype/Players.BubbleChat", "CharacterAutoLoads": "@roblox/globaltype/Players.CharacterAutoLoads", "ClassicChat": "@roblox/globaltype/Players.ClassicChat", "LocalPlayer": "@roblox/globaltype/Players.LocalPlayer", "localPlayer": "@roblox/globaltype/Players.localPlayer", "MaxPlayers": "@roblox/globaltype/Players.MaxPlayers", "NumPlayers": "@roblox/globaltype/Players.NumPlayers", "numPlayers": "@roblox/globaltype/Players.numPlayers", "PreferredPlayers": "@roblox/globaltype/Players.PreferredPlayers", "RespawnTime": "@roblox/globaltype/Players.RespawnTime", "UseStrafingAnimations": "@roblox/globaltype/Players.UseStrafingAnimations", "BanAsync": "@roblox/globaltype/Players.BanAsync", "Chat": "@roblox/globaltype/Players.Chat", "CreateHumanoidModelFromDescriptionAsync": "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync", "CreateHumanoidModelFromDescription": "@roblox/globaltype/Players.CreateHumanoidModelFromDescription", "CreateHumanoidModelFromUserIdAsync": "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync", "CreateHumanoidModelFromUserId": "@roblox/globaltype/Players.CreateHumanoidModelFromUserId", "GetBanHistoryAsync": "@roblox/globaltype/Players.GetBanHistoryAsync", "GetCharacterAppearanceAsync": "@roblox/globaltype/Players.GetCharacterAppearanceAsync", "GetCharacterAppearanceInfoAsync": "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync", "GetFriendsAsync": "@roblox/globaltype/Players.GetFriendsAsync", "GetHumanoidDescriptionFromOutfitIdAsync": "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync", "GetHumanoidDescriptionFromOutfitId": "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId", "GetHumanoidDescriptionFromUserIdAsync": "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync", "GetHumanoidDescriptionFromUserId": "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId", "GetNameFromUserIdAsync": "@roblox/globaltype/Players.GetNameFromUserIdAsync", "GetPlayerByUserId": "@roblox/globaltype/Players.GetPlayerByUserId", "GetPlayerFromCharacter": "@roblox/globaltype/Players.GetPlayerFromCharacter", "GetPlayers": "@roblox/globaltype/Players.GetPlayers", "getPlayers": "@roblox/globaltype/Players.getPlayers", "GetUserIdFromNameAsync": "@roblox/globaltype/Players.GetUserIdFromNameAsync", "GetUserThumbnailAsync": "@roblox/globaltype/Players.GetUserThumbnailAsync", "playerFromCharacter": "@roblox/globaltype/Players.playerFromCharacter", "players": "@roblox/globaltype/Players.players", "SetChatStyle": "@roblox/globaltype/Players.SetChatStyle", "TeamChat": "@roblox/globaltype/Players.TeamChat", "UnbanAsync": "@roblox/globaltype/Players.UnbanAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players", "code_sample": "" }, "@roblox/globaltype/Players.BanningEnabled": { "documentation": "Enables or disables the three Players methods (BanAsync(), UnbanAsync(), and GetBanHistoryAsync()) that constitute the ban API. This property is not scriptable and can only be modified in Studio.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#BanningEnabled", "code_sample": "" }, "@roblox/globaltype/Players.BubbleChat": { "documentation": "Indicates whether or not bubble chat is enabled. It is set with the Players:SetChatStyle() method.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#BubbleChat", "code_sample": "" }, "@roblox/globaltype/Players.CharacterAutoLoads": { "documentation": "Indicates whether characters will respawn automatically.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#CharacterAutoLoads", "code_sample": "" }, "@roblox/globaltype/Players.ClassicChat": { "documentation": "Indicates whether or not classic chat is enabled; set by the Players:SetChatStyle() method.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#ClassicChat", "code_sample": "" }, "@roblox/globaltype/Players.LocalPlayer": { "documentation": "The Player that the LocalScript is running for.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#LocalPlayer", "code_sample": "" }, "@roblox/globaltype/Players.localPlayer": { "documentation": "Deprecated: This property is a deprecated variant of Players.LocalPlayer which should be used instead.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#localPlayer", "code_sample": "" }, "@roblox/globaltype/Players.MaxPlayers": { "documentation": "The maximum number of players that can be in a server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#MaxPlayers", "code_sample": "" }, "@roblox/globaltype/Players.NumPlayers": { "documentation": "Deprecated: This item is deprecated. Instead, of using this item, you should count the number of players returned by Players:GetPlayers().
Returns the number of people in the server at the current time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#NumPlayers", "code_sample": "" }, "@roblox/globaltype/Players.numPlayers": { "documentation": "Deprecated: This property is a deprecated variant of Players.NumPlayers which has also been deprecated. Neither property should be used in new work. Instead, you should count the number of players returned by Players:GetPlayers().
Returns the number of people in the server at the current time.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#numPlayers", "code_sample": "" }, "@roblox/globaltype/Players.PreferredPlayers": { "documentation": "The preferred number of players for a server.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#PreferredPlayers", "code_sample": "" }, "@roblox/globaltype/Players.RespawnTime": { "documentation": "Controls the amount of time taken for a players character to respawn.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#RespawnTime", "code_sample": "" }, "@roblox/globaltype/Players.UseStrafingAnimations": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#UseStrafingAnimations", "code_sample": "" }, "@roblox/globaltype/Players.BanAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.BanAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Players.BanAsync": { "documentation": "Bans users from your experience, with options to specify duration, reason, whether the ban applies to the entire universe or just the current place, and more. This method is enabled and disabled by the Players.BanningEnabled property, which you can toggle in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.BanAsync/param/0" }, { "name": "config", "documentation": "@roblox/globaltype/Players.BanAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#BanAsync", "code_sample": "" }, "@roblox/globaltype/Players.Chat/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.Chat/param/1": { "documentation": "The message chatted." }, "@roblox/globaltype/Players.Chat": { "documentation": "Makes the local player chat the given message.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.Chat/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/Players.Chat/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#Chat", "code_sample": "" }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/1": { "documentation": "Specifies the appearance of the returned character." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/2": { "documentation": "Specifies whether the returned character will be R6 or R15." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/3": { "documentation": "The asset type verification mode." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/return/0": { "documentation": "A Humanoid character Model." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync": { "documentation": "Returns a character Model equipped with everything specified in the passed in HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/0" }, { "name": "description", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/1" }, { "name": "rigType", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/2" }, { "name": "assetTypeVerification", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/param/3" } ], "returns": [ "@roblox/globaltype/Players.CreateHumanoidModelFromDescriptionAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromDescriptionAsync", "code_sample": "" }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/1": { "documentation": "Specifies the appearance of the returned character." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/2": { "documentation": "Specifies whether the returned character will be R6 or R15." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/3": { "documentation": "The asset type verification mode." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/return/0": { "documentation": "A Humanoid character Model." }, "@roblox/globaltype/Players.CreateHumanoidModelFromDescription": { "documentation": "Deprecated: This method has been superseded by CreateHumanoidModelFromDescription().
Returns a character Model equipped with everything specified in the passed in HumanoidDescription.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/0" }, { "name": "description", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/1" }, { "name": "rigType", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/2" }, { "name": "assetTypeVerification", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/param/3" } ], "returns": [ "@roblox/globaltype/Players.CreateHumanoidModelFromDescription/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromDescription", "code_sample": "" }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync/param/1": { "documentation": "The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile)." }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync/return/0": { "documentation": "A Humanoid character Model." }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync": { "documentation": "Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.CreateHumanoidModelFromUserIdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromUserIdAsync", "code_sample": "game.Players:CreateHumanoidModelFromUserIdAsync(1).Parent = game.Workspace" }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserId/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserId/param/1": { "documentation": "The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile)." }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserId/return/0": { "documentation": "A Humanoid character Model." }, "@roblox/globaltype/Players.CreateHumanoidModelFromUserId": { "documentation": "Deprecated: This method has been superseded by CreateHumanoidModelFromUserIdAsync().
Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromUserId/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.CreateHumanoidModelFromUserId/param/1" } ], "returns": [ "@roblox/globaltype/Players.CreateHumanoidModelFromUserId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromUserId", "code_sample": "game.Players:CreateHumanoidModelFromUserIdAsync(1).Parent = game.Workspace" }, "@roblox/globaltype/Players.GetBanHistoryAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetBanHistoryAsync/param/1": { "documentation": "" }, "@roblox/globaltype/Players.GetBanHistoryAsync/return/0": { "documentation": "See BanHistoryPages for return reference." }, "@roblox/globaltype/Players.GetBanHistoryAsync": { "documentation": "Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the Players.BanningEnabled property, which you can toggle in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetBanHistoryAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetBanHistoryAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetBanHistoryAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetBanHistoryAsync", "code_sample": "" }, "@roblox/globaltype/Players.GetCharacterAppearanceAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetCharacterAppearanceAsync/param/1": { "documentation": "The Player.UserId of the specified player." }, "@roblox/globaltype/Players.GetCharacterAppearanceAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Players.GetCharacterAppearanceAsync": { "documentation": "Deprecated:
Returns a Model containing the assets which the player is wearing, excluding gear.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetCharacterAppearanceAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetCharacterAppearanceAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetCharacterAppearanceAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetCharacterAppearanceAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal USER_ID = 18697683\n\nlocal appearanceModel = Players:GetCharacterAppearanceAsync(USER_ID)\n\nappearanceModel.Parent = workspace" }, "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync/param/1": { "documentation": "The *userId of the specified player." }, "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync/return/0": { "documentation": "A dictionary containing information about the character appearance of a given user." }, "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync": { "documentation": "Returns information about the character appearance of a given user.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetCharacterAppearanceInfoAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetCharacterAppearanceInfoAsync", "code_sample": "" }, "@roblox/globaltype/Players.GetFriendsAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetFriendsAsync/param/1": { "documentation": "The user ID of the player being specified." }, "@roblox/globaltype/Players.GetFriendsAsync/return/0": { "documentation": "" }, "@roblox/globaltype/Players.GetFriendsAsync": { "documentation": "Returns a FriendPages object which contains information for all of the given player's connections.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetFriendsAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetFriendsAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetFriendsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetFriendsAsync", "code_sample": "" }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync/param/1": { "documentation": "The ID of the outfit for which the HumanoidDescription is sought." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync/return/0": { "documentation": "HumanoidDescription initialized with the specification for the passed in outfitId." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync": { "documentation": "Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitIdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitIdAsync", "code_sample": "" }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId/param/1": { "documentation": "The ID of the outfit for which the HumanoidDescription is sought." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId/return/0": { "documentation": "HumanoidDescription initialized with the specification for the passed in outfitId." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId": { "documentation": "Deprecated: This method has been superseded by GetHumanoidDescriptionFromOutfitIdAsync().
Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId/param/0" }, { "name": "outfitId", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetHumanoidDescriptionFromOutfitId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitId", "code_sample": "" }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync/param/1": { "documentation": "The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile)." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync/return/0": { "documentation": "HumanoidDescription initialized with the passed in user's avatar specification." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync": { "documentation": "Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserIdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromUserIdAsync", "code_sample": "game.Players:CreateHumanoidModelFromDescriptionAsync(\n\tgame.Players:GetHumanoidDescriptionFromUserIdAsync(1),\n\tEnum.HumanoidRigType.R15\n).Parent =\n\tgame.Workspace" }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId/param/1": { "documentation": "The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile)." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId/return/0": { "documentation": "HumanoidDescription initialized with the passed in user's avatar specification." }, "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId": { "documentation": "Deprecated: This method has been superseded by GetHumanoidDescriptionFromUserIdAsync().
Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetHumanoidDescriptionFromUserId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromUserId", "code_sample": "game.Players:CreateHumanoidModelFromDescriptionAsync(\n\tgame.Players:GetHumanoidDescriptionFromUserIdAsync(1),\n\tEnum.HumanoidRigType.R15\n).Parent =\n\tgame.Workspace" }, "@roblox/globaltype/Players.GetNameFromUserIdAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetNameFromUserIdAsync/param/1": { "documentation": "The Player.UserId of the player being specified." }, "@roblox/globaltype/Players.GetNameFromUserIdAsync/return/0": { "documentation": "The name of a user with the specified Player.UserId." }, "@roblox/globaltype/Players.GetNameFromUserIdAsync": { "documentation": "Sends a query to the Roblox website for the username of an account with a given UserId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetNameFromUserIdAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetNameFromUserIdAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetNameFromUserIdAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetNameFromUserIdAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\n-- Example Data:\n-- UserId: 118271 Name: \"RobloxRulez\"\n-- UserId: 131963979 Name: \"docsRule\"\n\nlocal nameOne = Players:GetNameFromUserIdAsync(118271)\nlocal nameTwo = Players:GetNameFromUserIdAsync(131963979)\n\nprint(nameOne, nameTwo)\n-- prints: \"RobloxRulez docsRule\"" }, "@roblox/globaltype/Players.GetPlayerByUserId/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetPlayerByUserId/param/1": { "documentation": "The Player.UserId of the player being specified." }, "@roblox/globaltype/Players.GetPlayerByUserId/return/0": { "documentation": "" }, "@roblox/globaltype/Players.GetPlayerByUserId": { "documentation": "Returns the Player with the given UserId if they are in-experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetPlayerByUserId/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetPlayerByUserId/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetPlayerByUserId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetPlayerByUserId", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal player = Players:GetPlayerByUserId(1)\n\nif player then\n\tprint(\"Player with userId 1 is in this server! Their name is: \" .. player.Name)\nelse\n\tprint(\"Player with userId 1 is not in this server!\")\nend" }, "@roblox/globaltype/Players.GetPlayerFromCharacter/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetPlayerFromCharacter/param/1": { "documentation": "A character instance that you want to get the player from." }, "@roblox/globaltype/Players.GetPlayerFromCharacter/return/0": { "documentation": "" }, "@roblox/globaltype/Players.GetPlayerFromCharacter": { "documentation": "Returns the Player whose Player.Character matches the given instance, or nil if one cannot be found.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetPlayerFromCharacter/param/0" }, { "name": "character", "documentation": "@roblox/globaltype/Players.GetPlayerFromCharacter/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetPlayerFromCharacter/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetPlayerFromCharacter", "code_sample": "local Players = game:GetService(\"Players\")\nlocal Workspace = game:GetService(\"Workspace\")\n\nlocal PLAYER_NAME = \"Nightriff\"\n\nlocal character = Workspace:FindFirstChild(PLAYER_NAME)\nlocal player = Players:GetPlayerFromCharacter(character)\n\nif player then\n\tprint(`Player {player.Name} ({player.UserId}) is in the game`)\nelse\n\tprint(`Player {PLAYER_NAME} is not in the game!`)\nend" }, "@roblox/globaltype/Players.GetPlayers/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetPlayers/return/0": { "documentation": "A table containing all the players in the server." }, "@roblox/globaltype/Players.GetPlayers": { "documentation": "Returns a table of all presently connected Player objects.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetPlayers/param/0" } ], "returns": [ "@roblox/globaltype/Players.GetPlayers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetPlayers", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onCharacterAdded(character)\n\t-- Give them sparkles on their head if they don't have them yet\n\tif not character:FindFirstChild(\"Sparkles\") then\n\t\tlocal sparkles = Instance.new(\"Sparkles\")\n\t\tsparkles.Parent = character:WaitForChild(\"Head\")\n\tend\nend\n\nlocal function onPlayerAdded(player)\n\t-- Check if they already spawned in\n\tif player.Character then\n\t\tonCharacterAdded(player.Character)\n\tend\n\t-- Listen for the player (re)spawning\n\tplayer.CharacterAdded:Connect(onCharacterAdded)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Players.getPlayers/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.getPlayers/return/0": { "documentation": "" }, "@roblox/globaltype/Players.getPlayers": { "documentation": "Deprecated: This function is a deprecated variant of Players:GetPlayers() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.getPlayers/param/0" } ], "returns": [ "@roblox/globaltype/Players.getPlayers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#getPlayers", "code_sample": "" }, "@roblox/globaltype/Players.GetUserIdFromNameAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetUserIdFromNameAsync/param/1": { "documentation": "The username of the player being specified." }, "@roblox/globaltype/Players.GetUserIdFromNameAsync/return/0": { "documentation": "The Player.UserId of a user whose name is specified." }, "@roblox/globaltype/Players.GetUserIdFromNameAsync": { "documentation": "Sends a query to the Roblox website for the userId of an account with a given username.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetUserIdFromNameAsync/param/0" }, { "name": "userName", "documentation": "@roblox/globaltype/Players.GetUserIdFromNameAsync/param/1" } ], "returns": [ "@roblox/globaltype/Players.GetUserIdFromNameAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetUserIdFromNameAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\n-- Example Data:\n-- UserId: 118271 Name: \"RobloxRulez\"\n-- UserId: 131963979 Name: \"docsRule\"\n\nlocal userIdOne = Players:GetUserIdFromNameAsync(\"RobloxRulez\")\nlocal userIdTwo = Players:GetUserIdFromNameAsync(\"docsRule\")\nprint(userIdOne, userIdTwo)\n-- prints: \"118271 131963979\"" }, "@roblox/globaltype/Players.GetUserThumbnailAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.GetUserThumbnailAsync/param/1": { "documentation": "The Player.UserId of the player being specified." }, "@roblox/globaltype/Players.GetUserThumbnailAsync/param/2": { "documentation": "A ThumbnailType describing the type of thumbnail." }, "@roblox/globaltype/Players.GetUserThumbnailAsync/param/3": { "documentation": "A ThumbnailSize specifying the size of the thumbnail." }, "@roblox/globaltype/Players.GetUserThumbnailAsync/return/0": { "documentation": "A tuple containing the content URL of a user thumbnail based on the specified parameters, and a bool describing if the image is ready to be used or not." }, "@roblox/globaltype/Players.GetUserThumbnailAsync": { "documentation": "Returns the content URL of a player thumbnail given the size and type, as well as a boolean describing if the image is ready to use.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.GetUserThumbnailAsync/param/0" }, { "name": "userId", "documentation": "@roblox/globaltype/Players.GetUserThumbnailAsync/param/1" }, { "name": "thumbnailType", "documentation": "@roblox/globaltype/Players.GetUserThumbnailAsync/param/2" }, { "name": "thumbnailSize", "documentation": "@roblox/globaltype/Players.GetUserThumbnailAsync/param/3" } ], "returns": [ "@roblox/globaltype/Players.GetUserThumbnailAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#GetUserThumbnailAsync", "code_sample": "" }, "@roblox/globaltype/Players.playerFromCharacter/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.playerFromCharacter/param/1": { "documentation": "" }, "@roblox/globaltype/Players.playerFromCharacter/return/0": { "documentation": "" }, "@roblox/globaltype/Players.playerFromCharacter": { "documentation": "Deprecated: This function is a deprecated variant of Players:GetPlayerFromCharacter() which should be used in new work.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.playerFromCharacter/param/0" }, { "name": "character", "documentation": "@roblox/globaltype/Players.playerFromCharacter/param/1" } ], "returns": [ "@roblox/globaltype/Players.playerFromCharacter/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#playerFromCharacter", "code_sample": "" }, "@roblox/globaltype/Players.players/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.players/return/0": { "documentation": "" }, "@roblox/globaltype/Players.players": { "documentation": "Deprecated: This item has been superseded by Players:GetPlayers() which should be used in all new work.
Returns a list of players in an experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.players/param/0" } ], "returns": [ "@roblox/globaltype/Players.players/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#players", "code_sample": "" }, "@roblox/globaltype/Players.SetChatStyle/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.SetChatStyle/param/1": { "documentation": "The specified chat style being set." }, "@roblox/globaltype/Players.SetChatStyle": { "documentation": "Sets whether BubbleChat and ClassicChat are being used, and tells TeamChat and Chat what to do.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.SetChatStyle/param/0" }, { "name": "style", "documentation": "@roblox/globaltype/Players.SetChatStyle/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#SetChatStyle", "code_sample": "-- Command bar\ngame.Players:SetChatStyle(Enum.ChatStyle.Classic) -- Set's chat style to Classic\n\n-- LocalScript\nlocal Players = game:GetService(\"Players\")\nPlayers:SetChatStyle(Enum.ChatStyle.Classic) -- Errors" }, "@roblox/globaltype/Players.TeamChat/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.TeamChat/param/1": { "documentation": "The message being chatted." }, "@roblox/globaltype/Players.TeamChat": { "documentation": "Makes the local player chat the given message, which will only be viewable by users on the same team.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.TeamChat/param/0" }, { "name": "message", "documentation": "@roblox/globaltype/Players.TeamChat/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#TeamChat", "code_sample": "" }, "@roblox/globaltype/Players.UnbanAsync/param/0": { "documentation": "A service that contains presently connected Player objects." }, "@roblox/globaltype/Players.UnbanAsync/param/1": { "documentation": "
Name Type Description
UserIds array UserIDs to be force allowed into the experience(s).

Max size is 50.
ApplyToUniverse boolean Propagates the unban to all places within this universe.
" }, "@roblox/globaltype/Players.UnbanAsync": { "documentation": "Unbans players banned from Players:BanAsync() or the User Restrictions Open Cloud API. This method is enabled and disabled by the Players.BanningEnabled property, which you can toggle in Studio.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.UnbanAsync/param/0" }, { "name": "config", "documentation": "@roblox/globaltype/Players.UnbanAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#UnbanAsync", "code_sample": "local Players = game:GetService(\"Players\")\n\nif shouldBeUnbanned(player) then\n\tlocal config: UnbanConfigType = {\n\t\tUserIds = { player.UserId, 789 },\n\t\tApplyToUniverse = false,\n\t}\n\tlocal success, err = pcall(function()\n\t\treturn Players:UnbanAsync(config)\n\tend)\n\tprint(success, err)\nend" }, "@roblox/globaltype/Players.PlayerAdded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerAdded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerAdded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerAdded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerAdded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerAdded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerAdded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerAdded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerAdded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerAdded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerAdded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerAdded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerAdded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerAdded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerAdded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerAdded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerAdded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerAdded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerAdded": { "documentation": "Fires when a player enters the experience.", "keys": { "Connect": "@roblox/globaltype/Players.PlayerAdded.Connect", "ConnectParallel": "@roblox/globaltype/Players.PlayerAdded.ConnectParallel", "Once": "@roblox/globaltype/Players.PlayerAdded.Once", "Wait": "@roblox/globaltype/Players.PlayerAdded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#PlayerAdded", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerAdded(player)\n\tprint(\"A player has entered: \" .. player.Name)\nend\n\nPlayers.PlayerAdded:Connect(onPlayerAdded)" }, "@roblox/globaltype/Players.PlayerMembershipChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerMembershipChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerMembershipChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerMembershipChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerMembershipChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerMembershipChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerMembershipChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerMembershipChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerMembershipChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerMembershipChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerMembershipChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerMembershipChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerMembershipChanged": { "documentation": "Fires when the experience server recognizes that a player's membership has changed.", "keys": { "Connect": "@roblox/globaltype/Players.PlayerMembershipChanged.Connect", "ConnectParallel": "@roblox/globaltype/Players.PlayerMembershipChanged.ConnectParallel", "Once": "@roblox/globaltype/Players.PlayerMembershipChanged.Once", "Wait": "@roblox/globaltype/Players.PlayerMembershipChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#PlayerMembershipChanged", "code_sample": "" }, "@roblox/globaltype/Players.PlayerRemoving.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerRemoving.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerRemoving.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerRemoving.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerRemoving.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerRemoving.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerRemoving.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerRemoving.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerRemoving.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerRemoving.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerRemoving.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerRemoving.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Players.PlayerRemoving.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerRemoving.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.PlayerRemoving.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerRemoving.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.PlayerRemoving.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.PlayerRemoving.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Players.PlayerRemoving": { "documentation": "Fires when a player is about to leave the experience.", "keys": { "Connect": "@roblox/globaltype/Players.PlayerRemoving.Connect", "ConnectParallel": "@roblox/globaltype/Players.PlayerRemoving.ConnectParallel", "Once": "@roblox/globaltype/Players.PlayerRemoving.Once", "Wait": "@roblox/globaltype/Players.PlayerRemoving.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#PlayerRemoving", "code_sample": "local Players = game:GetService(\"Players\")\n\nlocal function onPlayerRemoving(player)\n\tprint(\"A player has left: \" .. player.Name)\nend\n\nPlayers.PlayerRemoving:Connect(onPlayerRemoving)" }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/Players.UserSubscriptionStatusChanged": { "documentation": "Fires when the experience server recognizes that the user's status for a certain subscription has changed.", "keys": { "Connect": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Connect", "ConnectParallel": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.ConnectParallel", "Once": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Once", "Wait": "@roblox/globaltype/Players.UserSubscriptionStatusChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Players#UserSubscriptionStatusChanged", "code_sample": "" }, "@roblox/globaltype/DataModelMesh": { "documentation": "The DataModelMesh is an abstract class from which mesh classes descend.", "keys": { "Offset": "@roblox/globaltype/DataModelMesh.Offset", "Scale": "@roblox/globaltype/DataModelMesh.Scale", "VertexColor": "@roblox/globaltype/DataModelMesh.VertexColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModelMesh", "code_sample": "" }, "@roblox/globaltype/DataModelMesh.Offset": { "documentation": "The Offset of a mesh determines the relative position from the BasePart.Position of a BasePart that the mesh will be displayed at.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModelMesh#Offset", "code_sample": "" }, "@roblox/globaltype/DataModelMesh.Scale": { "documentation": "The Scale of a mesh determines the size of the mesh relative to its original dimensions.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModelMesh#Scale", "code_sample": "" }, "@roblox/globaltype/DataModelMesh.VertexColor": { "documentation": "Changes the hue of a mesh's texture, used with FileMesh.TextureId.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/DataModelMesh#VertexColor", "code_sample": "" }, "@roblox/globaltype/MemoryStoreQueue": { "documentation": "Provides access to a queue within MemoryStore.", "keys": { "AddAsync": "@roblox/globaltype/MemoryStoreQueue.AddAsync", "GetSizeAsync": "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync", "ReadAsync": "@roblox/globaltype/MemoryStoreQueue.ReadAsync", "RemoveAsync": "@roblox/globaltype/MemoryStoreQueue.RemoveAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue", "code_sample": "" }, "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/0": { "documentation": "Provides access to a queue within MemoryStore." }, "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/1": { "documentation": "The value of the item to add to the queue." }, "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/2": { "documentation": "Item expiration time, in seconds, after which the item will be automatically removed from the queue." }, "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/3": { "documentation": "Item priority. Items with higher priority are retrieved from the queue before items with lower priority." }, "@roblox/globaltype/MemoryStoreQueue.AddAsync": { "documentation": "Adds an item to the queue.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/0" }, { "name": "value", "documentation": "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/1" }, { "name": "expiration", "documentation": "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/2" }, { "name": "priority", "documentation": "@roblox/globaltype/MemoryStoreQueue.AddAsync/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue#AddAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync/param/0": { "documentation": "Provides access to a queue within MemoryStore." }, "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync/param/1": { "documentation": "Determines whether to exclude invisible items from the size count." }, "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync/return/0": { "documentation": "" }, "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync": { "documentation": "Gets the size of the queue.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync/param/0" }, { "name": "excludeInvisible", "documentation": "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync/param/1" } ], "returns": [ "@roblox/globaltype/MemoryStoreQueue.GetSizeAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue#GetSizeAsync", "code_sample": "" }, "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/0": { "documentation": "Provides access to a queue within MemoryStore." }, "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/1": { "documentation": "Number of items to read. The maximum allowed value of this parameter is 100." }, "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/2": { "documentation": "Controls the behavior of the method in the case the queue has fewer than count items: if set to false the method returns all available items; if set to true, it returns no items. The default value is false." }, "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/3": { "documentation": "The duration, in seconds, for which the method will wait if the required number of items is not immediately available in the queue. Reads are attempted every two seconds during this period. This parameter can be set to zero to indicate no wait. If this parameter is not provided or set to -1, the method will wait indefinitely." }, "@roblox/globaltype/MemoryStoreQueue.ReadAsync/return/0": { "documentation": "A tuple of two elements. The first element is an array of item values read from the queue. The second element is a string identifier that should be passed to MemoryStoreQueue:RemoveAsync() to permanently remove these items from the queue." }, "@roblox/globaltype/MemoryStoreQueue.ReadAsync": { "documentation": "Reads one or more items from the queue.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/0" }, { "name": "count", "documentation": "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/1" }, { "name": "allOrNothing", "documentation": "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/2" }, { "name": "waitTimeout", "documentation": "@roblox/globaltype/MemoryStoreQueue.ReadAsync/param/3" } ], "returns": [ "@roblox/globaltype/MemoryStoreQueue.ReadAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue#ReadAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\nlocal DataStoreService = game:GetService(\"DataStoreService\")\n\nlocal queue = MemoryStoreService:GetQueue(\"PlayerQueue\")\nlocal dataStore = DataStoreService:GetDataStore(\"PlayerStore\")\n\nwhile true do\n\tpcall(function()\n\t\t-- wait for an item to process\n\t\tlocal items, id = queue:ReadAsync(1, false, 30)\n\n\t\t-- check if an item was retrieved\n\t\tif #items > 0 then\n\t\t\t-- mark the item as processed\n\t\t\tdataStore:UpdateAsync(items[0], function(data)\n\t\t\t\tdata = data or {}\n\t\t\t\tdata.processed = 1\n\t\t\t\treturn data\n\t\t\tend)\n\n\t\t\t-- remove the item from the queue\n\t\t\tqueue:RemoveAsync(id)\n\t\tend\n\tend)\nend" }, "@roblox/globaltype/MemoryStoreQueue.RemoveAsync/param/0": { "documentation": "Provides access to a queue within MemoryStore." }, "@roblox/globaltype/MemoryStoreQueue.RemoveAsync/param/1": { "documentation": "Identifies the items to delete. Use the value returned by MemoryStoreQueue:ReadAsync()." }, "@roblox/globaltype/MemoryStoreQueue.RemoveAsync": { "documentation": "Removes an item or items previously read from the queue.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/MemoryStoreQueue.RemoveAsync/param/0" }, { "name": "id", "documentation": "@roblox/globaltype/MemoryStoreQueue.RemoveAsync/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/MemoryStoreQueue#RemoveAsync", "code_sample": "local MemoryStoreService = game:GetService(\"MemoryStoreService\")\nlocal DataStoreService = game:GetService(\"DataStoreService\")\n\nlocal queue = MemoryStoreService:GetQueue(\"PlayerQueue\")\nlocal dataStore = DataStoreService:GetDataStore(\"PlayerStore\")\n\nwhile true do\n\tpcall(function()\n\t\t-- wait for an item to process\n\t\tlocal items, id = queue:ReadAsync(1, false, 30)\n\n\t\t-- check if an item was retrieved\n\t\tif #items > 0 then\n\t\t\t-- mark the item as processed\n\t\t\tdataStore:UpdateAsync(items[0], function(data)\n\t\t\t\tdata = data or {}\n\t\t\t\tdata.processed = 1\n\t\t\t\treturn data\n\t\t\tend)\n\n\t\t\t-- remove the item from the queue\n\t\t\tqueue:RemoveAsync(id)\n\t\tend\n\tend)\nend" }, "@roblox/globaltype/WorldRoot": { "documentation": "Base class for handling physics simulation and 3D spatial queries.", "keys": { "ArePartsTouchingOthers": "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers", "Blockcast": "@roblox/globaltype/WorldRoot.Blockcast", "BulkMoveTo": "@roblox/globaltype/WorldRoot.BulkMoveTo", "FindPartOnRay": "@roblox/globaltype/WorldRoot.FindPartOnRay", "findPartOnRay": "@roblox/globaltype/WorldRoot.findPartOnRay", "FindPartOnRayWithIgnoreList": "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList", "FindPartOnRayWithWhitelist": "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist", "FindPartsInRegion3": "@roblox/globaltype/WorldRoot.FindPartsInRegion3", "findPartsInRegion3": "@roblox/globaltype/WorldRoot.findPartsInRegion3", "FindPartsInRegion3WithIgnoreList": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList", "FindPartsInRegion3WithWhiteList": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList", "GetPartBoundsInBox": "@roblox/globaltype/WorldRoot.GetPartBoundsInBox", "GetPartBoundsInRadius": "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius", "GetPartsInPart": "@roblox/globaltype/WorldRoot.GetPartsInPart", "IKMoveTo": "@roblox/globaltype/WorldRoot.IKMoveTo", "IsRegion3Empty": "@roblox/globaltype/WorldRoot.IsRegion3Empty", "IsRegion3EmptyWithIgnoreList": "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList", "Raycast": "@roblox/globaltype/WorldRoot.Raycast", "Shapecast": "@roblox/globaltype/WorldRoot.Shapecast", "Spherecast": "@roblox/globaltype/WorldRoot.Spherecast", "StepPhysics": "@roblox/globaltype/WorldRoot.StepPhysics" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot", "code_sample": "" }, "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/param/1": { "documentation": "A list of parts checks to see if any parts in the list are touching any parts not in the list." }, "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/param/2": { "documentation": "The part overlap threshold in studs that is ignored before parts are considered to be touching." }, "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/return/0": { "documentation": "True if and only if any of the parts in partList are touching any other parts (parts not in the partList). False if no parts are passed." }, "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers": { "documentation": "Returns true if any of the given BasePart are touching any other parts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/param/0" }, { "name": "partList", "documentation": "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/param/1" }, { "name": "overlapIgnored", "documentation": "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/param/2" } ], "returns": [ "@roblox/globaltype/WorldRoot.ArePartsTouchingOthers/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#ArePartsTouchingOthers", "code_sample": "local part1 = Instance.new(\"Part\")\npart1.Name = \"Part1\"\npart1.Anchored = true\npart1.Transparency = 0.5\npart1.Color = Color3.fromRGB(185, 100, 38)\npart1.Size = Vector3.new(2, 2, 2)\npart1.Position = Vector3.new(0, 4, 0)\npart1.Parent = workspace\n\nlocal part2 = Instance.new(\"Part\")\npart2.Name = \"Part2\"\npart2.Anchored = true\npart2.Transparency = 0.5\npart2.Color = Color3.fromRGB(200, 10, 0)\npart2.Size = Vector3.new(2, 2, 2)\npart2.Position = Vector3.new(0, 5, 0)\npart2.Parent = workspace\n\nlocal partList = { part1 }\n\nprint(workspace:ArePartsTouchingOthers(partList, 0)) -- True\nprint(workspace:ArePartsTouchingOthers(partList, 0.999)) -- True\nprint(workspace:ArePartsTouchingOthers(partList, 1)) -- False" }, "@roblox/globaltype/WorldRoot.Blockcast/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.Blockcast/param/1": { "documentation": "The initial position and rotation of the cast block shape." }, "@roblox/globaltype/WorldRoot.Blockcast/param/2": { "documentation": "The size of the cast block shape in studs. The maximum size is 512 studs." }, "@roblox/globaltype/WorldRoot.Blockcast/param/3": { "documentation": "Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs." }, "@roblox/globaltype/WorldRoot.Blockcast/param/4": { "documentation": "" }, "@roblox/globaltype/WorldRoot.Blockcast/return/0": { "documentation": "Contains the result of the shapecast operation, or nil if no eligible BasePart or Terrain cell was hit." }, "@roblox/globaltype/WorldRoot.Blockcast": { "documentation": "Casts a block shape in a given direction and returns a RaycastResult if the shape hits a BasePart or Terrain cell.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.Blockcast/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/WorldRoot.Blockcast/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/WorldRoot.Blockcast/param/2" }, { "name": "direction", "documentation": "@roblox/globaltype/WorldRoot.Blockcast/param/3" }, { "name": "params", "documentation": "@roblox/globaltype/WorldRoot.Blockcast/param/4" } ], "returns": [ "@roblox/globaltype/WorldRoot.Blockcast/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#Blockcast", "code_sample": "" }, "@roblox/globaltype/WorldRoot.BulkMoveTo/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.BulkMoveTo/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.BulkMoveTo/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.BulkMoveTo/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.BulkMoveTo": { "documentation": "Moves a table of BaseParts to a table of CFrames.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.BulkMoveTo/param/0" }, { "name": "partList", "documentation": "@roblox/globaltype/WorldRoot.BulkMoveTo/param/1" }, { "name": "cframeList", "documentation": "@roblox/globaltype/WorldRoot.BulkMoveTo/param/2" }, { "name": "eventMode", "documentation": "@roblox/globaltype/WorldRoot.BulkMoveTo/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#BulkMoveTo", "code_sample": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRay/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.FindPartOnRay/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRay/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRay/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRay/param/4": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRay/return/0": { "documentation": "The BasePart or Terrain cell hit, the Vector3 point of intersection, the Vector3 surface normal at the point of intersection, and the Material of the BasePart or terrain cell hit." }, "@roblox/globaltype/WorldRoot.FindPartOnRay": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:Raycast() along with RaycastParams for new work.
Returns the first BasePart or Terrain cell intersecting with the given Ray.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRay/param/0" }, { "name": "ray", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRay/param/1" }, { "name": "ignoreDescendantsInstance", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRay/param/2" }, { "name": "terrainCellsAreCubes", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRay/param/3" }, { "name": "ignoreWater", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRay/param/4" } ], "returns": [ "@roblox/globaltype/WorldRoot.FindPartOnRay/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartOnRay", "code_sample": "" }, "@roblox/globaltype/WorldRoot.findPartOnRay/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.findPartOnRay/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartOnRay/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartOnRay/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartOnRay/param/4": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartOnRay/return/0": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartOnRay": { "documentation": "Deprecated: This deprecated function is a variant of WorldRoot:FindPartOnRay() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.findPartOnRay/param/0" }, { "name": "ray", "documentation": "@roblox/globaltype/WorldRoot.findPartOnRay/param/1" }, { "name": "ignoreDescendantsInstance", "documentation": "@roblox/globaltype/WorldRoot.findPartOnRay/param/2" }, { "name": "terrainCellsAreCubes", "documentation": "@roblox/globaltype/WorldRoot.findPartOnRay/param/3" }, { "name": "ignoreWater", "documentation": "@roblox/globaltype/WorldRoot.findPartOnRay/param/4" } ], "returns": [ "@roblox/globaltype/WorldRoot.findPartOnRay/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#findPartOnRay", "code_sample": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/4": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/return/0": { "documentation": "The BasePart or Terrain cell hit, the Vector3 point of intersection, the Vector3 surface normal at the point of intersection, and the Material of the BasePart or terrain cell hit." }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:Raycast() along with RaycastParams for new work.
Returns the first BasePart or Terrain cell intersecting with the given Ray that isn't in, nor is a descendant of an object in, the given ignore list.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/0" }, { "name": "ray", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/1" }, { "name": "ignoreDescendantsTable", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/2" }, { "name": "terrainCellsAreCubes", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/3" }, { "name": "ignoreWater", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/param/4" } ], "returns": [ "@roblox/globaltype/WorldRoot.FindPartOnRayWithIgnoreList/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartOnRayWithIgnoreList", "code_sample": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/return/0": { "documentation": "The BasePart or Terrain cell hit, the Vector3 point of intersection, the Vector3 surface normal at the point of intersection, and the Material of the BasePart or terrain cell hit." }, "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:Raycast() along with RaycastParams for new work.
Returns the first BasePart or Terrain cell intersecting with the given Ray that is in, or is a descendant of an object in, the given inclusion list.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/0" }, { "name": "ray", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/1" }, { "name": "whitelistDescendantsTable", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/2" }, { "name": "ignoreWater", "documentation": "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.FindPartOnRayWithWhitelist/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartOnRayWithWhitelist", "code_sample": "" }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/1": { "documentation": "The Region3 to be checked." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/2": { "documentation": "An Instance to be ignored." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/3": { "documentation": "The maximum amount of BaseParts to be returned." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3/return/0": { "documentation": "An array of BaseParts within the Region3." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:GetPartBoundsInBox() along with OverlapParams for new work.
Returns an array of BaseParts in the given Region3.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/1" }, { "name": "ignoreDescendantsInstance", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/2" }, { "name": "maxParts", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.FindPartsInRegion3/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartsInRegion3", "code_sample": "" }, "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartsInRegion3/return/0": { "documentation": "" }, "@roblox/globaltype/WorldRoot.findPartsInRegion3": { "documentation": "Deprecated: This deprecated function is a variant of WorldRoot:FindPartsInRegion3() which should be used instead.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/1" }, { "name": "ignoreDescendantsInstance", "documentation": "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/2" }, { "name": "maxParts", "documentation": "@roblox/globaltype/WorldRoot.findPartsInRegion3/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.findPartsInRegion3/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#findPartsInRegion3", "code_sample": "" }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/1": { "documentation": "The Region3 to be checked." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/2": { "documentation": "An array of objects to be ignored." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/3": { "documentation": "The maximum number of BaseParts to be returned." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/return/0": { "documentation": "An array of BaseParts found within the Region3." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:GetPartBoundsInBox() along with OverlapParams for new work.
Returns an array of BaseParts in the given Region3 that aren't in, or a descendant of an entry in, the given ignore list.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/1" }, { "name": "ignoreDescendantsTable", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/2" }, { "name": "maxParts", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithIgnoreList/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartsInRegion3WithIgnoreList", "code_sample": "" }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/1": { "documentation": "The Region3 to be checked." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/2": { "documentation": "An array of objects to check." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/3": { "documentation": "The maximum number of BaseParts to be returned." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/return/0": { "documentation": "An array of BaseParts within the Region3." }, "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:GetPartBoundsInBox() along with OverlapParams for new work.
Returns an array of BaseParts in the given Region3 that are in, or descendant of an entry in, the given inclusion list.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/1" }, { "name": "whitelistDescendantsTable", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/2" }, { "name": "maxParts", "documentation": "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.FindPartsInRegion3WithWhiteList/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#FindPartsInRegion3WithWhiteList", "code_sample": "" }, "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/1": { "documentation": "The location of the center of the given box volume to be queried." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/2": { "documentation": "The size of the given box volume to be queried." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/3": { "documentation": "Contains reusable portions of the spatial query parameters." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/return/0": { "documentation": "An array of BaseParts which matched the spatial query." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInBox": { "documentation": "Returns an array of parts whose bounding boxes overlap a given box.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/0" }, { "name": "cframe", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/1" }, { "name": "size", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/2" }, { "name": "overlapParams", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.GetPartBoundsInBox/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInBox", "code_sample": "" }, "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/1": { "documentation": "The location of the center of the given sphere volume to be queried." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/2": { "documentation": "The radius of the given sphere volume to be queried." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/3": { "documentation": "Contains reusable portions of the spatial query parameters." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/return/0": { "documentation": "An array of BaseParts which matched the spatial query." }, "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius": { "documentation": "Returns an array of parts whose bounding boxes overlap a given sphere.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/1" }, { "name": "radius", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/2" }, { "name": "overlapParams", "documentation": "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.GetPartBoundsInRadius/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartBoundsInRadius", "code_sample": "" }, "@roblox/globaltype/WorldRoot.GetPartsInPart/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.GetPartsInPart/param/1": { "documentation": "The part whose volume is to be checked against other parts." }, "@roblox/globaltype/WorldRoot.GetPartsInPart/param/2": { "documentation": "Contains reusable portions of the spatial query parameters." }, "@roblox/globaltype/WorldRoot.GetPartsInPart/return/0": { "documentation": "An array of BaseParts which matched the spatial query." }, "@roblox/globaltype/WorldRoot.GetPartsInPart": { "documentation": "Returns an array of parts whose occupied space is shared with the given part.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.GetPartsInPart/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/WorldRoot.GetPartsInPart/param/1" }, { "name": "overlapParams", "documentation": "@roblox/globaltype/WorldRoot.GetPartsInPart/param/2" } ], "returns": [ "@roblox/globaltype/WorldRoot.GetPartsInPart/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#GetPartsInPart", "code_sample": "" }, "@roblox/globaltype/WorldRoot.IKMoveTo/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.IKMoveTo/param/1": { "documentation": "The part being moved." }, "@roblox/globaltype/WorldRoot.IKMoveTo/param/2": { "documentation": "The location to move the specified part." }, "@roblox/globaltype/WorldRoot.IKMoveTo/param/3": { "documentation": "A number between 0 and 1 specifying how aggressively to match the part's position to the position part of the target CFrame." }, "@roblox/globaltype/WorldRoot.IKMoveTo/param/4": { "documentation": "A number between 0 and 1 specifying how aggressively to match the part's rotation to the rotation part of the target CFrame." }, "@roblox/globaltype/WorldRoot.IKMoveTo/param/5": { "documentation": "Allows you to specify what objects should be effected by the physical resolution." }, "@roblox/globaltype/WorldRoot.IKMoveTo": { "documentation": "Moves the specified part to the specified location via inverse kinematics rather than moving it there directly, to ensure any joints, constraints, or collisions that part is participating in remain physically satisfied.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.IKMoveTo/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/WorldRoot.IKMoveTo/param/1" }, { "name": "target", "documentation": "@roblox/globaltype/WorldRoot.IKMoveTo/param/2" }, { "name": "translateStiffness", "documentation": "@roblox/globaltype/WorldRoot.IKMoveTo/param/3" }, { "name": "rotateStiffness", "documentation": "@roblox/globaltype/WorldRoot.IKMoveTo/param/4" }, { "name": "collisionsMode", "documentation": "@roblox/globaltype/WorldRoot.IKMoveTo/param/5" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#IKMoveTo", "code_sample": "" }, "@roblox/globaltype/WorldRoot.IsRegion3Empty/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.IsRegion3Empty/param/1": { "documentation": "The Region3 to be checked." }, "@roblox/globaltype/WorldRoot.IsRegion3Empty/param/2": { "documentation": "An Instance to be ignored." }, "@roblox/globaltype/WorldRoot.IsRegion3Empty/return/0": { "documentation": "True if the Region3 is empty." }, "@roblox/globaltype/WorldRoot.IsRegion3Empty": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:GetPartBoundsInBox() along with OverlapParams for new work.
Returns a bool indicating whether there are no BaseParts within the given Region3.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.IsRegion3Empty/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/WorldRoot.IsRegion3Empty/param/1" }, { "name": "ignoreDescendentsInstance", "documentation": "@roblox/globaltype/WorldRoot.IsRegion3Empty/param/2" } ], "returns": [ "@roblox/globaltype/WorldRoot.IsRegion3Empty/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#IsRegion3Empty", "code_sample": "" }, "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/param/1": { "documentation": "The Region3 to be checked." }, "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/param/2": { "documentation": "An array of objects to be ignored." }, "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/return/0": { "documentation": "True if the Region3 is empty." }, "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList": { "documentation": "Deprecated: This function has been deprecated. Use WorldRoot:GetPartBoundsInBox() along with OverlapParams for new work.
Returns a boolean indicating whether there are no BaseParts within the given Region3, ignoring any BaseParts that are descendants of the objects within the given ignore list.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/param/0" }, { "name": "region", "documentation": "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/param/1" }, { "name": "ignoreDescendentsTable", "documentation": "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/param/2" } ], "returns": [ "@roblox/globaltype/WorldRoot.IsRegion3EmptyWithIgnoreList/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#IsRegion3EmptyWithIgnoreList", "code_sample": "" }, "@roblox/globaltype/WorldRoot.Raycast/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.Raycast/param/1": { "documentation": "The origin point of the ray." }, "@roblox/globaltype/WorldRoot.Raycast/param/2": { "documentation": "The directional vector of the ray. Note that the length of this vector matters, as parts/terrain further away than its length will not be tested." }, "@roblox/globaltype/WorldRoot.Raycast/param/3": { "documentation": "An object used to specify hit eligibility in the raycast operation. If not provided, default values are used where all parts are considered and Terrain water is not ignored." }, "@roblox/globaltype/WorldRoot.Raycast/return/0": { "documentation": "Contains the results of a raycast operation, or nil if no eligible BasePart or Terrain cell was hit." }, "@roblox/globaltype/WorldRoot.Raycast": { "documentation": "Casts a ray using an origin, direction, and optional RaycastParams, then returns a RaycastResult if an eligible object or terrain intersects the ray.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.Raycast/param/0" }, { "name": "origin", "documentation": "@roblox/globaltype/WorldRoot.Raycast/param/1" }, { "name": "direction", "documentation": "@roblox/globaltype/WorldRoot.Raycast/param/2" }, { "name": "raycastParams", "documentation": "@roblox/globaltype/WorldRoot.Raycast/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.Raycast/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#Raycast", "code_sample": "local Workspace = game:GetService(\"Workspace\")\n\nlocal function castRay()\n\t-- The origin point of the ray\n\tlocal originPosition = Vector3.new(0, 50, 0)\n\t-- The direction the ray is cast in\n\tlocal direction = -Vector3.yAxis\n\t-- The maximum distance of the ray\n\tlocal distance = 50\n\n\t-- Cast the ray and create a visualization of it\n\tlocal raycastResult = Workspace:Raycast(originPosition, direction * distance)\n\n\tif raycastResult then\n\t\t-- Print all properties of the RaycastResult if it exists\n\t\tprint(`Ray intersected with: {raycastResult.Instance:GetFullName()}`)\n\t\tprint(`Intersection position: {raycastResult.Position}`)\n\t\tprint(`Distance between ray origin and result: {raycastResult.Distance}`)\n\t\tprint(`The normal vector of the intersected face: {raycastResult.Normal}`)\n\t\tprint(`Material hit: {raycastResult.Material.Name}`)\n\telse\n\t\tprint(\"Nothing was hit\")\n\tend\nend\n\n-- Continually cast a ray every 2 seconds\nwhile true do\n\tcastRay()\n\ttask.wait(2)\nend" }, "@roblox/globaltype/WorldRoot.Shapecast/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.Shapecast/param/1": { "documentation": "" }, "@roblox/globaltype/WorldRoot.Shapecast/param/2": { "documentation": "" }, "@roblox/globaltype/WorldRoot.Shapecast/param/3": { "documentation": "" }, "@roblox/globaltype/WorldRoot.Shapecast/return/0": { "documentation": "" }, "@roblox/globaltype/WorldRoot.Shapecast": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.Shapecast/param/0" }, { "name": "part", "documentation": "@roblox/globaltype/WorldRoot.Shapecast/param/1" }, { "name": "direction", "documentation": "@roblox/globaltype/WorldRoot.Shapecast/param/2" }, { "name": "params", "documentation": "@roblox/globaltype/WorldRoot.Shapecast/param/3" } ], "returns": [ "@roblox/globaltype/WorldRoot.Shapecast/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#Shapecast", "code_sample": "" }, "@roblox/globaltype/WorldRoot.Spherecast/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.Spherecast/param/1": { "documentation": "The initial position of the cast spherical shape." }, "@roblox/globaltype/WorldRoot.Spherecast/param/2": { "documentation": "The radius of the cast spherical shape in studs. The maximum radius is 256 studs." }, "@roblox/globaltype/WorldRoot.Spherecast/param/3": { "documentation": "Direction of the shapecast, with the magnitude representing the maximum distance the shape can travel. The maximum distance is 1024 studs." }, "@roblox/globaltype/WorldRoot.Spherecast/param/4": { "documentation": "" }, "@roblox/globaltype/WorldRoot.Spherecast/return/0": { "documentation": "Contains the result of the shapecast operation, or nil if no eligible BasePart or Terrain cell was hit." }, "@roblox/globaltype/WorldRoot.Spherecast": { "documentation": "Casts a spherical shape in a given direction and returns a RaycastResult if the shape hits a BasePart or Terrain cell.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.Spherecast/param/0" }, { "name": "position", "documentation": "@roblox/globaltype/WorldRoot.Spherecast/param/1" }, { "name": "radius", "documentation": "@roblox/globaltype/WorldRoot.Spherecast/param/2" }, { "name": "direction", "documentation": "@roblox/globaltype/WorldRoot.Spherecast/param/3" }, { "name": "params", "documentation": "@roblox/globaltype/WorldRoot.Spherecast/param/4" } ], "returns": [ "@roblox/globaltype/WorldRoot.Spherecast/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#Spherecast", "code_sample": "" }, "@roblox/globaltype/WorldRoot.StepPhysics/param/0": { "documentation": "Base class for handling physics simulation and 3D spatial queries." }, "@roblox/globaltype/WorldRoot.StepPhysics/param/1": { "documentation": "The amount of time that will be simulated. This argument must be a positive number. Larger values will increase the runtime of this function." }, "@roblox/globaltype/WorldRoot.StepPhysics/param/2": { "documentation": "Optional array of parts that will be simulated. This set must contain instances that are of type BasePart; any other types will be ignored." }, "@roblox/globaltype/WorldRoot.StepPhysics": { "documentation": "Advances the simulation for parts in the world forward based on a specified time increment and an optional set of BaseParts.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/WorldRoot.StepPhysics/param/0" }, { "name": "dt", "documentation": "@roblox/globaltype/WorldRoot.StepPhysics/param/1" }, { "name": "parts", "documentation": "@roblox/globaltype/WorldRoot.StepPhysics/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/WorldRoot#StepPhysics", "code_sample": "local RunService = game:GetService(\"RunService\")\n\n-- Optional array of parts to simulate; otherwise all parts will be simulated\nlocal partsToSimulate = {\n\tworkspace.Part,\n}\n\nlocal function simulateParts(duration)\n\tlocal time = 0.0\n\tlocal stepJob\n\n\tstepJob = RunService.RenderStepped:Connect(function(dt)\n\t\tif time + dt > duration then\n\t\t\tdt = duration - time\n\t\tend\n\n\t\tworkspace:StepPhysics(dt, partsToSimulate)\n\t\ttime = time + dt\n\t\tif time >= duration then\n\t\t\tstepJob:Disconnect()\n\t\tend\n\tend)\nend\n\n-- Simulate workspace parts for 5 seconds, stepping the parts once per frame\nsimulateParts(5.0)" }, "@roblox/globaltype/Sky": { "documentation": "Changes the default appearance of the experience's sky.", "keys": { "CelestialBodiesShown": "@roblox/globaltype/Sky.CelestialBodiesShown", "MoonAngularSize": "@roblox/globaltype/Sky.MoonAngularSize", "MoonTextureContent": "@roblox/globaltype/Sky.MoonTextureContent", "MoonTextureId": "@roblox/globaltype/Sky.MoonTextureId", "SkyboxBackContent": "@roblox/globaltype/Sky.SkyboxBackContent", "SkyboxBk": "@roblox/globaltype/Sky.SkyboxBk", "SkyboxDn": "@roblox/globaltype/Sky.SkyboxDn", "SkyboxDownContent": "@roblox/globaltype/Sky.SkyboxDownContent", "SkyboxFrontContent": "@roblox/globaltype/Sky.SkyboxFrontContent", "SkyboxFt": "@roblox/globaltype/Sky.SkyboxFt", "SkyboxLeftContent": "@roblox/globaltype/Sky.SkyboxLeftContent", "SkyboxLf": "@roblox/globaltype/Sky.SkyboxLf", "SkyboxOrientation": "@roblox/globaltype/Sky.SkyboxOrientation", "SkyboxRightContent": "@roblox/globaltype/Sky.SkyboxRightContent", "SkyboxRt": "@roblox/globaltype/Sky.SkyboxRt", "SkyboxUp": "@roblox/globaltype/Sky.SkyboxUp", "SkyboxUpContent": "@roblox/globaltype/Sky.SkyboxUpContent", "StarCount": "@roblox/globaltype/Sky.StarCount", "SunAngularSize": "@roblox/globaltype/Sky.SunAngularSize", "SunTextureContent": "@roblox/globaltype/Sky.SunTextureContent", "SunTextureId": "@roblox/globaltype/Sky.SunTextureId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky", "code_sample": "" }, "@roblox/globaltype/Sky.CelestialBodiesShown": { "documentation": "Sets whether the sun, moon, and stars will show.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#CelestialBodiesShown", "code_sample": "" }, "@roblox/globaltype/Sky.MoonAngularSize": { "documentation": "The perceived angular size of the moon while using this skybox, in degrees.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#MoonAngularSize", "code_sample": "" }, "@roblox/globaltype/Sky.MoonTextureContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#MoonTextureContent", "code_sample": "" }, "@roblox/globaltype/Sky.MoonTextureId": { "documentation": "The texture of the moon while using this skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#MoonTextureId", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxBackContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxBackContent", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxBk": { "documentation": "The URL link to a picture for the back surface of the sky.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxBk", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxDn": { "documentation": "Asset ID for the bottom surface of the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxDn", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxDownContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxDownContent", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxFrontContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxFrontContent", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxFt": { "documentation": "Asset ID for the front surface of the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxFt", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxLeftContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxLeftContent", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxLf": { "documentation": "Asset ID for the left surface of the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxLf", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxOrientation": { "documentation": "Angle of the skybox, in degrees, with rotation order of Y, X, Z.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxOrientation", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxRightContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxRightContent", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxRt": { "documentation": "Asset ID for the right surface of the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxRt", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxUp": { "documentation": "Asset ID for the top surface of the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxUp", "code_sample": "" }, "@roblox/globaltype/Sky.SkyboxUpContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxUpContent", "code_sample": "" }, "@roblox/globaltype/Sky.StarCount": { "documentation": "How many stars are shown in the skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#StarCount", "code_sample": "" }, "@roblox/globaltype/Sky.SunAngularSize": { "documentation": "The perceived angular size of the sun while using this skybox, in degrees.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SunAngularSize", "code_sample": "" }, "@roblox/globaltype/Sky.SunTextureContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SunTextureContent", "code_sample": "" }, "@roblox/globaltype/Sky.SunTextureId": { "documentation": "The texture of the sun while using this skybox.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/Sky#SunTextureId", "code_sample": "" }, "@roblox/globaltype/TextSource": { "documentation": "Represents a speaker in a TextChannel.", "keys": { "CanSend": "@roblox/globaltype/TextSource.CanSend", "UserId": "@roblox/globaltype/TextSource.UserId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextSource", "code_sample": "" }, "@roblox/globaltype/TextSource.CanSend": { "documentation": "Determines whether the user can send messages to the TextChannel.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextSource#CanSend", "code_sample": "" }, "@roblox/globaltype/TextSource.UserId": { "documentation": "UserId of the user represented by the TextSource.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/TextSource#UserId", "code_sample": "" }, "@roblox/globaltype/ConfigureServerService": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ConfigureServerService", "code_sample": "" }, "@roblox/globaltype/BoolValue": { "documentation": "A container object for a single boolean value.", "keys": { "Value": "@roblox/globaltype/BoolValue.Value" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoolValue", "code_sample": "" }, "@roblox/globaltype/BoolValue.Value": { "documentation": "Used to hold a boolean value.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoolValue#Value", "code_sample": "" }, "@roblox/globaltype/BoolValue.Changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.Changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BoolValue.Changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.Changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BoolValue.Changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BoolValue.Changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.Changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BoolValue.Changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.Changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BoolValue.Changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BoolValue.Changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.Changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BoolValue.Changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.Changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BoolValue.Changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BoolValue.Changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.Changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.Changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BoolValue.Changed": { "documentation": "Fires whenever the BoolValue.Value is changed.", "keys": { "Connect": "@roblox/globaltype/BoolValue.Changed.Connect", "ConnectParallel": "@roblox/globaltype/BoolValue.Changed.ConnectParallel", "Once": "@roblox/globaltype/BoolValue.Changed.Once", "Wait": "@roblox/globaltype/BoolValue.Changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoolValue#Changed", "code_sample": "local boolValue = script.Parent.BoolValue\n\nlocal function printValue(value)\n\tprint(value)\nend\n\nboolValue.Changed:Connect(printValue)\n\nboolValue.Value = true" }, "@roblox/globaltype/BoolValue.changed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.changed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/BoolValue.changed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.changed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BoolValue.changed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/BoolValue.changed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.changed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/BoolValue.changed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.changed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BoolValue.changed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/BoolValue.changed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.changed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/BoolValue.changed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.changed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/BoolValue.changed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/BoolValue.changed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/BoolValue.changed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/BoolValue.changed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/BoolValue.changed": { "documentation": "Deprecated: This event is a deprecated variant of BoolValue.Changed which should be used instead.", "keys": { "Connect": "@roblox/globaltype/BoolValue.changed.Connect", "ConnectParallel": "@roblox/globaltype/BoolValue.changed.ConnectParallel", "Once": "@roblox/globaltype/BoolValue.changed.Once", "Wait": "@roblox/globaltype/BoolValue.changed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/BoolValue#changed", "code_sample": "" }, "@roblox/globaltype/UserService": { "documentation": "A service that handles queries regarding users on the Roblox platform.", "keys": { "GetUserInfosByUserIdsAsync": "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserService", "code_sample": "" }, "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync/param/0": { "documentation": "A service that handles queries regarding users on the Roblox platform." }, "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync/param/1": { "documentation": "An array of UserIds requested." }, "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync/return/0": { "documentation": "An array of dictionary objects that contain user information." }, "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync": { "documentation": "Returns an array of user information including user name and display name.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync/param/0" }, { "name": "userIds", "documentation": "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync/param/1" } ], "returns": [ "@roblox/globaltype/UserService.GetUserInfosByUserIdsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UserService#GetUserInfosByUserIdsAsync", "code_sample": "local UserService = game:GetService(\"UserService\")\n\nlocal success, result = pcall(function()\n\treturn UserService:GetUserInfosByUserIdsAsync({ 156, 1, 735878936 })\nend)\n\nif success then\n\tfor _, userInfo in ipairs(result) do\n\t\tprint(\"Id:\", userInfo.Id)\n\t\tprint(\"Username:\", userInfo.Username)\n\t\tprint(\"DisplayName:\", userInfo.DisplayName)\n\tend\nelse\n\t-- An error occurred\nend" }, "@roblox/globaltype/VideoFrame": { "documentation": "A GUI object that renders a rectangle, like a Frame does, with a moving video image.", "keys": { "IsLoaded": "@roblox/globaltype/VideoFrame.IsLoaded", "Looped": "@roblox/globaltype/VideoFrame.Looped", "Playing": "@roblox/globaltype/VideoFrame.Playing", "Resolution": "@roblox/globaltype/VideoFrame.Resolution", "TimeLength": "@roblox/globaltype/VideoFrame.TimeLength", "TimePosition": "@roblox/globaltype/VideoFrame.TimePosition", "Video": "@roblox/globaltype/VideoFrame.Video", "VideoContent": "@roblox/globaltype/VideoFrame.VideoContent", "Volume": "@roblox/globaltype/VideoFrame.Volume", "Pause": "@roblox/globaltype/VideoFrame.Pause", "Play": "@roblox/globaltype/VideoFrame.Play" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame", "code_sample": "local screenPart = Instance.new(\"Part\")\nscreenPart.Parent = workspace\n\nlocal surfaceGui = Instance.new(\"SurfaceGui\")\nsurfaceGui.Parent = screenPart\n\nlocal videoFrame = Instance.new(\"VideoFrame\")\nvideoFrame.Parent = surfaceGui\n\nvideoFrame.Looped = true\nvideoFrame.Video = \"rbxassetid://\" -- add an asset ID to this\n\nwhile not videoFrame.IsLoaded do\n\ttask.wait()\nend\n\nvideoFrame:Play()" }, "@roblox/globaltype/VideoFrame.IsLoaded": { "documentation": "Indicates when the VideoFrame.Video has loaded from Roblox servers and is ready to play.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#IsLoaded", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Looped": { "documentation": "Sets whether or not the VideoFrame.Video repeats once it has finished when it is playing.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Looped", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Playing": { "documentation": "Indicates whether the VideoFrame.Video is currently playing. It can be set to start or pause playback.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Playing", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Resolution": { "documentation": "Gets the original source resolution of the VideoFrame.Video file.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Resolution", "code_sample": "" }, "@roblox/globaltype/VideoFrame.TimeLength": { "documentation": "Indicates the length of the VideoFrame.Video in seconds.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#TimeLength", "code_sample": "" }, "@roblox/globaltype/VideoFrame.TimePosition": { "documentation": "Indicates the progress in seconds of the VideoFrame.Video.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#TimePosition", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Video": { "documentation": "The content ID of the video file a VideoFrame object is associated with.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Video", "code_sample": "local screenPart = Instance.new(\"Part\")\nscreenPart.Parent = workspace\n\nlocal surfaceGui = Instance.new(\"SurfaceGui\")\nsurfaceGui.Parent = screenPart\n\nlocal videoFrame = Instance.new(\"VideoFrame\")\nvideoFrame.Parent = surfaceGui\n\nvideoFrame.Looped = true\nvideoFrame.Video = \"rbxassetid://\" -- add an asset ID to this\n\nwhile not videoFrame.IsLoaded do\n\ttask.wait()\nend\n\nvideoFrame:Play()" }, "@roblox/globaltype/VideoFrame.VideoContent": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#VideoContent", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Volume": { "documentation": "Indicates how loud the VideoFrame.Video is currently playing back.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Volume", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Pause/param/0": { "documentation": "A GUI object that renders a rectangle, like a Frame does, with a moving video image." }, "@roblox/globaltype/VideoFrame.Pause": { "documentation": "Sets VideoFrame.Playing to false, pausing playback if the VideoFrame.Video is playing.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Pause/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Pause", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Play/param/0": { "documentation": "A GUI object that renders a rectangle, like a Frame does, with a moving video image." }, "@roblox/globaltype/VideoFrame.Play": { "documentation": "Sets VideoFrame.Playing to true, playing the VideoFrame.Video from the current VideoFrame.TimePosition.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Play/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Play", "code_sample": "local screenPart = Instance.new(\"Part\")\nscreenPart.Parent = workspace\n\nlocal surfaceGui = Instance.new(\"SurfaceGui\")\nsurfaceGui.Parent = screenPart\n\nlocal videoFrame = Instance.new(\"VideoFrame\")\nvideoFrame.Parent = surfaceGui\n\nvideoFrame.Looped = true\nvideoFrame.Video = \"rbxassetid://\" -- add an asset ID to this\n\nwhile not videoFrame.IsLoaded do\n\ttask.wait()\nend\n\nvideoFrame:Play()" }, "@roblox/globaltype/VideoFrame.DidLoop.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.DidLoop.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.DidLoop.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.DidLoop.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.DidLoop.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.DidLoop.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.DidLoop.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.DidLoop.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.DidLoop.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.DidLoop.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.DidLoop.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.DidLoop.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.DidLoop": { "documentation": "Fires whenever the VideoFrame.Video loops.", "keys": { "Connect": "@roblox/globaltype/VideoFrame.DidLoop.Connect", "ConnectParallel": "@roblox/globaltype/VideoFrame.DidLoop.ConnectParallel", "Once": "@roblox/globaltype/VideoFrame.DidLoop.Once", "Wait": "@roblox/globaltype/VideoFrame.DidLoop.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#DidLoop", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Ended.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Ended.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Ended.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Ended.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Ended.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Ended.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Ended.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Ended.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Ended.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Ended.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Ended.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Ended.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Ended.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Ended.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Ended.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Ended.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Ended.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Ended.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Ended": { "documentation": "Fires when the VideoFrame.Video has completed playback and stopped.", "keys": { "Connect": "@roblox/globaltype/VideoFrame.Ended.Connect", "ConnectParallel": "@roblox/globaltype/VideoFrame.Ended.ConnectParallel", "Once": "@roblox/globaltype/VideoFrame.Ended.Once", "Wait": "@roblox/globaltype/VideoFrame.Ended.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Ended", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Loaded.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Loaded.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Loaded.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Loaded.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Loaded.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Loaded.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Loaded.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Loaded.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Loaded.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Loaded.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Loaded.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Loaded.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Loaded.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Loaded.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Loaded.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Loaded.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Loaded.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Loaded.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Loaded": { "documentation": "Fires when the VideoFrame.Video is loaded.", "keys": { "Connect": "@roblox/globaltype/VideoFrame.Loaded.Connect", "ConnectParallel": "@roblox/globaltype/VideoFrame.Loaded.ConnectParallel", "Once": "@roblox/globaltype/VideoFrame.Loaded.Once", "Wait": "@roblox/globaltype/VideoFrame.Loaded.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Loaded", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Paused.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Paused.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Paused.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Paused.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Paused.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Paused.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Paused.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Paused.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Paused.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Paused.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Paused.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Paused.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Paused.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Paused.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Paused.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Paused.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Paused.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Paused.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Paused": { "documentation": "This event fires whenever the VideoFrame.Video is paused using VideoFrame:Pause() or by setting VideoFrame.Playing to false.", "keys": { "Connect": "@roblox/globaltype/VideoFrame.Paused.Connect", "ConnectParallel": "@roblox/globaltype/VideoFrame.Paused.ConnectParallel", "Once": "@roblox/globaltype/VideoFrame.Paused.Once", "Wait": "@roblox/globaltype/VideoFrame.Paused.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Paused", "code_sample": "" }, "@roblox/globaltype/VideoFrame.Played.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Played.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Played.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Played.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Played.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Played.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Played.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Played.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Played.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Played.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Played.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Played.Once/param/1": { "documentation": "" }, "@roblox/globaltype/VideoFrame.Played.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Played.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/VideoFrame.Played.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Played.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/VideoFrame.Played.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/VideoFrame.Played.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/VideoFrame.Played": { "documentation": "Fires whenever the VideoFrame.Video is played using the VideoFrame:Play() function or by setting VideoFrame.Playing to true.", "keys": { "Connect": "@roblox/globaltype/VideoFrame.Played.Connect", "ConnectParallel": "@roblox/globaltype/VideoFrame.Played.ConnectParallel", "Once": "@roblox/globaltype/VideoFrame.Played.Once", "Wait": "@roblox/globaltype/VideoFrame.Played.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/VideoFrame#Played", "code_sample": "" }, "@roblox/globaltype/UIPageLayout": { "documentation": "", "keys": { "Animated": "@roblox/globaltype/UIPageLayout.Animated", "Circular": "@roblox/globaltype/UIPageLayout.Circular", "CurrentPage": "@roblox/globaltype/UIPageLayout.CurrentPage", "EasingDirection": "@roblox/globaltype/UIPageLayout.EasingDirection", "EasingStyle": "@roblox/globaltype/UIPageLayout.EasingStyle", "GamepadInputEnabled": "@roblox/globaltype/UIPageLayout.GamepadInputEnabled", "Padding": "@roblox/globaltype/UIPageLayout.Padding", "ScrollWheelInputEnabled": "@roblox/globaltype/UIPageLayout.ScrollWheelInputEnabled", "TouchInputEnabled": "@roblox/globaltype/UIPageLayout.TouchInputEnabled", "TweenTime": "@roblox/globaltype/UIPageLayout.TweenTime", "JumpTo": "@roblox/globaltype/UIPageLayout.JumpTo", "JumpToIndex": "@roblox/globaltype/UIPageLayout.JumpToIndex", "Next": "@roblox/globaltype/UIPageLayout.Next", "Previous": "@roblox/globaltype/UIPageLayout.Previous" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.Animated": { "documentation": "Whether or not to animate transitions between pages.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Animated", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.Circular": { "documentation": "Whether or not the page layout wraps around at the ends.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Circular", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.CurrentPage": { "documentation": "The page that is either currently being displayed or is the target of the current animation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#CurrentPage", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.EasingDirection": { "documentation": "The easing direction to use when performing an animation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#EasingDirection", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.EasingStyle": { "documentation": "The easing style to use when performing an animation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#EasingStyle", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.GamepadInputEnabled": { "documentation": "Controls the overrides of NextSelection{Up, Down, Left, Right}. Defaults to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#GamepadInputEnabled", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.Padding": { "documentation": "Determines the amount that pages are separated from each other by.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Padding", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.ScrollWheelInputEnabled": { "documentation": "Controls the use of scroll wheel, in case that it is intended for something else. Defaults to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#ScrollWheelInputEnabled", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.TouchInputEnabled": { "documentation": "Controls touch scrolling, in case this is a non-interactive layout. Defaults to true.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#TouchInputEnabled", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.TweenTime": { "documentation": "The length of the animation.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#TweenTime", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.JumpTo/param/0": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.JumpTo/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.JumpTo": { "documentation": "If the page is in the UIPageLayout, then it sets UIPageLayout.CurrentPage to it and animates to it. If the circular layout is enabled, it will take the shortest path to this page.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.JumpTo/param/0" }, { "name": "page", "documentation": "@roblox/globaltype/UIPageLayout.JumpTo/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#JumpTo", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.JumpToIndex/param/0": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.JumpToIndex/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.JumpToIndex": { "documentation": "If the index is >= 0 and less than the size of the layout, this method acts like UIPageLayout:JumpTo(). If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of UIPageLayout.CurrentPage and the new index.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.JumpToIndex/param/0" }, { "name": "index", "documentation": "@roblox/globaltype/UIPageLayout.JumpToIndex/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#JumpToIndex", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.Next/param/0": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.Next": { "documentation": "Sets UIPageLayout.CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.Next/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Next", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.Previous/param/0": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.Previous": { "documentation": "Sets UIPageLayout.CurrentPage to the page before the current page and animates to it, or does nothing if there isn't a previous page.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.Previous/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Previous", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.PageEnter.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageEnter.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.PageEnter.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageEnter.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageEnter.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.PageEnter.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageEnter.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageEnter.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.PageEnter.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageEnter.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageEnter.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageEnter.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageEnter": { "documentation": "Fires when a page comes into view, and is going to be rendered.", "keys": { "Connect": "@roblox/globaltype/UIPageLayout.PageEnter.Connect", "ConnectParallel": "@roblox/globaltype/UIPageLayout.PageEnter.ConnectParallel", "Once": "@roblox/globaltype/UIPageLayout.PageEnter.Once", "Wait": "@roblox/globaltype/UIPageLayout.PageEnter.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#PageEnter", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.PageLeave.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageLeave.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.PageLeave.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageLeave.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageLeave.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.PageLeave.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageLeave.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageLeave.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.PageLeave.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageLeave.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.PageLeave.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.PageLeave.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.PageLeave": { "documentation": "Fires when a page leaves view, and will not be rendered.", "keys": { "Connect": "@roblox/globaltype/UIPageLayout.PageLeave.Connect", "ConnectParallel": "@roblox/globaltype/UIPageLayout.PageLeave.ConnectParallel", "Once": "@roblox/globaltype/UIPageLayout.PageLeave.Once", "Wait": "@roblox/globaltype/UIPageLayout.PageLeave.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#PageLeave", "code_sample": "" }, "@roblox/globaltype/UIPageLayout.Stopped.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.Stopped.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.Stopped.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.Stopped.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.Stopped.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.Stopped.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.Stopped.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.Stopped.Once/param/1": { "documentation": "" }, "@roblox/globaltype/UIPageLayout.Stopped.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.Stopped.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/UIPageLayout.Stopped.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/UIPageLayout.Stopped.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/UIPageLayout.Stopped": { "documentation": "Fires when an animation to UIPageLayout.CurrentPage is completed without being canceled, and the view stops scrolling.", "keys": { "Connect": "@roblox/globaltype/UIPageLayout.Stopped.Connect", "ConnectParallel": "@roblox/globaltype/UIPageLayout.Stopped.ConnectParallel", "Once": "@roblox/globaltype/UIPageLayout.Stopped.Once", "Wait": "@roblox/globaltype/UIPageLayout.Stopped.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/UIPageLayout#Stopped", "code_sample": "" }, "@roblox/globaltype/RecommendationPages": { "documentation": "A special version of the Pages class returned by GenerateItemListAsync.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RecommendationPages", "code_sample": "" }, "@roblox/globaltype/AnimationClip": { "documentation": "Represents all types of animation data that the Roblox animation system can consume.", "keys": { "Loop": "@roblox/globaltype/AnimationClip.Loop", "Priority": "@roblox/globaltype/AnimationClip.Priority" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClip", "code_sample": "" }, "@roblox/globaltype/AnimationClip.Loop": { "documentation": "Determines whether the animation stored in this AnimationClip is intended to loop.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClip#Loop", "code_sample": "" }, "@roblox/globaltype/AnimationClip.Priority": { "documentation": "Determines which clip takes priority when multiple animations are playing simultaneously.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AnimationClip#Priority", "code_sample": "-- Create the sequence\nlocal keyframeSequence = Instance.new(\"KeyframeSequence\")\nkeyframeSequence.Loop = false\nkeyframeSequence.Priority = Enum.AnimationPriority.Action\n\n-- Create a keyframe\nlocal keyframe = Instance.new(\"Keyframe\")\nkeyframe.Time = 0\n\n-- Create sample poses\nlocal rootPose = Instance.new(\"Pose\")\nrootPose.Name = \"HumanoidRootPart\"\nrootPose.Weight = 0\nlocal lowerTorsoPose = Instance.new(\"Pose\")\nlowerTorsoPose.Name = \"LowerTorso\"\nlowerTorsoPose.Weight = 1\n\n-- Set the sequence hierarchy\nrootPose:AddSubPose(lowerTorsoPose)\nkeyframe:AddPose(rootPose)\nkeyframeSequence:AddKeyframe(keyframe)\n\n-- Parent the sequence\nkeyframeSequence.Parent = workspace" }, "@roblox/globaltype/GuiLabel": { "documentation": "An abstract class for non-interactive 2D user interface elements.", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GuiLabel", "code_sample": "" }, "@roblox/globaltype/ColorGradingEffect": { "documentation": "Modifies how color values calculated by the renderer should be converted to the screen's color range.", "keys": { "TonemapperPreset": "@roblox/globaltype/ColorGradingEffect.TonemapperPreset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorGradingEffect", "code_sample": "" }, "@roblox/globaltype/ColorGradingEffect.TonemapperPreset": { "documentation": "Specifies which tone mapper preset to use.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/ColorGradingEffect#TonemapperPreset", "code_sample": "" }, "@roblox/globaltype/FlagStand": { "documentation": "Deprecated: The FlagStand and Flag are deprecated objects that were used to make 'capture the flag' style games. Developers are advised to design their own systems which will be more flexible and reliable.
The FlagStand object helps you make 'capture the flag' style games.", "keys": { "TeamColor": "@roblox/globaltype/FlagStand.TeamColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlagStand", "code_sample": "" }, "@roblox/globaltype/FlagStand.TeamColor": { "documentation": "The Team that owns the FlagStand. Corresponds with the TeamColors in the Teams service.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlagStand#TeamColor", "code_sample": "" }, "@roblox/globaltype/FlagStand.FlagCaptured.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/FlagStand.FlagCaptured.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/FlagStand.FlagCaptured.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/FlagStand.FlagCaptured.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/FlagStand.FlagCaptured.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/FlagStand.FlagCaptured.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/FlagStand.FlagCaptured.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/FlagStand.FlagCaptured.Once/param/1": { "documentation": "" }, "@roblox/globaltype/FlagStand.FlagCaptured.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/FlagStand.FlagCaptured.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/FlagStand.FlagCaptured.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/FlagStand.FlagCaptured.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/FlagStand.FlagCaptured": { "documentation": "Fires when a player bearing an opposing flag, and having the same Player.TeamColor as the stand, touches the FlagStand.", "keys": { "Connect": "@roblox/globaltype/FlagStand.FlagCaptured.Connect", "ConnectParallel": "@roblox/globaltype/FlagStand.FlagCaptured.ConnectParallel", "Once": "@roblox/globaltype/FlagStand.FlagCaptured.Once", "Wait": "@roblox/globaltype/FlagStand.FlagCaptured.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/FlagStand#FlagCaptured", "code_sample": "" }, "@roblox/globaltype/SocialService": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform.", "keys": { "CanSendCallInviteAsync": "@roblox/globaltype/SocialService.CanSendCallInviteAsync", "CanSendGameInviteAsync": "@roblox/globaltype/SocialService.CanSendGameInviteAsync", "GetEventRsvpStatusAsync": "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync", "GetExperienceEventAsync": "@roblox/globaltype/SocialService.GetExperienceEventAsync", "GetPartyAsync": "@roblox/globaltype/SocialService.GetPartyAsync", "GetPlayersByPartyId": "@roblox/globaltype/SocialService.GetPlayersByPartyId", "GetUpcomingExperienceEventsAsync": "@roblox/globaltype/SocialService.GetUpcomingExperienceEventsAsync", "HideSelfView": "@roblox/globaltype/SocialService.HideSelfView", "PromptFeedbackSubmissionAsync": "@roblox/globaltype/SocialService.PromptFeedbackSubmissionAsync", "PromptGameInvite": "@roblox/globaltype/SocialService.PromptGameInvite", "PromptLinkSharingAsync": "@roblox/globaltype/SocialService.PromptLinkSharingAsync", "PromptLinkSharing": "@roblox/globaltype/SocialService.PromptLinkSharing", "PromptPhoneBook": "@roblox/globaltype/SocialService.PromptPhoneBook", "PromptRsvpToEventAsync": "@roblox/globaltype/SocialService.PromptRsvpToEventAsync", "ShowSelfView": "@roblox/globaltype/SocialService.ShowSelfView", "OnCallInviteInvoked": "@roblox/globaltype/SocialService.OnCallInviteInvoked" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService", "code_sample": "" }, "@roblox/globaltype/SocialService.CanSendCallInviteAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.CanSendCallInviteAsync/param/1": { "documentation": "The Player instance of the player potentially sending a call invite." }, "@roblox/globaltype/SocialService.CanSendCallInviteAsync/return/0": { "documentation": "Whether the specified player can send a call invite." }, "@roblox/globaltype/SocialService.CanSendCallInviteAsync": { "documentation": "Indicates whether the given Player can invite other players to a call.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.CanSendCallInviteAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/SocialService.CanSendCallInviteAsync/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.CanSendCallInviteAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#CanSendCallInviteAsync", "code_sample": "local Players = game:GetService(\"Players\")\nlocal SocialService = game:GetService(\"SocialService\")\n\nlocal player = Players.LocalPlayer\nlocal button = script.Parent\nbutton.Visible = false\n\n-- Function to check whether the player can send a call invite\nlocal function canSendCallingInvite(sendingPlayer)\n\tlocal success, canSend = pcall(function()\n\t\treturn SocialService:CanSendCallInviteAsync(sendingPlayer)\n\tend)\n\treturn success and canSend\nend\n\nlocal canCall = canSendCallingInvite(player)\nif canCall then\n\tbutton.Visible = true\n\tbutton.Activated:Connect(function()\n\t\tSocialService:PromptPhoneBook(player, \"\")\n\tend)\nend" }, "@roblox/globaltype/SocialService.CanSendGameInviteAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.CanSendGameInviteAsync/param/1": { "documentation": "The Player instance of the player potentially sending an invite." }, "@roblox/globaltype/SocialService.CanSendGameInviteAsync/param/2": { "documentation": "Optional Player.UserId of the potential recipient, used to check whether the sender can invite that specific recipient." }, "@roblox/globaltype/SocialService.CanSendGameInviteAsync/return/0": { "documentation": "Whether the specified player can send an invite." }, "@roblox/globaltype/SocialService.CanSendGameInviteAsync": { "documentation": "Indicates whether the given Player can invite other players.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.CanSendGameInviteAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/SocialService.CanSendGameInviteAsync/param/1" }, { "name": "recipientId", "documentation": "@roblox/globaltype/SocialService.CanSendGameInviteAsync/param/2" } ], "returns": [ "@roblox/globaltype/SocialService.CanSendGameInviteAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#CanSendGameInviteAsync", "code_sample": "local SocialService = game:GetService(\"SocialService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\n-- Function to check whether the player can send an invite\nlocal function canSendGameInvite(sendingPlayer)\n\tlocal success, canSend = pcall(function()\n\t\treturn SocialService:CanSendGameInviteAsync(sendingPlayer)\n\tend)\n\treturn success and canSend\nend\n\nlocal canInvite = canSendGameInvite(player)\nif canInvite then\n\tSocialService:PromptGameInvite(player)\nend" }, "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync/param/1": { "documentation": "The event ID of the event to prompt the player to change their RSVP status for. This must be a valid event ID that exists in the current experience, represented as a string (not a number)." }, "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync/return/0": { "documentation": "Returns an RsvpStatus indicating the player's current RSVP status for the event. If the player has not RSVP'd to the event, this will return RsvpStatus.None." }, "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync": { "documentation": "Returns the local player's RSVP status for the given event.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync/param/0" }, { "name": "eventId", "documentation": "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.GetEventRsvpStatusAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#GetEventRsvpStatusAsync", "code_sample": "" }, "@roblox/globaltype/SocialService.GetExperienceEventAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.GetExperienceEventAsync/param/1": { "documentation": "The string identifier of the event to retrieve. Must correspond to an event in the current experience." }, "@roblox/globaltype/SocialService.GetExperienceEventAsync/return/0": { "documentation": "A dictionary describing the event, or nil if the event does not exist, belongs to another experience, or is otherwise unavailable." }, "@roblox/globaltype/SocialService.GetExperienceEventAsync": { "documentation": "Returns details for the specified experience event or nil if it is unavailable.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GetExperienceEventAsync/param/0" }, { "name": "eventId", "documentation": "@roblox/globaltype/SocialService.GetExperienceEventAsync/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.GetExperienceEventAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#GetExperienceEventAsync", "code_sample": "" }, "@roblox/globaltype/SocialService.GetPartyAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.GetPartyAsync/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.GetPartyAsync/return/0": { "documentation": "An array of dictionaries representing the members of the specified party who are currently in the experience." }, "@roblox/globaltype/SocialService.GetPartyAsync": { "documentation": "Returns an array of dictionaries containing data for all members of the specified party who are currently in the experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GetPartyAsync/param/0" }, { "name": "partyId", "documentation": "@roblox/globaltype/SocialService.GetPartyAsync/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.GetPartyAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPartyAsync", "code_sample": "local SocialService = game:GetService(\"SocialService\")\nlocal Players = game:GetService(\"Players\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\tlocal partyId = player.PartyId\n\n\tif partyId == \"\" then\n\t\twarn(\"Player is not in a party\")\n\t\treturn\n\tend\n\n\tlocal success, partyData = pcall(function()\n\t\treturn SocialService:GetPartyAsync(partyId)\n\tend)\n\n\tif success and partyData then\n\t\tfor _, partyMemberData in partyData do\n\t\t\tprint(\n\t\t\t\tpartyMemberData.UserId,\n\t\t\t\tpartyMemberData.PlaceId,\n\t\t\t\tpartyMemberData.JobId,\n\t\t\t\tpartyMemberData.PrivateServerId,\n\t\t\t\tpartyMemberData.ReservedServerAccessCode\n\t\t\t)\n\t\tend\n\telse\n\t\twarn(\"Failed to retrieve party data\")\n\tend\nend)" }, "@roblox/globaltype/SocialService.GetPlayersByPartyId/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.GetPlayersByPartyId/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.GetPlayersByPartyId/return/0": { "documentation": "A table of Player objects whose Player.PartyId property matches the passed partyId." }, "@roblox/globaltype/SocialService.GetPlayersByPartyId": { "documentation": "Returns a table of all presently connected Player objects whose Player.PartyId property matches the passed partyId.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GetPlayersByPartyId/param/0" }, { "name": "partyId", "documentation": "@roblox/globaltype/SocialService.GetPlayersByPartyId/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.GetPlayersByPartyId/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#GetPlayersByPartyId", "code_sample": "local SocialService = game:GetService(\"SocialService\")\nlocal Players = game:GetService(\"Players\")\n\nPlayers.PlayerAdded:Connect(function(player)\n\tlocal partyId = player.PartyId\n\n\tif partyId ~= \"\" then\n\t\tlocal partyPlayers: { Player } = SocialService:GetPlayersByPartyId(partyId)\n\n\t\tfor _, partyMember in partyPlayers do\n\t\t\tprint(\"Party Member: \" .. partyMember.Name)\n\t\tend\n\telse\n\t\twarn(\"Player is not in a party\")\n\tend\nend)" }, "@roblox/globaltype/SocialService.GetUpcomingExperienceEventsAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.GetUpcomingExperienceEventsAsync/return/0": { "documentation": "An array of dictionaries describing each active or upcoming event in the current experience, ordered by soonest start time first." }, "@roblox/globaltype/SocialService.GetUpcomingExperienceEventsAsync": { "documentation": "Returns active and upcoming experience events for the current experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GetUpcomingExperienceEventsAsync/param/0" } ], "returns": [ "@roblox/globaltype/SocialService.GetUpcomingExperienceEventsAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#GetUpcomingExperienceEventsAsync", "code_sample": "" }, "@roblox/globaltype/SocialService.HideSelfView/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.HideSelfView": { "documentation": "Hides the calling player's self view.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.HideSelfView/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#HideSelfView", "code_sample": "" }, "@roblox/globaltype/SocialService.PromptFeedbackSubmissionAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.PromptFeedbackSubmissionAsync": { "documentation": "Prompts the player to submit feedback about the current experience.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PromptFeedbackSubmissionAsync/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptFeedbackSubmissionAsync", "code_sample": "" }, "@roblox/globaltype/SocialService.PromptGameInvite/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.PromptGameInvite/param/1": { "documentation": "The Player to prompt with the invite popup." }, "@roblox/globaltype/SocialService.PromptGameInvite/param/2": { "documentation": "Optional ExperienceInviteOptions object for customizing the prompt." }, "@roblox/globaltype/SocialService.PromptGameInvite": { "documentation": "Prompts the given Player with the invite screen.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PromptGameInvite/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/SocialService.PromptGameInvite/param/1" }, { "name": "experienceInviteOptions", "documentation": "@roblox/globaltype/SocialService.PromptGameInvite/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptGameInvite", "code_sample": "local SocialService = game:GetService(\"SocialService\")\nlocal Players = game:GetService(\"Players\")\n\nlocal player = Players.LocalPlayer\n\n-- Function to check whether the player can send an invite\nlocal function canSendGameInvite(sendingPlayer)\n\tlocal success, canSend = pcall(function()\n\t\treturn SocialService:CanSendGameInviteAsync(sendingPlayer)\n\tend)\n\treturn success and canSend\nend\n\nlocal canInvite = canSendGameInvite(player)\nif canInvite then\n\tSocialService:PromptGameInvite(player)\nend" }, "@roblox/globaltype/SocialService.PromptLinkSharingAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.PromptLinkSharingAsync/param/1": { "documentation": "Prompts the given Player with a Roblox platform-level share sheet with a generated share link." }, "@roblox/globaltype/SocialService.PromptLinkSharingAsync/param/2": { "documentation": "Dictionary that specifies the configuration for the generated link. It includes the following optional key-value pairs: " }, "@roblox/globaltype/SocialService.PromptLinkSharingAsync/return/0": { "documentation": "A tuple containing an PromptLinkSharingResult indicating the result of the link sharing prompt." }, "@roblox/globaltype/SocialService.PromptLinkSharingAsync": { "documentation": "", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PromptLinkSharingAsync/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/SocialService.PromptLinkSharingAsync/param/1" }, { "name": "options", "documentation": "@roblox/globaltype/SocialService.PromptLinkSharingAsync/param/2" } ], "returns": [ "@roblox/globaltype/SocialService.PromptLinkSharingAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharingAsync", "code_sample": "" }, "@roblox/globaltype/SocialService.PromptLinkSharing/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.PromptLinkSharing/param/1": { "documentation": "Prompts the given Player with a Roblox platform-level share sheet with a generated share link." }, "@roblox/globaltype/SocialService.PromptLinkSharing/param/2": { "documentation": "Dictionary that specifies the configuration for the generated link. It includes the following optional key-value pairs: " }, "@roblox/globaltype/SocialService.PromptLinkSharing/return/0": { "documentation": "A tuple containing an PromptLinkSharingResult indicating the result of the link sharing prompt." }, "@roblox/globaltype/SocialService.PromptLinkSharing": { "documentation": "Deprecated: ", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PromptLinkSharing/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/SocialService.PromptLinkSharing/param/1" }, { "name": "options", "documentation": "@roblox/globaltype/SocialService.PromptLinkSharing/param/2" } ], "returns": [ "@roblox/globaltype/SocialService.PromptLinkSharing/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharing", "code_sample": "" }, "@roblox/globaltype/SocialService.PromptPhoneBook/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.PromptPhoneBook/param/1": { "documentation": "The player to prompt with the phone book." }, "@roblox/globaltype/SocialService.PromptPhoneBook/param/2": { "documentation": "String to help differentiate between various phone book \"entry points\" or similar. For example, you can pass a string defining what region of an experience the calling player's character is currently in." }, "@roblox/globaltype/SocialService.PromptPhoneBook": { "documentation": "Prompts the given Player with the phone book.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PromptPhoneBook/param/0" }, { "name": "player", "documentation": "@roblox/globaltype/SocialService.PromptPhoneBook/param/1" }, { "name": "tag", "documentation": "@roblox/globaltype/SocialService.PromptPhoneBook/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptPhoneBook", "code_sample": "local Players = game:GetService(\"Players\")\nlocal SocialService = game:GetService(\"SocialService\")\n\nlocal player = Players.LocalPlayer\nlocal button = script.Parent\nbutton.Visible = false\n\n-- Function to check whether the player can send a call invite\nlocal function canSendCallingInvite(sendingPlayer)\n\tlocal success, canSend = pcall(function()\n\t\treturn SocialService:CanSendCallInviteAsync(sendingPlayer)\n\tend)\n\treturn success and canSend\nend\n\nlocal canCall = canSendCallingInvite(player)\nif canCall then\n\tbutton.Visible = true\n\tbutton.Activated:Connect(function()\n\t\tSocialService:PromptPhoneBook(player, \"\")\n\tend)\nend" }, "@roblox/globaltype/SocialService.PromptRsvpToEventAsync/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.PromptRsvpToEventAsync/param/1": { "documentation": "The event ID of the event to prompt the player to change their RSVP status for. This must be a valid event ID that exists in the current experience, represented as a string (not a number)." }, "@roblox/globaltype/SocialService.PromptRsvpToEventAsync/return/0": { "documentation": "Returns a RsvpStatus indicating the player's new RSVP status after the prompt is closed. If the player closes the prompt without changing their RSVP status, this will return RsvpStatus.None or their old RsvpStatus if they had already selected a status." }, "@roblox/globaltype/SocialService.PromptRsvpToEventAsync": { "documentation": "Prompts the local Player with a prompt to change their RSVP status to the given event.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PromptRsvpToEventAsync/param/0" }, { "name": "eventId", "documentation": "@roblox/globaltype/SocialService.PromptRsvpToEventAsync/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.PromptRsvpToEventAsync/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptRsvpToEventAsync", "code_sample": "" }, "@roblox/globaltype/SocialService.ShowSelfView/param/0": { "documentation": "Facilitates social functions that impact relationships made on the Roblox platform." }, "@roblox/globaltype/SocialService.ShowSelfView/param/1": { "documentation": "The position to place the self view ." }, "@roblox/globaltype/SocialService.ShowSelfView": { "documentation": "Shows the calling player's self view.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.ShowSelfView/param/0" }, { "name": "selfViewPosition", "documentation": "@roblox/globaltype/SocialService.ShowSelfView/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#ShowSelfView", "code_sample": "" }, "@roblox/globaltype/SocialService.OnCallInviteInvoked/param/0": { "documentation": "String to help differentiate between various phone book entry points." }, "@roblox/globaltype/SocialService.OnCallInviteInvoked/param/1": { "documentation": "Array containing all of the players involved in the call. The caller will always be the first player in the array." }, "@roblox/globaltype/SocialService.OnCallInviteInvoked/return/0": { "documentation": "Table including the PlaceId and ReservedServerAccessCode keys whose values are the DataModel.PlaceId and the server access code returned by TeleportService:ReserveServerAsync(), respectively." }, "@roblox/globaltype/SocialService.OnCallInviteInvoked": { "documentation": "Callback for when a call is placed from the phone book.", "params": [ { "name": "tag", "documentation": "@roblox/globaltype/SocialService.OnCallInviteInvoked/param/0" }, { "name": "callParticipantIds", "documentation": "@roblox/globaltype/SocialService.OnCallInviteInvoked/param/1" } ], "returns": [ "@roblox/globaltype/SocialService.OnCallInviteInvoked/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#OnCallInviteInvoked", "code_sample": "" }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.CallInviteStateChanged.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.CallInviteStateChanged.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.CallInviteStateChanged.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.CallInviteStateChanged.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.CallInviteStateChanged.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SocialService.CallInviteStateChanged": { "documentation": "Fires when a player's call invite state changes.", "keys": { "Connect": "@roblox/globaltype/SocialService.CallInviteStateChanged.Connect", "ConnectParallel": "@roblox/globaltype/SocialService.CallInviteStateChanged.ConnectParallel", "Once": "@roblox/globaltype/SocialService.CallInviteStateChanged.Once", "Wait": "@roblox/globaltype/SocialService.CallInviteStateChanged.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#CallInviteStateChanged", "code_sample": "local SocialService = game:GetService(\"SocialService\")\n\nlocal button = script.Parent\nlocal isPhonebookOpen = false\n\nSocialService.CallInviteStateChanged:Connect(function(_, inviteState)\n\tlocal isCalling = inviteState == Enum.InviteState.Placed\n\n\tif isCalling or isPhonebookOpen then\n\t\tbutton.Visible = false\n\telse\n\t\tbutton.Visible = true\n\tend\nend)" }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.GameInvitePromptClosed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SocialService.GameInvitePromptClosed": { "documentation": "Fires when a player closes an invite prompt.", "keys": { "Connect": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Connect", "ConnectParallel": "@roblox/globaltype/SocialService.GameInvitePromptClosed.ConnectParallel", "Once": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Once", "Wait": "@roblox/globaltype/SocialService.GameInvitePromptClosed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#GameInvitePromptClosed", "code_sample": "" }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SocialService.PhoneBookPromptClosed": { "documentation": "Fires when a player closes the phone book prompt.", "keys": { "Connect": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Connect", "ConnectParallel": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.ConnectParallel", "Once": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Once", "Wait": "@roblox/globaltype/SocialService.PhoneBookPromptClosed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#PhoneBookPromptClosed", "code_sample": "" }, "@roblox/globaltype/SocialService.ShareSheetClosed.Connect/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.ShareSheetClosed.Connect/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.ShareSheetClosed.Connect": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Connect", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.Connect/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.Connect/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.ShareSheetClosed.ConnectParallel/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.ShareSheetClosed.ConnectParallel/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.ShareSheetClosed.ConnectParallel": { "documentation": "Connects the given function to the event and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#ConnectParallel", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.ConnectParallel/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.ConnectParallel/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.ShareSheetClosed.Once/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.ShareSheetClosed.Once/param/1": { "documentation": "" }, "@roblox/globaltype/SocialService.ShareSheetClosed.Once": { "documentation": "Connects the given function to the event (for a single invocation) and returns an RBXScriptConnection that represents it.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Once", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.Once/param/0" }, { "name": "func", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.Once/param/1" } ], "returns": [] }, "@roblox/globaltype/SocialService.ShareSheetClosed.Wait/param/0": { "documentation": "An object that runs connected functions upon a specific occurrence." }, "@roblox/globaltype/SocialService.ShareSheetClosed.Wait": { "documentation": "Yields the current thread until the signal fires and returns the arguments provided by the signal.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/datatypes/RBXScriptSignal#Wait", "params": [ { "name": "self", "documentation": "@roblox/globaltype/SocialService.ShareSheetClosed.Wait/param/0" } ], "returns": [] }, "@roblox/globaltype/SocialService.ShareSheetClosed": { "documentation": "", "keys": { "Connect": "@roblox/globaltype/SocialService.ShareSheetClosed.Connect", "ConnectParallel": "@roblox/globaltype/SocialService.ShareSheetClosed.ConnectParallel", "Once": "@roblox/globaltype/SocialService.ShareSheetClosed.Once", "Wait": "@roblox/globaltype/SocialService.ShareSheetClosed.Wait" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/SocialService#ShareSheetClosed", "code_sample": "" }, "@roblox/globaltype/RenderingTest": { "documentation": "An internal testing utility for the rendering pipeline.", "keys": { "CFrame": "@roblox/globaltype/RenderingTest.CFrame", "ComparisonDiffThreshold": "@roblox/globaltype/RenderingTest.ComparisonDiffThreshold", "ComparisonMethod": "@roblox/globaltype/RenderingTest.ComparisonMethod", "ComparisonPsnrThreshold": "@roblox/globaltype/RenderingTest.ComparisonPsnrThreshold", "Description": "@roblox/globaltype/RenderingTest.Description", "FieldOfView": "@roblox/globaltype/RenderingTest.FieldOfView", "Orientation": "@roblox/globaltype/RenderingTest.Orientation", "PerfTest": "@roblox/globaltype/RenderingTest.PerfTest", "Position": "@roblox/globaltype/RenderingTest.Position", "QualityAuto": "@roblox/globaltype/RenderingTest.QualityAuto", "QualityLevel": "@roblox/globaltype/RenderingTest.QualityLevel", "RenderingTestFrameCount": "@roblox/globaltype/RenderingTest.RenderingTestFrameCount", "ShouldSkip": "@roblox/globaltype/RenderingTest.ShouldSkip", "Ticket": "@roblox/globaltype/RenderingTest.Ticket", "Timeout": "@roblox/globaltype/RenderingTest.Timeout", "RenderdocTriggerCapture": "@roblox/globaltype/RenderingTest.RenderdocTriggerCapture" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest", "code_sample": "" }, "@roblox/globaltype/RenderingTest.CFrame": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#CFrame", "code_sample": "" }, "@roblox/globaltype/RenderingTest.ComparisonDiffThreshold": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#ComparisonDiffThreshold", "code_sample": "" }, "@roblox/globaltype/RenderingTest.ComparisonMethod": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#ComparisonMethod", "code_sample": "" }, "@roblox/globaltype/RenderingTest.ComparisonPsnrThreshold": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#ComparisonPsnrThreshold", "code_sample": "" }, "@roblox/globaltype/RenderingTest.Description": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#Description", "code_sample": "" }, "@roblox/globaltype/RenderingTest.FieldOfView": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#FieldOfView", "code_sample": "" }, "@roblox/globaltype/RenderingTest.Orientation": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#Orientation", "code_sample": "" }, "@roblox/globaltype/RenderingTest.PerfTest": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#PerfTest", "code_sample": "" }, "@roblox/globaltype/RenderingTest.Position": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#Position", "code_sample": "" }, "@roblox/globaltype/RenderingTest.QualityAuto": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#QualityAuto", "code_sample": "" }, "@roblox/globaltype/RenderingTest.QualityLevel": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#QualityLevel", "code_sample": "" }, "@roblox/globaltype/RenderingTest.RenderingTestFrameCount": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#RenderingTestFrameCount", "code_sample": "" }, "@roblox/globaltype/RenderingTest.ShouldSkip": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#ShouldSkip", "code_sample": "" }, "@roblox/globaltype/RenderingTest.Ticket": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#Ticket", "code_sample": "" }, "@roblox/globaltype/RenderingTest.Timeout": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#Timeout", "code_sample": "" }, "@roblox/globaltype/RenderingTest.RenderdocTriggerCapture/param/0": { "documentation": "An internal testing utility for the rendering pipeline." }, "@roblox/globaltype/RenderingTest.RenderdocTriggerCapture": { "documentation": "An internal service which cannot be used by developers.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/RenderingTest.RenderdocTriggerCapture/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/RenderingTest#RenderdocTriggerCapture", "code_sample": "" }, "@roblox/globaltype/GetTextBoundsParams": { "documentation": "Use with TextService:GetTextBoundsAsync() to measure the size of text.", "keys": { "Font": "@roblox/globaltype/GetTextBoundsParams.Font", "RichText": "@roblox/globaltype/GetTextBoundsParams.RichText", "Size": "@roblox/globaltype/GetTextBoundsParams.Size", "Text": "@roblox/globaltype/GetTextBoundsParams.Text", "Width": "@roblox/globaltype/GetTextBoundsParams.Width" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams", "code_sample": "" }, "@roblox/globaltype/GetTextBoundsParams.Font": { "documentation": "The Font of the text being measured.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams#Font", "code_sample": "" }, "@roblox/globaltype/GetTextBoundsParams.RichText": { "documentation": "", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams#RichText", "code_sample": "" }, "@roblox/globaltype/GetTextBoundsParams.Size": { "documentation": "The size of the text being measured.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams#Size", "code_sample": "" }, "@roblox/globaltype/GetTextBoundsParams.Text": { "documentation": "The text being measured.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams#Text", "code_sample": "" }, "@roblox/globaltype/GetTextBoundsParams.Width": { "documentation": "The width of the container for line breaking.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/GetTextBoundsParams#Width", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription": { "documentation": "Describes the appearance of an Accessory for the HumanoidDescription.", "keys": { "AccessoryType": "@roblox/globaltype/AccessoryDescription.AccessoryType", "AssetId": "@roblox/globaltype/AccessoryDescription.AssetId", "Instance": "@roblox/globaltype/AccessoryDescription.Instance", "IsLayered": "@roblox/globaltype/AccessoryDescription.IsLayered", "Order": "@roblox/globaltype/AccessoryDescription.Order", "Position": "@roblox/globaltype/AccessoryDescription.Position", "Puffiness": "@roblox/globaltype/AccessoryDescription.Puffiness", "Rotation": "@roblox/globaltype/AccessoryDescription.Rotation", "Scale": "@roblox/globaltype/AccessoryDescription.Scale", "GetAppliedInstance": "@roblox/globaltype/AccessoryDescription.GetAppliedInstance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.AccessoryType": { "documentation": "The AccessoryType of the Accessory referred to by this description.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#AccessoryType", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.AssetId": { "documentation": "The asset ID that should be applied when applying this AccessoryDescription.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#AssetId", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.Instance": { "documentation": "A reference to the Instance that should be applied when applying this AccessoryDescription.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Instance", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.IsLayered": { "documentation": "Whether the Accessory is layered or rigid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#IsLayered", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.Order": { "documentation": "The layered clothing sort order, if the Accessory is layered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Order", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.Position": { "documentation": "The accessory adjustment position offset, if the Accessory is rigid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Position", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.Puffiness": { "documentation": "The layered clothing puffiness, if the Accessory is layered.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Puffiness", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.Rotation": { "documentation": "The accessory adjustment rotation offset, if the Accessory is rigid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Rotation", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.Scale": { "documentation": "The accessory adjustment scale, if the Accessory is rigid.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#Scale", "code_sample": "" }, "@roblox/globaltype/AccessoryDescription.GetAppliedInstance/param/0": { "documentation": "Describes the appearance of an Accessory for the HumanoidDescription." }, "@roblox/globaltype/AccessoryDescription.GetAppliedInstance/return/0": { "documentation": "" }, "@roblox/globaltype/AccessoryDescription.GetAppliedInstance": { "documentation": "Returns the applied Accessory.", "params": [ { "name": "self", "documentation": "@roblox/globaltype/AccessoryDescription.GetAppliedInstance/param/0" } ], "returns": [ "@roblox/globaltype/AccessoryDescription.GetAppliedInstance/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/classes/AccessoryDescription#GetAppliedInstance", "code_sample": "" }, "@roblox/enum/VelocityConstraintMode.Line": { "documentation": "The velocity component in the direction of the line is constrained to the specified value. The line direction is based on the RelativeTo property: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VelocityConstraintMode#Line", "code_sample": "" }, "@roblox/enum/VelocityConstraintMode.Plane": { "documentation": "The velocity components in the plane are constrained to the specified values. The plane tangents are based on the RelativeTo property: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VelocityConstraintMode#Plane", "code_sample": "" }, "@roblox/enum/VelocityConstraintMode.Vector": { "documentation": "The velocity components must be equal to the vector components specified. The coordinate system of the vector is based on the RelativeTo property: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VelocityConstraintMode#Vector", "code_sample": "" }, "@roblox/global/Enum.VelocityConstraintMode": { "documentation": "The velocity constraint mode property controls how the linear velocity of the attachment(s) is constrained.", "keys": { "Line": "@roblox/enum/VelocityConstraintMode.Line", "Plane": "@roblox/enum/VelocityConstraintMode.Plane", "Vector": "@roblox/enum/VelocityConstraintMode.Vector" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VelocityConstraintMode", "code_sample": "" }, "@roblox/enum/PlayerDataLoadFailureBehavior.Failure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataLoadFailureBehavior#Failure", "code_sample": "" }, "@roblox/enum/PlayerDataLoadFailureBehavior.FallbackToDefault": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataLoadFailureBehavior#FallbackToDefault", "code_sample": "" }, "@roblox/enum/PlayerDataLoadFailureBehavior.Kick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataLoadFailureBehavior#Kick", "code_sample": "" }, "@roblox/global/Enum.PlayerDataLoadFailureBehavior": { "documentation": "", "keys": { "Failure": "@roblox/enum/PlayerDataLoadFailureBehavior.Failure", "FallbackToDefault": "@roblox/enum/PlayerDataLoadFailureBehavior.FallbackToDefault", "Kick": "@roblox/enum/PlayerDataLoadFailureBehavior.Kick" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataLoadFailureBehavior", "code_sample": "" }, "@roblox/enum/Language.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Language#Default", "code_sample": "" }, "@roblox/global/Enum.Language": { "documentation": "", "keys": { "Default": "@roblox/enum/Language.Default" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Language", "code_sample": "" }, "@roblox/enum/CustomCameraMode.Default": { "documentation": "The default camera mode is classic.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode#Default", "code_sample": "" }, "@roblox/enum/CustomCameraMode.Classic": { "documentation": "Camera tracks the player but will not automatically rotate if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode#Classic", "code_sample": "" }, "@roblox/enum/CustomCameraMode.Follow": { "documentation": "Camera tracks the player and automatically rotates if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode#Follow", "code_sample": "" }, "@roblox/global/Enum.CustomCameraMode": { "documentation": "Changes the player's camera mode.", "keys": { "Default": "@roblox/enum/CustomCameraMode.Default", "Classic": "@roblox/enum/CustomCameraMode.Classic", "Follow": "@roblox/enum/CustomCameraMode.Follow" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CustomCameraMode", "code_sample": "" }, "@roblox/enum/VerticalScrollBarPosition.Right": { "documentation": "Right side of the ScrollingFrame.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalScrollBarPosition#Right", "code_sample": "" }, "@roblox/enum/VerticalScrollBarPosition.Left": { "documentation": "Left side of the ScrollingFrame.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalScrollBarPosition#Left", "code_sample": "" }, "@roblox/global/Enum.VerticalScrollBarPosition": { "documentation": "This enum is used for ScrollingFrame.VerticalScrollBarPosition to indicate vertical scroll bar positioning.", "keys": { "Right": "@roblox/enum/VerticalScrollBarPosition.Right", "Left": "@roblox/enum/VerticalScrollBarPosition.Left" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalScrollBarPosition", "code_sample": "" }, "@roblox/enum/ElasticBehavior.WhenScrollable": { "documentation": "Scrolling is elastic when there is content to be scrolled to.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#WhenScrollable", "code_sample": "" }, "@roblox/enum/ElasticBehavior.Always": { "documentation": "Scrolling is always elastic, even when there isn't content available to scroll to.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#Always", "code_sample": "" }, "@roblox/enum/ElasticBehavior.Never": { "documentation": "Scrolling is never elastic and the canvas will never scroll beyond its bounds.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior#Never", "code_sample": "" }, "@roblox/global/Enum.ElasticBehavior": { "documentation": "This enum is used by ScrollingFrame.ElasticBehavior to control when elastic scrolling is active on touch‑enabled devices.", "keys": { "WhenScrollable": "@roblox/enum/ElasticBehavior.WhenScrollable", "Always": "@roblox/enum/ElasticBehavior.Always", "Never": "@roblox/enum/ElasticBehavior.Never" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ElasticBehavior", "code_sample": "" }, "@roblox/enum/SurfaceGuiSizingMode.FixedSize": { "documentation": "Renders with a fixed size set using SurfaceGui.CanvasSize.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceGuiSizingMode#FixedSize", "code_sample": "" }, "@roblox/enum/SurfaceGuiSizingMode.PixelsPerStud": { "documentation": "Renders with a variable size based on SurfaceGui.PixelsPerStud and the SurfaceGui's size in studs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceGuiSizingMode#PixelsPerStud", "code_sample": "" }, "@roblox/global/Enum.SurfaceGuiSizingMode": { "documentation": "Used by SurfaceGui.SizingMode to control the sizing behavior of a SurfaceGui.", "keys": { "FixedSize": "@roblox/enum/SurfaceGuiSizingMode.FixedSize", "PixelsPerStud": "@roblox/enum/SurfaceGuiSizingMode.PixelsPerStud" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceGuiSizingMode", "code_sample": "" }, "@roblox/enum/ComputerCameraMovementMode.Default": { "documentation": "The default camera movement mode is classic.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Default", "code_sample": "" }, "@roblox/enum/ComputerCameraMovementMode.Classic": { "documentation": "Camera tracks the player but will not automatically rotate if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Classic", "code_sample": "" }, "@roblox/enum/ComputerCameraMovementMode.Follow": { "documentation": "Camera tracks the player and automatically rotates if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Follow", "code_sample": "" }, "@roblox/enum/ComputerCameraMovementMode.Orbital": { "documentation": "The camera has a fixed Y position, but can be rotated around the player.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#Orbital", "code_sample": "" }, "@roblox/enum/ComputerCameraMovementMode.CameraToggle": { "documentation": "The camera toggles between locked and free rotation with the right mouse button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode#CameraToggle", "code_sample": "" }, "@roblox/global/Enum.ComputerCameraMovementMode": { "documentation": "The camera movement mode currently in-use by the client.", "keys": { "Default": "@roblox/enum/ComputerCameraMovementMode.Default", "Classic": "@roblox/enum/ComputerCameraMovementMode.Classic", "Follow": "@roblox/enum/ComputerCameraMovementMode.Follow", "Orbital": "@roblox/enum/ComputerCameraMovementMode.Orbital", "CameraToggle": "@roblox/enum/ComputerCameraMovementMode.CameraToggle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerCameraMovementMode", "code_sample": "" }, "@roblox/enum/GuiState.Idle": { "documentation": "The GUI currently has no state.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiState#Idle", "code_sample": "" }, "@roblox/enum/GuiState.Hover": { "documentation": "The GUI is being hovered over by the user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiState#Hover", "code_sample": "" }, "@roblox/enum/GuiState.Press": { "documentation": "The GUI is being pressed/held down by the user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiState#Press", "code_sample": "" }, "@roblox/enum/GuiState.NonInteractable": { "documentation": "The GUI cannot be interacted with and therefore has no states.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiState#NonInteractable", "code_sample": "" }, "@roblox/global/Enum.GuiState": { "documentation": "", "keys": { "Idle": "@roblox/enum/GuiState.Idle", "Hover": "@roblox/enum/GuiState.Hover", "Press": "@roblox/enum/GuiState.Press", "NonInteractable": "@roblox/enum/GuiState.NonInteractable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiState", "code_sample": "" }, "@roblox/enum/SubscriptionPaymentStatus.Paid": { "documentation": "Payment for the subscription has been received.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus#Paid", "code_sample": "" }, "@roblox/enum/SubscriptionPaymentStatus.Refunded": { "documentation": "Payment for the subscription has been refunded.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus#Refunded", "code_sample": "" }, "@roblox/global/Enum.SubscriptionPaymentStatus": { "documentation": "", "keys": { "Paid": "@roblox/enum/SubscriptionPaymentStatus.Paid", "Refunded": "@roblox/enum/SubscriptionPaymentStatus.Refunded" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionPaymentStatus", "code_sample": "" }, "@roblox/enum/JointCreationMode.All": { "documentation": "Joints are created between any kind of surface. Functions identically to Surface.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/JointCreationMode#All", "code_sample": "" }, "@roblox/enum/JointCreationMode.Surface": { "documentation": "Joints are created between any kind of surface. Functions identically to All.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/JointCreationMode#Surface", "code_sample": "" }, "@roblox/enum/JointCreationMode.None": { "documentation": "Joints are never created, no matter what.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/JointCreationMode#None", "code_sample": "" }, "@roblox/global/Enum.JointCreationMode": { "documentation": "The way joints are created between two surfaces.", "keys": { "All": "@roblox/enum/JointCreationMode.All", "Surface": "@roblox/enum/JointCreationMode.Surface", "None": "@roblox/enum/JointCreationMode.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/JointCreationMode", "code_sample": "" }, "@roblox/enum/MessageType.MessageOutput": { "documentation": "The message is from the standard output channel.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MessageType#MessageOutput", "code_sample": "" }, "@roblox/enum/MessageType.MessageInfo": { "documentation": "The message is from the information channel.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MessageType#MessageInfo", "code_sample": "" }, "@roblox/enum/MessageType.MessageWarning": { "documentation": "The message is from the warning channel.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MessageType#MessageWarning", "code_sample": "" }, "@roblox/enum/MessageType.MessageError": { "documentation": "The message is from the error channel.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MessageType#MessageError", "code_sample": "" }, "@roblox/global/Enum.MessageType": { "documentation": "Message category and severity level.", "keys": { "MessageOutput": "@roblox/enum/MessageType.MessageOutput", "MessageInfo": "@roblox/enum/MessageType.MessageInfo", "MessageWarning": "@roblox/enum/MessageType.MessageWarning", "MessageError": "@roblox/enum/MessageType.MessageError" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MessageType", "code_sample": "" }, "@roblox/enum/RecommendationItemVisibility.Private": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemVisibility#Private", "code_sample": "" }, "@roblox/enum/RecommendationItemVisibility.Public": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemVisibility#Public", "code_sample": "" }, "@roblox/global/Enum.RecommendationItemVisibility": { "documentation": "", "keys": { "Private": "@roblox/enum/RecommendationItemVisibility.Private", "Public": "@roblox/enum/RecommendationItemVisibility.Public" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemVisibility", "code_sample": "" }, "@roblox/enum/StreamingPauseMode.Default": { "documentation": "Deprecated:
Default behavior (currently no change to gameplay).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingPauseMode#Default", "code_sample": "" }, "@roblox/enum/StreamingPauseMode.Disabled": { "documentation": "Deprecated:
No change to gameplay due to streaming region availability.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingPauseMode#Disabled", "code_sample": "" }, "@roblox/enum/StreamingPauseMode.ClientPhysicsPause": { "documentation": "Deprecated:
Client owned physics is paused.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingPauseMode#ClientPhysicsPause", "code_sample": "" }, "@roblox/global/Enum.StreamingPauseMode": { "documentation": "Determines how a Players client should handle not having enough content streamed in to continue playing properly.", "keys": { "Default": "@roblox/enum/StreamingPauseMode.Default", "Disabled": "@roblox/enum/StreamingPauseMode.Disabled", "ClientPhysicsPause": "@roblox/enum/StreamingPauseMode.ClientPhysicsPause" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingPauseMode", "code_sample": "" }, "@roblox/enum/AssetTypeVerification.Default": { "documentation": "Use the default behavior for asset type verification.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification#Default", "code_sample": "" }, "@roblox/enum/AssetTypeVerification.ClientOnly": { "documentation": "Only verify asset types on the client. Asset type verification can not be turned off on the client.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification#ClientOnly", "code_sample": "" }, "@roblox/enum/AssetTypeVerification.Always": { "documentation": "Always verify the asset types to be loaded and disallow loading models.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification#Always", "code_sample": "" }, "@roblox/global/Enum.AssetTypeVerification": { "documentation": "Determines the asset type verification mode.", "keys": { "Default": "@roblox/enum/AssetTypeVerification.Default", "ClientOnly": "@roblox/enum/AssetTypeVerification.ClientOnly", "Always": "@roblox/enum/AssetTypeVerification.Always" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetTypeVerification", "code_sample": "" }, "@roblox/enum/AvatarSettingsScaleMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsScaleMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsScaleMode.CustomScale": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsScaleMode#CustomScale", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsScaleMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsScaleMode.PlayerChoice", "CustomScale": "@roblox/enum/AvatarSettingsScaleMode.CustomScale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsScaleMode", "code_sample": "" }, "@roblox/enum/AvatarSettingsAnimationPacksMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsAnimationPacksMode.StandardR15": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode#StandardR15", "code_sample": "" }, "@roblox/enum/AvatarSettingsAnimationPacksMode.StandardR6": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode#StandardR6", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsAnimationPacksMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsAnimationPacksMode.PlayerChoice", "StandardR15": "@roblox/enum/AvatarSettingsAnimationPacksMode.StandardR15", "StandardR6": "@roblox/enum/AvatarSettingsAnimationPacksMode.StandardR6" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationPacksMode", "code_sample": "" }, "@roblox/enum/AlignType.Parallel": { "documentation": "Deprecated: Use PrimaryAxisParallel instead.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType#Parallel", "code_sample": "" }, "@roblox/enum/AlignType.Perpendicular": { "documentation": "Deprecated: Use PrimaryAxisPerpendicular instead.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType#Perpendicular", "code_sample": "" }, "@roblox/enum/AlignType.PrimaryAxisParallel": { "documentation": "Aligns the primary axis to be parallel to the axis given by Constraint.Attachment1.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType#PrimaryAxisParallel", "code_sample": "" }, "@roblox/enum/AlignType.PrimaryAxisPerpendicular": { "documentation": "Aligns the primary axis to be perpendicular to the axis given by Constraint.Attachment1.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType#PrimaryAxisPerpendicular", "code_sample": "" }, "@roblox/enum/AlignType.PrimaryAxisLookAt": { "documentation": "Aligns the primary axis to look at the point given by Constraint.Attachment1 or the AlignOrientation.LookAtPosition.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType#PrimaryAxisLookAt", "code_sample": "" }, "@roblox/enum/AlignType.AllAxes": { "documentation": "Aligns all of the axes of Constraint.Attachment0 to the axes given by Constraint.Attachment1 or to the target orientation provided by AlignOrientation.PrimaryAxis and AlignOrientation.SecondaryAxis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType#AllAxes", "code_sample": "" }, "@roblox/global/Enum.AlignType": { "documentation": "An enum that specifies how the constraint will attempt to align the body associated with the constraint.", "keys": { "Parallel": "@roblox/enum/AlignType.Parallel", "Perpendicular": "@roblox/enum/AlignType.Perpendicular", "PrimaryAxisParallel": "@roblox/enum/AlignType.PrimaryAxisParallel", "PrimaryAxisPerpendicular": "@roblox/enum/AlignType.PrimaryAxisPerpendicular", "PrimaryAxisLookAt": "@roblox/enum/AlignType.PrimaryAxisLookAt", "AllAxes": "@roblox/enum/AlignType.AllAxes" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlignType", "code_sample": "" }, "@roblox/enum/RunState.Stopped": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunState#Stopped", "code_sample": "" }, "@roblox/enum/RunState.Running": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunState#Running", "code_sample": "" }, "@roblox/enum/RunState.Paused": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunState#Paused", "code_sample": "" }, "@roblox/global/Enum.RunState": { "documentation": "", "keys": { "Stopped": "@roblox/enum/RunState.Stopped", "Running": "@roblox/enum/RunState.Running", "Paused": "@roblox/enum/RunState.Paused" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunState", "code_sample": "" }, "@roblox/enum/NegateOperationHiddenHistory.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NegateOperationHiddenHistory#None", "code_sample": "" }, "@roblox/enum/NegateOperationHiddenHistory.NegatedUnion": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NegateOperationHiddenHistory#NegatedUnion", "code_sample": "" }, "@roblox/enum/NegateOperationHiddenHistory.NegatedIntersection": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NegateOperationHiddenHistory#NegatedIntersection", "code_sample": "" }, "@roblox/global/Enum.NegateOperationHiddenHistory": { "documentation": "", "keys": { "None": "@roblox/enum/NegateOperationHiddenHistory.None", "NegatedUnion": "@roblox/enum/NegateOperationHiddenHistory.NegatedUnion", "NegatedIntersection": "@roblox/enum/NegateOperationHiddenHistory.NegatedIntersection" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NegateOperationHiddenHistory", "code_sample": "" }, "@roblox/enum/RenderFidelity.Automatic": { "documentation": "Object's level of detail is dynamically controlled by its distance from the camera (see table above).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderFidelity#Automatic", "code_sample": "" }, "@roblox/enum/RenderFidelity.Precise": { "documentation": "Object is rendered in the highest fidelity regardless of its distance from the camera.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderFidelity#Precise", "code_sample": "" }, "@roblox/enum/RenderFidelity.Performance": { "documentation": "Push performance as much as possible, trying to maintain quality if possible, and discarding appearance if that's necessary to reach performance. This means that the performance will always be excellent, but mesh visuals may be affected negatively.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderFidelity#Performance", "code_sample": "" }, "@roblox/global/Enum.RenderFidelity": { "documentation": "Determines the level of detail that solid modeled and mesh parts will be shown in.", "keys": { "Automatic": "@roblox/enum/RenderFidelity.Automatic", "Precise": "@roblox/enum/RenderFidelity.Precise", "Performance": "@roblox/enum/RenderFidelity.Performance" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderFidelity", "code_sample": "" }, "@roblox/enum/DragDetectorPermissionPolicy.Nobody": { "documentation": "No players can interact with the DragDetector.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy#Nobody", "code_sample": "" }, "@roblox/enum/DragDetectorPermissionPolicy.Everybody": { "documentation": "All players can interact with the DragDetector.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy#Everybody", "code_sample": "" }, "@roblox/enum/DragDetectorPermissionPolicy.Scriptable": { "documentation": "Invokes the function registered via DragDetector:SetPermissionPolicyFunction(), enabling/disabling the detector based on whether the function returns true or false.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy#Scriptable", "code_sample": "" }, "@roblox/global/Enum.DragDetectorPermissionPolicy": { "documentation": "Used to control the permission level for which players can interact with a DragDetector.", "keys": { "Nobody": "@roblox/enum/DragDetectorPermissionPolicy.Nobody", "Everybody": "@roblox/enum/DragDetectorPermissionPolicy.Everybody", "Scriptable": "@roblox/enum/DragDetectorPermissionPolicy.Scriptable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorPermissionPolicy", "code_sample": "" }, "@roblox/enum/DragDetectorResponseStyle.Geometric": { "documentation": "For an Anchored object both inside the running experience and in Studio edit mode, the position/orientation of the object will be updated to exactly reflect the proposed motion. For an unanchored object, behavior is the same as for an anchored object; however, in a running experience, the object will be anchored at the start of the drag and restored to unanchored upon drag release.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle#Geometric", "code_sample": "" }, "@roblox/enum/DragDetectorResponseStyle.Physical": { "documentation": "An Anchored object will default to Geometric behavior as it is not affected by forces. An unanchored object will be moved by constraint forces that attempt to bring it to the desired position and/or orientation given by the proposed motion.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle#Physical", "code_sample": "" }, "@roblox/enum/DragDetectorResponseStyle.Custom": { "documentation": "The object will not move at all, but DragFrame will still be updated and you can respond to drag manipulation however you'd like.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle#Custom", "code_sample": "" }, "@roblox/global/Enum.DragDetectorResponseStyle": { "documentation": "Describes how the clicked object will be treated once the desired motion has been calculated.", "keys": { "Geometric": "@roblox/enum/DragDetectorResponseStyle.Geometric", "Physical": "@roblox/enum/DragDetectorResponseStyle.Physical", "Custom": "@roblox/enum/DragDetectorResponseStyle.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorResponseStyle", "code_sample": "" }, "@roblox/enum/UITheme.Light": { "documentation": "Deprecated: This option is deprecated.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UITheme#Light", "code_sample": "" }, "@roblox/enum/UITheme.Dark": { "documentation": "Deprecated: This option is deprecated.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UITheme#Dark", "code_sample": "" }, "@roblox/global/Enum.UITheme": { "documentation": "", "keys": { "Light": "@roblox/enum/UITheme.Light", "Dark": "@roblox/enum/UITheme.Dark" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UITheme", "code_sample": "" }, "@roblox/enum/Limb.Head": { "documentation": "If the limb is a part of the Humanoid's Head.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#Head", "code_sample": "" }, "@roblox/enum/Limb.Torso": { "documentation": "If the limb is a part of the Humanoid's Torso. This includes UpperTorso and LowerTorso for R15 rigs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#Torso", "code_sample": "" }, "@roblox/enum/Limb.LeftArm": { "documentation": "If the limb is a part of the Humanoid's Left Arm. This includes UpperLeftArm, LowerLeftArm, and LeftHand for R15 rigs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#LeftArm", "code_sample": "" }, "@roblox/enum/Limb.RightArm": { "documentation": "If the limb is a part of the Humanoid's Right Arm. This includes UpperRightArm, LowerRightArm and RightHand for R15 rigs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#RightArm", "code_sample": "" }, "@roblox/enum/Limb.LeftLeg": { "documentation": "If the limb is a part of the Humanoid's Left Leg. This includes UpperLeftLeg, LowerLeftLeg and LeftFoot for R15 rigs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#LeftLeg", "code_sample": "" }, "@roblox/enum/Limb.RightLeg": { "documentation": "If the limb is a part of the Humanoid's Right Leg. This includes UpperRightLeg, LowerRightLeg, and RightFoot for R15 rigs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#RightLeg", "code_sample": "" }, "@roblox/enum/Limb.Unknown": { "documentation": "If a part is not a limb (e.g. running the Humanoid:GetLimb() function and passing it an accessory which is a sibling of the Humanoid will return this value).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb#Unknown", "code_sample": "" }, "@roblox/global/Enum.Limb": { "documentation": "Describes which limb a particular Instance belongs to (assuming the Instance is part of a Humanoid).", "keys": { "Head": "@roblox/enum/Limb.Head", "Torso": "@roblox/enum/Limb.Torso", "LeftArm": "@roblox/enum/Limb.LeftArm", "RightArm": "@roblox/enum/Limb.RightArm", "LeftLeg": "@roblox/enum/Limb.LeftLeg", "RightLeg": "@roblox/enum/Limb.RightLeg", "Unknown": "@roblox/enum/Limb.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Limb", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#Success", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.PermissionDenied": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#PermissionDenied", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.Timeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#Timeout", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.UploadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#UploadFailed", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.NoUserInput": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#NoUserInput", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.InvalidHumanoidDescription": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#InvalidHumanoidDescription", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.UGCValidationFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#UGCValidationFailed", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.ModeratedName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#ModeratedName", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.MaxOutfits": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#MaxOutfits", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.PurchaseFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#PurchaseFailure", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.UnknownFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#UnknownFailure", "code_sample": "" }, "@roblox/enum/PromptCreateAvatarResult.TokenInvalid": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult#TokenInvalid", "code_sample": "" }, "@roblox/global/Enum.PromptCreateAvatarResult": { "documentation": "", "keys": { "Success": "@roblox/enum/PromptCreateAvatarResult.Success", "PermissionDenied": "@roblox/enum/PromptCreateAvatarResult.PermissionDenied", "Timeout": "@roblox/enum/PromptCreateAvatarResult.Timeout", "UploadFailed": "@roblox/enum/PromptCreateAvatarResult.UploadFailed", "NoUserInput": "@roblox/enum/PromptCreateAvatarResult.NoUserInput", "InvalidHumanoidDescription": "@roblox/enum/PromptCreateAvatarResult.InvalidHumanoidDescription", "UGCValidationFailed": "@roblox/enum/PromptCreateAvatarResult.UGCValidationFailed", "ModeratedName": "@roblox/enum/PromptCreateAvatarResult.ModeratedName", "MaxOutfits": "@roblox/enum/PromptCreateAvatarResult.MaxOutfits", "PurchaseFailure": "@roblox/enum/PromptCreateAvatarResult.PurchaseFailure", "UnknownFailure": "@roblox/enum/PromptCreateAvatarResult.UnknownFailure", "TokenInvalid": "@roblox/enum/PromptCreateAvatarResult.TokenInvalid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAvatarResult", "code_sample": "" }, "@roblox/enum/HttpCachePolicy.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCachePolicy#None", "code_sample": "" }, "@roblox/enum/HttpCachePolicy.Full": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCachePolicy#Full", "code_sample": "" }, "@roblox/enum/HttpCachePolicy.DataOnly": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCachePolicy#DataOnly", "code_sample": "" }, "@roblox/enum/HttpCachePolicy.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCachePolicy#Default", "code_sample": "" }, "@roblox/enum/HttpCachePolicy.InternalRedirectRefresh": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCachePolicy#InternalRedirectRefresh", "code_sample": "" }, "@roblox/global/Enum.HttpCachePolicy": { "documentation": "", "keys": { "None": "@roblox/enum/HttpCachePolicy.None", "Full": "@roblox/enum/HttpCachePolicy.Full", "DataOnly": "@roblox/enum/HttpCachePolicy.DataOnly", "Default": "@roblox/enum/HttpCachePolicy.Default", "InternalRedirectRefresh": "@roblox/enum/HttpCachePolicy.InternalRedirectRefresh" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCachePolicy", "code_sample": "" }, "@roblox/enum/HorizontalAlignment.Center": { "documentation": "Grid is aligned to the center of its parent along the X axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HorizontalAlignment#Center", "code_sample": "" }, "@roblox/enum/HorizontalAlignment.Left": { "documentation": "Grid is aligned to the left edge of its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HorizontalAlignment#Left", "code_sample": "" }, "@roblox/enum/HorizontalAlignment.Right": { "documentation": "Grid is aligned to the right edge of its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HorizontalAlignment#Right", "code_sample": "" }, "@roblox/global/Enum.HorizontalAlignment": { "documentation": "Used by UIGridStyleLayout.HorizontalAlignment to align the layout horizontally within its parent.", "keys": { "Center": "@roblox/enum/HorizontalAlignment.Center", "Left": "@roblox/enum/HorizontalAlignment.Left", "Right": "@roblox/enum/HorizontalAlignment.Right" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HorizontalAlignment", "code_sample": "" }, "@roblox/enum/ListenerLocation.Default": { "documentation": "Behavior depends on the value of VoiceChatService.EnableDefaultVoice and VoiceChatService.UseAudioApi. When using the default voice setup with the audio API, this behaves similarly to Camera.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Default", "code_sample": "" }, "@roblox/enum/ListenerLocation.None": { "documentation": "No AudioListener will be created by default, but they can be created separately by scripts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#None", "code_sample": "" }, "@roblox/enum/ListenerLocation.Character": { "documentation": "All of the following, resulting in the world being heard from the position of your character while matching the orientation of your camera. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Character", "code_sample": "" }, "@roblox/enum/ListenerLocation.Camera": { "documentation": "All of the following, resulting in the world being heard from the perspective (postition and orientation) of the camera. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerLocation#Camera", "code_sample": "" }, "@roblox/global/Enum.ListenerLocation": { "documentation": "Enum used with SoundService.DefaultListenerLocation to determine where an AudioListener is placed by default.", "keys": { "Default": "@roblox/enum/ListenerLocation.Default", "None": "@roblox/enum/ListenerLocation.None", "Character": "@roblox/enum/ListenerLocation.Character", "Camera": "@roblox/enum/ListenerLocation.Camera" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerLocation", "code_sample": "" }, "@roblox/enum/GroupMembershipStatus.None": { "documentation": "The player chose not to join, cancelled the prompt, or was not eligible to join the group.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GroupMembershipStatus#None", "code_sample": "" }, "@roblox/enum/GroupMembershipStatus.Joined": { "documentation": "The player successfully joined the group during the prompt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GroupMembershipStatus#Joined", "code_sample": "" }, "@roblox/enum/GroupMembershipStatus.JoinRequestPending": { "documentation": "The player submitted a request to join the group.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GroupMembershipStatus#JoinRequestPending", "code_sample": "" }, "@roblox/enum/GroupMembershipStatus.AlreadyMember": { "documentation": "The player was already a member of the group.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GroupMembershipStatus#AlreadyMember", "code_sample": "" }, "@roblox/global/Enum.GroupMembershipStatus": { "documentation": "Defines the possible outcomes of the GroupService:PromptJoinAsync() method.", "keys": { "None": "@roblox/enum/GroupMembershipStatus.None", "Joined": "@roblox/enum/GroupMembershipStatus.Joined", "JoinRequestPending": "@roblox/enum/GroupMembershipStatus.JoinRequestPending", "AlreadyMember": "@roblox/enum/GroupMembershipStatus.AlreadyMember" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GroupMembershipStatus", "code_sample": "" }, "@roblox/enum/AdUIEventType.AdLabelClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#AdLabelClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.VolumeButtonClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#VolumeButtonClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.FullscreenButtonClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#FullscreenButtonClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.PlayButtonClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayButtonClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.PauseButtonClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseButtonClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.CloseButtonClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#CloseButtonClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.WhyThisAdClicked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#WhyThisAdClicked", "code_sample": "" }, "@roblox/enum/AdUIEventType.PlayEventTriggered": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PlayEventTriggered", "code_sample": "" }, "@roblox/enum/AdUIEventType.PauseEventTriggered": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType#PauseEventTriggered", "code_sample": "" }, "@roblox/global/Enum.AdUIEventType": { "documentation": "", "keys": { "AdLabelClicked": "@roblox/enum/AdUIEventType.AdLabelClicked", "VolumeButtonClicked": "@roblox/enum/AdUIEventType.VolumeButtonClicked", "FullscreenButtonClicked": "@roblox/enum/AdUIEventType.FullscreenButtonClicked", "PlayButtonClicked": "@roblox/enum/AdUIEventType.PlayButtonClicked", "PauseButtonClicked": "@roblox/enum/AdUIEventType.PauseButtonClicked", "CloseButtonClicked": "@roblox/enum/AdUIEventType.CloseButtonClicked", "WhyThisAdClicked": "@roblox/enum/AdUIEventType.WhyThisAdClicked", "PlayEventTriggered": "@roblox/enum/AdUIEventType.PlayEventTriggered", "PauseEventTriggered": "@roblox/enum/AdUIEventType.PauseEventTriggered" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIEventType", "code_sample": "" }, "@roblox/enum/StartCorner.TopLeft": { "documentation": "Grid starts in top left corner.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StartCorner#TopLeft", "code_sample": "" }, "@roblox/enum/StartCorner.TopRight": { "documentation": "Grid starts in top right corner.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StartCorner#TopRight", "code_sample": "" }, "@roblox/enum/StartCorner.BottomLeft": { "documentation": "Grid starts in bottom left corner.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StartCorner#BottomLeft", "code_sample": "" }, "@roblox/enum/StartCorner.BottomRight": { "documentation": "Grid starts in bottom right corner.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StartCorner#BottomRight", "code_sample": "" }, "@roblox/global/Enum.StartCorner": { "documentation": "Used by UIGridLayout.StartCorner to decide where the first element is placed.", "keys": { "TopLeft": "@roblox/enum/StartCorner.TopLeft", "TopRight": "@roblox/enum/StartCorner.TopRight", "BottomLeft": "@roblox/enum/StartCorner.BottomLeft", "BottomRight": "@roblox/enum/StartCorner.BottomRight" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StartCorner", "code_sample": "" }, "@roblox/enum/MarkupKind.PlainText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarkupKind#PlainText", "code_sample": "" }, "@roblox/enum/MarkupKind.Markdown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarkupKind#Markdown", "code_sample": "" }, "@roblox/global/Enum.MarkupKind": { "documentation": "", "keys": { "PlainText": "@roblox/enum/MarkupKind.PlainText", "Markdown": "@roblox/enum/MarkupKind.Markdown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarkupKind", "code_sample": "" }, "@roblox/enum/CameraMode.Classic": { "documentation": "Third person camera which can be zoomed into first person.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraMode#Classic", "code_sample": "" }, "@roblox/enum/CameraMode.LockFirstPerson": { "documentation": "Exclusively first person camera.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraMode#LockFirstPerson", "code_sample": "" }, "@roblox/global/Enum.CameraMode": { "documentation": "Used to set Player.CameraMode to determine when first person and third person cameras should be used.", "keys": { "Classic": "@roblox/enum/CameraMode.Classic", "LockFirstPerson": "@roblox/enum/CameraMode.LockFirstPerson" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraMode", "code_sample": "" }, "@roblox/enum/CompletionTriggerKind.Invoked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind#Invoked", "code_sample": "" }, "@roblox/enum/CompletionTriggerKind.TriggerCharacter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind#TriggerCharacter", "code_sample": "" }, "@roblox/enum/CompletionTriggerKind.TriggerForIncompleteCompletions": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind#TriggerForIncompleteCompletions", "code_sample": "" }, "@roblox/global/Enum.CompletionTriggerKind": { "documentation": "", "keys": { "Invoked": "@roblox/enum/CompletionTriggerKind.Invoked", "TriggerCharacter": "@roblox/enum/CompletionTriggerKind.TriggerCharacter", "TriggerForIncompleteCompletions": "@roblox/enum/CompletionTriggerKind.TriggerForIncompleteCompletions" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionTriggerKind", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#None", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.Pending": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#Pending", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.Initialized": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#Initialized", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.ErrorInvalidUser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#ErrorInvalidUser", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.ErrorConnection": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#ErrorConnection", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.ErrorJsonParse": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#ErrorJsonParse", "code_sample": "" }, "@roblox/enum/IXPLoadingStatus.ErrorTimedOut": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus#ErrorTimedOut", "code_sample": "" }, "@roblox/global/Enum.IXPLoadingStatus": { "documentation": "", "keys": { "None": "@roblox/enum/IXPLoadingStatus.None", "Pending": "@roblox/enum/IXPLoadingStatus.Pending", "Initialized": "@roblox/enum/IXPLoadingStatus.Initialized", "ErrorInvalidUser": "@roblox/enum/IXPLoadingStatus.ErrorInvalidUser", "ErrorConnection": "@roblox/enum/IXPLoadingStatus.ErrorConnection", "ErrorJsonParse": "@roblox/enum/IXPLoadingStatus.ErrorJsonParse", "ErrorTimedOut": "@roblox/enum/IXPLoadingStatus.ErrorTimedOut" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IXPLoadingStatus", "code_sample": "" }, "@roblox/enum/TableMajorAxis.RowMajor": { "documentation": "The direct siblings are considered rows.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TableMajorAxis#RowMajor", "code_sample": "" }, "@roblox/enum/TableMajorAxis.ColumnMajor": { "documentation": "The direct siblings are considered columns.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TableMajorAxis#ColumnMajor", "code_sample": "" }, "@roblox/global/Enum.TableMajorAxis": { "documentation": "Used by UITableLayout.MajorAxis to decide whether direct siblings are rows or columns.", "keys": { "RowMajor": "@roblox/enum/TableMajorAxis.RowMajor", "ColumnMajor": "@roblox/enum/TableMajorAxis.ColumnMajor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TableMajorAxis", "code_sample": "" }, "@roblox/enum/VideoDeviceCaptureQuality.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoDeviceCaptureQuality#Default", "code_sample": "" }, "@roblox/enum/VideoDeviceCaptureQuality.Low": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoDeviceCaptureQuality#Low", "code_sample": "" }, "@roblox/enum/VideoDeviceCaptureQuality.Medium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoDeviceCaptureQuality#Medium", "code_sample": "" }, "@roblox/enum/VideoDeviceCaptureQuality.High": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoDeviceCaptureQuality#High", "code_sample": "" }, "@roblox/global/Enum.VideoDeviceCaptureQuality": { "documentation": "", "keys": { "Default": "@roblox/enum/VideoDeviceCaptureQuality.Default", "Low": "@roblox/enum/VideoDeviceCaptureQuality.Low", "Medium": "@roblox/enum/VideoDeviceCaptureQuality.Medium", "High": "@roblox/enum/VideoDeviceCaptureQuality.High" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoDeviceCaptureQuality", "code_sample": "" }, "@roblox/enum/StudioDataModelType.Edit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioDataModelType#Edit", "code_sample": "" }, "@roblox/enum/StudioDataModelType.PlayClient": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioDataModelType#PlayClient", "code_sample": "" }, "@roblox/enum/StudioDataModelType.PlayServer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioDataModelType#PlayServer", "code_sample": "" }, "@roblox/enum/StudioDataModelType.Standalone": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioDataModelType#Standalone", "code_sample": "" }, "@roblox/enum/StudioDataModelType.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioDataModelType#None", "code_sample": "" }, "@roblox/global/Enum.StudioDataModelType": { "documentation": "", "keys": { "Edit": "@roblox/enum/StudioDataModelType.Edit", "PlayClient": "@roblox/enum/StudioDataModelType.PlayClient", "PlayServer": "@roblox/enum/StudioDataModelType.PlayServer", "Standalone": "@roblox/enum/StudioDataModelType.Standalone", "None": "@roblox/enum/StudioDataModelType.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioDataModelType", "code_sample": "" }, "@roblox/enum/FieldOfViewMode.Vertical": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode#Vertical", "code_sample": "" }, "@roblox/enum/FieldOfViewMode.Diagonal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode#Diagonal", "code_sample": "" }, "@roblox/enum/FieldOfViewMode.MaxAxis": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode#MaxAxis", "code_sample": "" }, "@roblox/global/Enum.FieldOfViewMode": { "documentation": "", "keys": { "Vertical": "@roblox/enum/FieldOfViewMode.Vertical", "Diagonal": "@roblox/enum/FieldOfViewMode.Diagonal", "MaxAxis": "@roblox/enum/FieldOfViewMode.MaxAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode", "code_sample": "" }, "@roblox/enum/NetworkStatus.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkStatus#Unknown", "code_sample": "" }, "@roblox/enum/NetworkStatus.Connected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkStatus#Connected", "code_sample": "" }, "@roblox/enum/NetworkStatus.Disconnected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkStatus#Disconnected", "code_sample": "" }, "@roblox/global/Enum.NetworkStatus": { "documentation": "", "keys": { "Unknown": "@roblox/enum/NetworkStatus.Unknown", "Connected": "@roblox/enum/NetworkStatus.Connected", "Disconnected": "@roblox/enum/NetworkStatus.Disconnected" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkStatus", "code_sample": "" }, "@roblox/enum/ProductLocationRestriction.AvatarShop": { "documentation": "Item is purchasable only in the Marketplace.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductLocationRestriction#AvatarShop", "code_sample": "" }, "@roblox/enum/ProductLocationRestriction.AllowedGames": { "documentation": "Item is purchasable in the Marketplace and experiences owned by the item creator.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductLocationRestriction#AllowedGames", "code_sample": "" }, "@roblox/enum/ProductLocationRestriction.AllGames": { "documentation": "(Default) Item is purchasable in the Marketplace and all experiences.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductLocationRestriction#AllGames", "code_sample": "" }, "@roblox/global/Enum.ProductLocationRestriction": { "documentation": "", "keys": { "AvatarShop": "@roblox/enum/ProductLocationRestriction.AvatarShop", "AllowedGames": "@roblox/enum/ProductLocationRestriction.AllowedGames", "AllGames": "@roblox/enum/ProductLocationRestriction.AllGames" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductLocationRestriction", "code_sample": "" }, "@roblox/enum/StreamingIntegrityMode.Default": { "documentation": "Default behavior (currently equivalent to Disabled).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingIntegrityMode#Default", "code_sample": "" }, "@roblox/enum/StreamingIntegrityMode.Disabled": { "documentation": "Simulation of the replication focus is never paused, regardless of the amount of content streamed in on the client.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingIntegrityMode#Disabled", "code_sample": "" }, "@roblox/enum/StreamingIntegrityMode.MinimumRadiusPause": { "documentation": "All client-side simulation is paused when content is not streamed in up to the minimum radius.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingIntegrityMode#MinimumRadiusPause", "code_sample": "" }, "@roblox/enum/StreamingIntegrityMode.PauseOutsideLoadedArea": { "documentation": "Simulation of the replication focus is paused when any part of its bounding box is not in a streamed-in area.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingIntegrityMode#PauseOutsideLoadedArea", "code_sample": "" }, "@roblox/global/Enum.StreamingIntegrityMode": { "documentation": "Determines how a user's client should handle not having enough content streamed in.", "keys": { "Default": "@roblox/enum/StreamingIntegrityMode.Default", "Disabled": "@roblox/enum/StreamingIntegrityMode.Disabled", "MinimumRadiusPause": "@roblox/enum/StreamingIntegrityMode.MinimumRadiusPause", "PauseOutsideLoadedArea": "@roblox/enum/StreamingIntegrityMode.PauseOutsideLoadedArea" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamingIntegrityMode", "code_sample": "" }, "@roblox/enum/SalesTypeFilter.All": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SalesTypeFilter#All", "code_sample": "" }, "@roblox/enum/SalesTypeFilter.Collectibles": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SalesTypeFilter#Collectibles", "code_sample": "" }, "@roblox/enum/SalesTypeFilter.Premium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SalesTypeFilter#Premium", "code_sample": "" }, "@roblox/global/Enum.SalesTypeFilter": { "documentation": "", "keys": { "All": "@roblox/enum/SalesTypeFilter.All", "Collectibles": "@roblox/enum/SalesTypeFilter.Collectibles", "Premium": "@roblox/enum/SalesTypeFilter.Premium" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SalesTypeFilter", "code_sample": "" }, "@roblox/enum/TeamCreateErrorState.PlaceSizeTooLarge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeamCreateErrorState#PlaceSizeTooLarge", "code_sample": "" }, "@roblox/enum/TeamCreateErrorState.PlaceSizeApproachingLimit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeamCreateErrorState#PlaceSizeApproachingLimit", "code_sample": "" }, "@roblox/enum/TeamCreateErrorState.NoError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeamCreateErrorState#NoError", "code_sample": "" }, "@roblox/global/Enum.TeamCreateErrorState": { "documentation": "", "keys": { "PlaceSizeTooLarge": "@roblox/enum/TeamCreateErrorState.PlaceSizeTooLarge", "PlaceSizeApproachingLimit": "@roblox/enum/TeamCreateErrorState.PlaceSizeApproachingLimit", "NoError": "@roblox/enum/TeamCreateErrorState.NoError" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeamCreateErrorState", "code_sample": "" }, "@roblox/enum/DebuggerPauseReason.Unknown": { "documentation": "Pausing for a reason not covered by other values.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Unknown", "code_sample": "" }, "@roblox/enum/DebuggerPauseReason.Requested": { "documentation": "Pause was requested by user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Requested", "code_sample": "" }, "@roblox/enum/DebuggerPauseReason.Breakpoint": { "documentation": "Pausing on a user breakpoint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Breakpoint", "code_sample": "" }, "@roblox/enum/DebuggerPauseReason.Exception": { "documentation": "Pausing on error hit in the code.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Exception", "code_sample": "" }, "@roblox/enum/DebuggerPauseReason.SingleStep": { "documentation": "Pausing on an internal breakpoint set by debugger command: e.g. step over, step into, step out of.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#SingleStep", "code_sample": "" }, "@roblox/enum/DebuggerPauseReason.Entrypoint": { "documentation": "Pausing at the entry on the script.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason#Entrypoint", "code_sample": "" }, "@roblox/global/Enum.DebuggerPauseReason": { "documentation": "Reason that the DataModel was paused.", "keys": { "Unknown": "@roblox/enum/DebuggerPauseReason.Unknown", "Requested": "@roblox/enum/DebuggerPauseReason.Requested", "Breakpoint": "@roblox/enum/DebuggerPauseReason.Breakpoint", "Exception": "@roblox/enum/DebuggerPauseReason.Exception", "SingleStep": "@roblox/enum/DebuggerPauseReason.SingleStep", "Entrypoint": "@roblox/enum/DebuggerPauseReason.Entrypoint" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerPauseReason", "code_sample": "" }, "@roblox/enum/TrackerType.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerType#None", "code_sample": "" }, "@roblox/enum/TrackerType.Face": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerType#Face", "code_sample": "" }, "@roblox/enum/TrackerType.UpperBody": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerType#UpperBody", "code_sample": "" }, "@roblox/global/Enum.TrackerType": { "documentation": "", "keys": { "None": "@roblox/enum/TrackerType.None", "Face": "@roblox/enum/TrackerType.Face", "UpperBody": "@roblox/enum/TrackerType.UpperBody" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerType", "code_sample": "" }, "@roblox/enum/VRLaserPointerMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRLaserPointerMode#Disabled", "code_sample": "" }, "@roblox/enum/VRLaserPointerMode.Pointer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRLaserPointerMode#Pointer", "code_sample": "" }, "@roblox/enum/VRLaserPointerMode.DualPointer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRLaserPointerMode#DualPointer", "code_sample": "" }, "@roblox/global/Enum.VRLaserPointerMode": { "documentation": "", "keys": { "Disabled": "@roblox/enum/VRLaserPointerMode.Disabled", "Pointer": "@roblox/enum/VRLaserPointerMode.Pointer", "DualPointer": "@roblox/enum/VRLaserPointerMode.DualPointer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRLaserPointerMode", "code_sample": "" }, "@roblox/enum/AnimationPriority.Idle": { "documentation": "(6) - Recommended priority for character idle animations.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Idle", "code_sample": "" }, "@roblox/enum/AnimationPriority.Movement": { "documentation": "(5) - Recommended priority for walk, run, swim, climb, and other locomotion animations.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Movement", "code_sample": "" }, "@roblox/enum/AnimationPriority.Action": { "documentation": "(4) - Recommended priority for character actions that must override idle and locomotion animations.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action", "code_sample": "" }, "@roblox/enum/AnimationPriority.Action2": { "documentation": "(3) - Action2 will override Action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action2", "code_sample": "" }, "@roblox/enum/AnimationPriority.Action3": { "documentation": "(2) - Action3 will override Action2.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action3", "code_sample": "" }, "@roblox/enum/AnimationPriority.Action4": { "documentation": "(1) - Action4 is the highest priority available, overriding all other priority values.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Action4", "code_sample": "" }, "@roblox/enum/AnimationPriority.Core": { "documentation": "(7) - Lowest priority, intended for use by Roblox default animations and catalog animation bundles.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority#Core", "code_sample": "" }, "@roblox/global/Enum.AnimationPriority": { "documentation": "The AnimationPriority Enum determines how concurrently-playing AnimationTracks contribute to the final animation.", "keys": { "Idle": "@roblox/enum/AnimationPriority.Idle", "Movement": "@roblox/enum/AnimationPriority.Movement", "Action": "@roblox/enum/AnimationPriority.Action", "Action2": "@roblox/enum/AnimationPriority.Action2", "Action3": "@roblox/enum/AnimationPriority.Action3", "Action4": "@roblox/enum/AnimationPriority.Action4", "Core": "@roblox/enum/AnimationPriority.Core" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationPriority", "code_sample": "" }, "@roblox/enum/R15CollisionType.OuterBox": { "documentation": "Dynamically sized collision boxes based on mesh sizes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/R15CollisionType#OuterBox", "code_sample": "" }, "@roblox/enum/R15CollisionType.InnerBox": { "documentation": "Fixed size collision boxes, similar to the classic avatar collision.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/R15CollisionType#InnerBox", "code_sample": "" }, "@roblox/global/Enum.R15CollisionType": { "documentation": "Collision behavior type for a R15 character.", "keys": { "OuterBox": "@roblox/enum/R15CollisionType.OuterBox", "InnerBox": "@roblox/enum/R15CollisionType.InnerBox" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/R15CollisionType", "code_sample": "" }, "@roblox/enum/QualityLevel.Automatic": { "documentation": "The quality level of graphics is determined automatically depending on the client's setting for either game performance or graphic quality.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Automatic", "code_sample": "" }, "@roblox/enum/QualityLevel.Level01": { "documentation": "Graphic quality level 1 - the lowest quality level.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level01", "code_sample": "" }, "@roblox/enum/QualityLevel.Level02": { "documentation": "Graphic quality level 2.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level02", "code_sample": "" }, "@roblox/enum/QualityLevel.Level03": { "documentation": "Graphic quality level 3.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level03", "code_sample": "" }, "@roblox/enum/QualityLevel.Level04": { "documentation": "Graphic quality level 4.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level04", "code_sample": "" }, "@roblox/enum/QualityLevel.Level05": { "documentation": "Graphic quality level 5.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level05", "code_sample": "" }, "@roblox/enum/QualityLevel.Level06": { "documentation": "Graphic quality level 6.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level06", "code_sample": "" }, "@roblox/enum/QualityLevel.Level07": { "documentation": "Graphic quality level 7.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level07", "code_sample": "" }, "@roblox/enum/QualityLevel.Level08": { "documentation": "Graphic quality level 8.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level08", "code_sample": "" }, "@roblox/enum/QualityLevel.Level09": { "documentation": "Graphic quality level 9.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level09", "code_sample": "" }, "@roblox/enum/QualityLevel.Level10": { "documentation": "Graphic quality level 10.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level10", "code_sample": "" }, "@roblox/enum/QualityLevel.Level11": { "documentation": "Graphic quality level 11.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level11", "code_sample": "" }, "@roblox/enum/QualityLevel.Level12": { "documentation": "Graphic quality level 12.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level12", "code_sample": "" }, "@roblox/enum/QualityLevel.Level13": { "documentation": "Graphic quality level 13.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level13", "code_sample": "" }, "@roblox/enum/QualityLevel.Level14": { "documentation": "Graphic quality level 14.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level14", "code_sample": "" }, "@roblox/enum/QualityLevel.Level15": { "documentation": "Graphic quality level 15.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level15", "code_sample": "" }, "@roblox/enum/QualityLevel.Level16": { "documentation": "Graphic quality level 16.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level16", "code_sample": "" }, "@roblox/enum/QualityLevel.Level17": { "documentation": "Graphic quality level 17.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level17", "code_sample": "" }, "@roblox/enum/QualityLevel.Level18": { "documentation": "Graphic quality level 18.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level18", "code_sample": "" }, "@roblox/enum/QualityLevel.Level19": { "documentation": "Graphic quality level 19.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level19", "code_sample": "" }, "@roblox/enum/QualityLevel.Level20": { "documentation": "Graphic quality level 20.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level20", "code_sample": "" }, "@roblox/enum/QualityLevel.Level21": { "documentation": "Graphic quality level 21, the highest quality level.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel#Level21", "code_sample": "" }, "@roblox/global/Enum.QualityLevel": { "documentation": "Controls the rendering quality of the game.", "keys": { "Automatic": "@roblox/enum/QualityLevel.Automatic", "Level01": "@roblox/enum/QualityLevel.Level01", "Level02": "@roblox/enum/QualityLevel.Level02", "Level03": "@roblox/enum/QualityLevel.Level03", "Level04": "@roblox/enum/QualityLevel.Level04", "Level05": "@roblox/enum/QualityLevel.Level05", "Level06": "@roblox/enum/QualityLevel.Level06", "Level07": "@roblox/enum/QualityLevel.Level07", "Level08": "@roblox/enum/QualityLevel.Level08", "Level09": "@roblox/enum/QualityLevel.Level09", "Level10": "@roblox/enum/QualityLevel.Level10", "Level11": "@roblox/enum/QualityLevel.Level11", "Level12": "@roblox/enum/QualityLevel.Level12", "Level13": "@roblox/enum/QualityLevel.Level13", "Level14": "@roblox/enum/QualityLevel.Level14", "Level15": "@roblox/enum/QualityLevel.Level15", "Level16": "@roblox/enum/QualityLevel.Level16", "Level17": "@roblox/enum/QualityLevel.Level17", "Level18": "@roblox/enum/QualityLevel.Level18", "Level19": "@roblox/enum/QualityLevel.Level19", "Level20": "@roblox/enum/QualityLevel.Level20", "Level21": "@roblox/enum/QualityLevel.Level21" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/QualityLevel", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.ClientRequest": { "documentation": "Client requested connection termination.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ClientRequest", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.Timeout": { "documentation": "Connection timed out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#Timeout", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.InvalidHost": { "documentation": "Invalid host:port combination.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#InvalidHost", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.Disconnected": { "documentation": "Connection was lost.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#Disconnected", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.ServerShutdown": { "documentation": "Server terminated the connection because it shut down.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ServerShutdown", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.ServerProtocolMismatch": { "documentation": "Server has wrong version of protocol.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ServerProtocolMismatch", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.ConfigurationFailed": { "documentation": "Got a failure response when trying to configure the server.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#ConfigurationFailed", "code_sample": "" }, "@roblox/enum/DebuggerEndReason.RpcError": { "documentation": "An error occurred in the RPC layer.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason#RpcError", "code_sample": "" }, "@roblox/global/Enum.DebuggerEndReason": { "documentation": "Reason for the end of the debugger session.", "keys": { "ClientRequest": "@roblox/enum/DebuggerEndReason.ClientRequest", "Timeout": "@roblox/enum/DebuggerEndReason.Timeout", "InvalidHost": "@roblox/enum/DebuggerEndReason.InvalidHost", "Disconnected": "@roblox/enum/DebuggerEndReason.Disconnected", "ServerShutdown": "@roblox/enum/DebuggerEndReason.ServerShutdown", "ServerProtocolMismatch": "@roblox/enum/DebuggerEndReason.ServerProtocolMismatch", "ConfigurationFailed": "@roblox/enum/DebuggerEndReason.ConfigurationFailed", "RpcError": "@roblox/enum/DebuggerEndReason.RpcError" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerEndReason", "code_sample": "" }, "@roblox/enum/VRSafetyBubbleMode.NoOne": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSafetyBubbleMode#NoOne", "code_sample": "" }, "@roblox/enum/VRSafetyBubbleMode.OnlyFriends": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSafetyBubbleMode#OnlyFriends", "code_sample": "" }, "@roblox/enum/VRSafetyBubbleMode.Anyone": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSafetyBubbleMode#Anyone", "code_sample": "" }, "@roblox/global/Enum.VRSafetyBubbleMode": { "documentation": "", "keys": { "NoOne": "@roblox/enum/VRSafetyBubbleMode.NoOne", "OnlyFriends": "@roblox/enum/VRSafetyBubbleMode.OnlyFriends", "Anyone": "@roblox/enum/VRSafetyBubbleMode.Anyone" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSafetyBubbleMode", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Auto": { "documentation": "Let task scheduler make a decision internally.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Auto", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Threads1": { "documentation": "Utilize 1 worker thread, ignore the physical CPU core count.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Threads1", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Threads2": { "documentation": "Utilize 2 worker threads, ignore the physical CPU core count.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Threads2", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Threads3": { "documentation": "Utilize 3 worker threads, ignore the physical CPU core count.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Threads3", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Threads4": { "documentation": "Utilize 4 worker threads, ignore the physical CPU core count.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Threads4", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Threads8": { "documentation": "Utilize 8 worker threads, ignore the physical CPU core count.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Threads8", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.Threads16": { "documentation": "Utilize 16 worker threads, ignore the physical CPU core count.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#Threads16", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.PerCore1": { "documentation": "Utilize 1 worker thread per available physical CPU core.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#PerCore1", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.PerCore2": { "documentation": "Utilize 2 worker threads per available physical CPU core.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#PerCore2", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.PerCore3": { "documentation": "Utilize 3 worker threads per available physical CPU core.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#PerCore3", "code_sample": "" }, "@roblox/enum/ThreadPoolConfig.PerCore4": { "documentation": "Utilize 4 worker threads per available physical CPU core.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig#PerCore4", "code_sample": "" }, "@roblox/global/Enum.ThreadPoolConfig": { "documentation": "Thread pooling scheme for the task scheduler.", "keys": { "Auto": "@roblox/enum/ThreadPoolConfig.Auto", "Threads1": "@roblox/enum/ThreadPoolConfig.Threads1", "Threads2": "@roblox/enum/ThreadPoolConfig.Threads2", "Threads3": "@roblox/enum/ThreadPoolConfig.Threads3", "Threads4": "@roblox/enum/ThreadPoolConfig.Threads4", "Threads8": "@roblox/enum/ThreadPoolConfig.Threads8", "Threads16": "@roblox/enum/ThreadPoolConfig.Threads16", "PerCore1": "@roblox/enum/ThreadPoolConfig.PerCore1", "PerCore2": "@roblox/enum/ThreadPoolConfig.PerCore2", "PerCore3": "@roblox/enum/ThreadPoolConfig.PerCore3", "PerCore4": "@roblox/enum/ThreadPoolConfig.PerCore4" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThreadPoolConfig", "code_sample": "" }, "@roblox/enum/ContextActionPriority.Low": { "documentation": "Low priority.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority#Low", "code_sample": "" }, "@roblox/enum/ContextActionPriority.Medium": { "documentation": "Medium priority.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority#Medium", "code_sample": "" }, "@roblox/enum/ContextActionPriority.High": { "documentation": "High priority.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority#High", "code_sample": "" }, "@roblox/global/Enum.ContextActionPriority": { "documentation": "Describes the priority of a context action.", "keys": { "Low": "@roblox/enum/ContextActionPriority.Low", "Medium": "@roblox/enum/ContextActionPriority.Medium", "High": "@roblox/enum/ContextActionPriority.High" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionPriority", "code_sample": "" }, "@roblox/enum/VolumetricAudio.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VolumetricAudio#Disabled", "code_sample": "" }, "@roblox/enum/VolumetricAudio.Automatic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VolumetricAudio#Automatic", "code_sample": "" }, "@roblox/enum/VolumetricAudio.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VolumetricAudio#Enabled", "code_sample": "" }, "@roblox/global/Enum.VolumetricAudio": { "documentation": "", "keys": { "Disabled": "@roblox/enum/VolumetricAudio.Disabled", "Automatic": "@roblox/enum/VolumetricAudio.Automatic", "Enabled": "@roblox/enum/VolumetricAudio.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VolumetricAudio", "code_sample": "" }, "@roblox/enum/HumanoidCollisionType.OuterBox": { "documentation": "Dynamically sized collision boxes based on mesh sizes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidCollisionType#OuterBox", "code_sample": "" }, "@roblox/enum/HumanoidCollisionType.InnerBox": { "documentation": "Fixed size collision boxes, similar to the classic avatar collision.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidCollisionType#InnerBox", "code_sample": "" }, "@roblox/global/Enum.HumanoidCollisionType": { "documentation": "The collision Humanoid uses.", "keys": { "OuterBox": "@roblox/enum/HumanoidCollisionType.OuterBox", "InnerBox": "@roblox/enum/HumanoidCollisionType.InnerBox" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidCollisionType", "code_sample": "" }, "@roblox/enum/PropertyStatus.Ok": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PropertyStatus#Ok", "code_sample": "" }, "@roblox/enum/PropertyStatus.Warning": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PropertyStatus#Warning", "code_sample": "" }, "@roblox/enum/PropertyStatus.Error": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PropertyStatus#Error", "code_sample": "" }, "@roblox/global/Enum.PropertyStatus": { "documentation": "", "keys": { "Ok": "@roblox/enum/PropertyStatus.Ok", "Warning": "@roblox/enum/PropertyStatus.Warning", "Error": "@roblox/enum/PropertyStatus.Error" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PropertyStatus", "code_sample": "" }, "@roblox/enum/TextureQueryType.NonHumanoid": { "documentation": "Texture memory for objects other than Humanoid.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureQueryType#NonHumanoid", "code_sample": "" }, "@roblox/enum/TextureQueryType.NonHumanoidOrphaned": { "documentation": "Unreferenced texture memory for objects other than Humanoid.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureQueryType#NonHumanoidOrphaned", "code_sample": "" }, "@roblox/enum/TextureQueryType.Humanoid": { "documentation": "Texture memory for Humanoid.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureQueryType#Humanoid", "code_sample": "" }, "@roblox/enum/TextureQueryType.HumanoidOrphaned": { "documentation": "Unreferenced texture memory for Humanoid.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureQueryType#HumanoidOrphaned", "code_sample": "" }, "@roblox/global/Enum.TextureQueryType": { "documentation": "Used to get memory information about textures.", "keys": { "NonHumanoid": "@roblox/enum/TextureQueryType.NonHumanoid", "NonHumanoidOrphaned": "@roblox/enum/TextureQueryType.NonHumanoidOrphaned", "Humanoid": "@roblox/enum/TextureQueryType.Humanoid", "HumanoidOrphaned": "@roblox/enum/TextureQueryType.HumanoidOrphaned" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureQueryType", "code_sample": "" }, "@roblox/enum/ConfigSnapshotErrorState.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConfigSnapshotErrorState#None", "code_sample": "" }, "@roblox/enum/ConfigSnapshotErrorState.LoadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConfigSnapshotErrorState#LoadFailed", "code_sample": "" }, "@roblox/global/Enum.ConfigSnapshotErrorState": { "documentation": "", "keys": { "None": "@roblox/enum/ConfigSnapshotErrorState.None", "LoadFailed": "@roblox/enum/ConfigSnapshotErrorState.LoadFailed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConfigSnapshotErrorState", "code_sample": "" }, "@roblox/enum/LoadCharacterLayeredClothing.Default": { "documentation": "The behavior of the default setting is not constant. It can mean Disabled or Enabled depending on what the global back-end flag settings are currently.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadCharacterLayeredClothing#Default", "code_sample": "" }, "@roblox/enum/LoadCharacterLayeredClothing.Disabled": { "documentation": "This means layered clothing will not be equipped on characters in the experience.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadCharacterLayeredClothing#Disabled", "code_sample": "" }, "@roblox/enum/LoadCharacterLayeredClothing.Enabled": { "documentation": "This means layered clothing will be equipped on characters in the experience (Although MeshPartHeadsAndAccessories also need to be enabled for the experience).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadCharacterLayeredClothing#Enabled", "code_sample": "" }, "@roblox/global/Enum.LoadCharacterLayeredClothing": { "documentation": "Indicates whether characters spawning into an experience will have layered clothing accessories equipped on them.", "keys": { "Default": "@roblox/enum/LoadCharacterLayeredClothing.Default", "Disabled": "@roblox/enum/LoadCharacterLayeredClothing.Disabled", "Enabled": "@roblox/enum/LoadCharacterLayeredClothing.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadCharacterLayeredClothing", "code_sample": "" }, "@roblox/enum/ZIndexBehavior.Global": { "documentation": "The ZIndex property overrides the default value computed from the depth in the hierarchy.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ZIndexBehavior#Global", "code_sample": "" }, "@roblox/enum/ZIndexBehavior.Sibling": { "documentation": "The ZIndex property controls the order in which the GuiObject renders relative to its siblings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ZIndexBehavior#Sibling", "code_sample": "" }, "@roblox/global/Enum.ZIndexBehavior": { "documentation": "Used by LayerCollector.ZIndexBehavior to control how the GuiObject.ZIndex property behaves for descendants.", "keys": { "Global": "@roblox/enum/ZIndexBehavior.Global", "Sibling": "@roblox/enum/ZIndexBehavior.Sibling" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ZIndexBehavior", "code_sample": "" }, "@roblox/enum/FramerateManagerMode.Automatic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode#Automatic", "code_sample": "" }, "@roblox/enum/FramerateManagerMode.On": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode#On", "code_sample": "" }, "@roblox/enum/FramerateManagerMode.Off": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode#Off", "code_sample": "" }, "@roblox/global/Enum.FramerateManagerMode": { "documentation": "", "keys": { "Automatic": "@roblox/enum/FramerateManagerMode.Automatic", "On": "@roblox/enum/FramerateManagerMode.On", "Off": "@roblox/enum/FramerateManagerMode.Off" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FramerateManagerMode", "code_sample": "" }, "@roblox/enum/ActuatorType.None": { "documentation": "The motor and servo components are both disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorType#None", "code_sample": "" }, "@roblox/enum/ActuatorType.Motor": { "documentation": "The motor component is enabled. Motor properties are active and the actuator will apply continuous force.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorType#Motor", "code_sample": "" }, "@roblox/enum/ActuatorType.Servo": { "documentation": "The servo component is enabled. Servo properties are active and the actuator will apply force to approach the servo's target.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorType#Servo", "code_sample": "" }, "@roblox/global/Enum.ActuatorType": { "documentation": "The active physics component of the constraint.", "keys": { "None": "@roblox/enum/ActuatorType.None", "Motor": "@roblox/enum/ActuatorType.Motor", "Servo": "@roblox/enum/ActuatorType.Servo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorType", "code_sample": "" }, "@roblox/enum/AvatarSettingsHitAndTouchDetectionMode.UseParts": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode#UseParts", "code_sample": "" }, "@roblox/enum/AvatarSettingsHitAndTouchDetectionMode.UseCollider": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode#UseCollider", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsHitAndTouchDetectionMode": { "documentation": "", "keys": { "UseParts": "@roblox/enum/AvatarSettingsHitAndTouchDetectionMode.UseParts", "UseCollider": "@roblox/enum/AvatarSettingsHitAndTouchDetectionMode.UseCollider" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode", "code_sample": "" }, "@roblox/enum/UIFlexMode.None": { "documentation": "The parent GuiObject is unaffected and neither shrinks nor grows.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexMode#None", "code_sample": "" }, "@roblox/enum/UIFlexMode.Grow": { "documentation": "Sets an effective 1:0 grow‑shrink ratio on the parent GuiObject. Objects set to Grow never shrink below their basis size, so overflow may occur if the container becomes smaller than the flex line's combined basis size.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexMode#Grow", "code_sample": "" }, "@roblox/enum/UIFlexMode.Shrink": { "documentation": "Sets an effective 0:1 grow‑shrink ratio on the parent GuiObject. Objects set to Shrink never grow above their basis size, so underflow may occur if the container becomes larger than the flex line's combined basis size.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexMode#Shrink", "code_sample": "" }, "@roblox/enum/UIFlexMode.Fill": { "documentation": "Sets an effective 1:1 grow‑shrink ratio on the parent GuiObject. This setting ensures the flex line always fills the container, even if the container size changes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexMode#Fill", "code_sample": "" }, "@roblox/enum/UIFlexMode.Custom": { "documentation": "Enables the GrowRatio and ShrinkRatio properties for the UIFlexItem, allowing for relative growth or shrinking of the parent GuiObject in a ratio compared to other flex objects also under control of a UIFlexItem.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexMode#Custom", "code_sample": "" }, "@roblox/global/Enum.UIFlexMode": { "documentation": "Used with UIFlexItem.FlexMode to define how the parent GuiObject grows or shrinks.", "keys": { "None": "@roblox/enum/UIFlexMode.None", "Grow": "@roblox/enum/UIFlexMode.Grow", "Shrink": "@roblox/enum/UIFlexMode.Shrink", "Fill": "@roblox/enum/UIFlexMode.Fill", "Custom": "@roblox/enum/UIFlexMode.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexMode", "code_sample": "" }, "@roblox/enum/SubscriptionPeriod.Month": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionPeriod#Month", "code_sample": "" }, "@roblox/global/Enum.SubscriptionPeriod": { "documentation": "", "keys": { "Month": "@roblox/enum/SubscriptionPeriod.Month" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionPeriod", "code_sample": "" }, "@roblox/enum/LocationType.Character": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LocationType#Character", "code_sample": "" }, "@roblox/enum/LocationType.Camera": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LocationType#Camera", "code_sample": "" }, "@roblox/enum/LocationType.ObjectPosition": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LocationType#ObjectPosition", "code_sample": "" }, "@roblox/global/Enum.LocationType": { "documentation": "", "keys": { "Character": "@roblox/enum/LocationType.Character", "Camera": "@roblox/enum/LocationType.Camera", "ObjectPosition": "@roblox/enum/LocationType.ObjectPosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LocationType", "code_sample": "" }, "@roblox/enum/AudioWindowSize.Small": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize#Small", "code_sample": "" }, "@roblox/enum/AudioWindowSize.Medium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize#Medium", "code_sample": "" }, "@roblox/enum/AudioWindowSize.Large": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize#Large", "code_sample": "" }, "@roblox/global/Enum.AudioWindowSize": { "documentation": "", "keys": { "Small": "@roblox/enum/AudioWindowSize.Small", "Medium": "@roblox/enum/AudioWindowSize.Medium", "Large": "@roblox/enum/AudioWindowSize.Large" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioWindowSize", "code_sample": "" }, "@roblox/enum/GamepadType.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GamepadType#Unknown", "code_sample": "" }, "@roblox/enum/GamepadType.PS4": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GamepadType#PS4", "code_sample": "" }, "@roblox/enum/GamepadType.PS5": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GamepadType#PS5", "code_sample": "" }, "@roblox/enum/GamepadType.XboxOne": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GamepadType#XboxOne", "code_sample": "" }, "@roblox/global/Enum.GamepadType": { "documentation": "", "keys": { "Unknown": "@roblox/enum/GamepadType.Unknown", "PS4": "@roblox/enum/GamepadType.PS4", "PS5": "@roblox/enum/GamepadType.PS5", "XboxOne": "@roblox/enum/GamepadType.XboxOne" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GamepadType", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportToSpawnByName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportToSpawnByName", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportToPlaceInstance": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportToPlaceInstance", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportToPrivateServer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportToPrivateServer", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportPartyAsync": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportPartyAsync", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportToVIPServer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportToVIPServer", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportToInstanceBack": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportToInstanceBack", "code_sample": "" }, "@roblox/enum/TeleportMethod.TeleportUnknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod#TeleportUnknown", "code_sample": "" }, "@roblox/global/Enum.TeleportMethod": { "documentation": "", "keys": { "TeleportToSpawnByName": "@roblox/enum/TeleportMethod.TeleportToSpawnByName", "TeleportToPlaceInstance": "@roblox/enum/TeleportMethod.TeleportToPlaceInstance", "TeleportToPrivateServer": "@roblox/enum/TeleportMethod.TeleportToPrivateServer", "TeleportPartyAsync": "@roblox/enum/TeleportMethod.TeleportPartyAsync", "TeleportToVIPServer": "@roblox/enum/TeleportMethod.TeleportToVIPServer", "TeleportToInstanceBack": "@roblox/enum/TeleportMethod.TeleportToInstanceBack", "TeleportUnknown": "@roblox/enum/TeleportMethod.TeleportUnknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportMethod", "code_sample": "" }, "@roblox/enum/LuauTypeCheckMode.NoCheck": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LuauTypeCheckMode#NoCheck", "code_sample": "" }, "@roblox/enum/LuauTypeCheckMode.Nonstrict": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LuauTypeCheckMode#Nonstrict", "code_sample": "" }, "@roblox/enum/LuauTypeCheckMode.Strict": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LuauTypeCheckMode#Strict", "code_sample": "" }, "@roblox/global/Enum.LuauTypeCheckMode": { "documentation": "", "keys": { "NoCheck": "@roblox/enum/LuauTypeCheckMode.NoCheck", "Nonstrict": "@roblox/enum/LuauTypeCheckMode.Nonstrict", "Strict": "@roblox/enum/LuauTypeCheckMode.Strict" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LuauTypeCheckMode", "code_sample": "" }, "@roblox/enum/AvatarSettingsClothingMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsClothingMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsClothingMode.CustomLimit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsClothingMode#CustomLimit", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsClothingMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsClothingMode.PlayerChoice", "CustomLimit": "@roblox/enum/AvatarSettingsClothingMode.CustomLimit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsClothingMode", "code_sample": "" }, "@roblox/enum/DevTouchCameraMovementMode.UserChoice": { "documentation": "The camera will move based on the player's settings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#UserChoice", "code_sample": "" }, "@roblox/enum/DevTouchCameraMovementMode.Classic": { "documentation": "Camera tracks the player but will not automatically rotate if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#Classic", "code_sample": "" }, "@roblox/enum/DevTouchCameraMovementMode.Follow": { "documentation": "Camera tracks the player and automatically rotates if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#Follow", "code_sample": "" }, "@roblox/enum/DevTouchCameraMovementMode.Orbital": { "documentation": "The camera has a fixed Y position, but can be rotated around the player.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode#Orbital", "code_sample": "" }, "@roblox/global/Enum.DevTouchCameraMovementMode": { "documentation": "Overwrites the camera mode if the player is on a touch device.", "keys": { "UserChoice": "@roblox/enum/DevTouchCameraMovementMode.UserChoice", "Classic": "@roblox/enum/DevTouchCameraMovementMode.Classic", "Follow": "@roblox/enum/DevTouchCameraMovementMode.Follow", "Orbital": "@roblox/enum/DevTouchCameraMovementMode.Orbital" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchCameraMovementMode", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#Unknown", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.NotSupported": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#NotSupported", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.Failed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#Failed", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.NotAvailable": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#NotAvailable", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.Available": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#Available", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.AvailableBoundChannel": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#AvailableBoundChannel", "code_sample": "" }, "@roblox/enum/AppUpdateStatus.AvailableBetaProgram": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus#AvailableBetaProgram", "code_sample": "" }, "@roblox/global/Enum.AppUpdateStatus": { "documentation": "", "keys": { "Unknown": "@roblox/enum/AppUpdateStatus.Unknown", "NotSupported": "@roblox/enum/AppUpdateStatus.NotSupported", "Failed": "@roblox/enum/AppUpdateStatus.Failed", "NotAvailable": "@roblox/enum/AppUpdateStatus.NotAvailable", "Available": "@roblox/enum/AppUpdateStatus.Available", "AvailableBoundChannel": "@roblox/enum/AppUpdateStatus.AvailableBoundChannel", "AvailableBetaProgram": "@roblox/enum/AppUpdateStatus.AvailableBetaProgram" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppUpdateStatus", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.None": { "documentation": "This debug rendering mode does nothing. This is the default value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#None", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.BoundCage": { "documentation": "This debug mode visualizes corresponding cage mesh vertices bound to an underlying WrapTarget. In order to find corresponding vertices between different cages, the Wrap Deformer algorithm uses UV matching. As long as your WrapLayer cage mesh share the same UV layout as WrapTarget, its vertices will be marked as \"bound\".", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#BoundCage", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.LayerCage": { "documentation": "This debug mode shows the resulting layer mesh as a whole. The deformer will use vertex locations from the previous layer for all unbound vertices.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#LayerCage", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.BoundCageAndLinks": { "documentation": "The same as BoundCage but also visualizes how bound vertices were moved. You can use this mode to identify where they belong on a previous layer and where they are located on the current layer.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#BoundCageAndLinks", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.Reference": { "documentation": "This debug mode shows the original inner cage mesh as it was created.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#Reference", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.Rbf": { "documentation": "This debug mode visualizes the internal RBF solver state. You can estimate the wrap deformer's expected behavior by looking at this state. All renderable mesh vertices move from a \"big sphere\" to a \"small sphere\" along a corresponding line connecting two spheres.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#Rbf", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.OuterCage": { "documentation": "This debug mode shows the original outer cage mesh as it was created.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#OuterCage", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.ReferenceMeshAfterMorph": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#ReferenceMeshAfterMorph", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.HSROuterDetail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#HSROuterDetail", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.HSROuter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#HSROuter", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.HSRInner": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#HSRInner", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.HSRInnerReverse": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#HSRInnerReverse", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.LayerCageFittedToBase": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#LayerCageFittedToBase", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.LayerCageFittedToPrev": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#LayerCageFittedToPrev", "code_sample": "" }, "@roblox/enum/WrapLayerDebugMode.PreWrapDeformerOuterCage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode#PreWrapDeformerOuterCage", "code_sample": "" }, "@roblox/global/Enum.WrapLayerDebugMode": { "documentation": "The Studio-only property for quickly visualizing and debugging meshes with inner cage and outer cages.", "keys": { "None": "@roblox/enum/WrapLayerDebugMode.None", "BoundCage": "@roblox/enum/WrapLayerDebugMode.BoundCage", "LayerCage": "@roblox/enum/WrapLayerDebugMode.LayerCage", "BoundCageAndLinks": "@roblox/enum/WrapLayerDebugMode.BoundCageAndLinks", "Reference": "@roblox/enum/WrapLayerDebugMode.Reference", "Rbf": "@roblox/enum/WrapLayerDebugMode.Rbf", "OuterCage": "@roblox/enum/WrapLayerDebugMode.OuterCage", "ReferenceMeshAfterMorph": "@roblox/enum/WrapLayerDebugMode.ReferenceMeshAfterMorph", "HSROuterDetail": "@roblox/enum/WrapLayerDebugMode.HSROuterDetail", "HSROuter": "@roblox/enum/WrapLayerDebugMode.HSROuter", "HSRInner": "@roblox/enum/WrapLayerDebugMode.HSRInner", "HSRInnerReverse": "@roblox/enum/WrapLayerDebugMode.HSRInnerReverse", "LayerCageFittedToBase": "@roblox/enum/WrapLayerDebugMode.LayerCageFittedToBase", "LayerCageFittedToPrev": "@roblox/enum/WrapLayerDebugMode.LayerCageFittedToPrev", "PreWrapDeformerOuterCage": "@roblox/enum/WrapLayerDebugMode.PreWrapDeformerOuterCage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerDebugMode", "code_sample": "" }, "@roblox/enum/WaterForce.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterForce#None", "code_sample": "" }, "@roblox/enum/WaterForce.Small": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterForce#Small", "code_sample": "" }, "@roblox/enum/WaterForce.Medium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterForce#Medium", "code_sample": "" }, "@roblox/enum/WaterForce.Strong": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterForce#Strong", "code_sample": "" }, "@roblox/enum/WaterForce.Max": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterForce#Max", "code_sample": "" }, "@roblox/global/Enum.WaterForce": { "documentation": "The WaterForce Enum is used to work with Terrain water cells.", "keys": { "None": "@roblox/enum/WaterForce.None", "Small": "@roblox/enum/WaterForce.Small", "Medium": "@roblox/enum/WaterForce.Medium", "Strong": "@roblox/enum/WaterForce.Strong", "Max": "@roblox/enum/WaterForce.Max" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterForce", "code_sample": "" }, "@roblox/enum/BorderMode.Outline": { "documentation": "As GuiObject.BorderSizePixel increases, the border grows outward. The dimensions of the GuiObject's contents do not change.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderMode#Outline", "code_sample": "" }, "@roblox/enum/BorderMode.Middle": { "documentation": "As GuiObject.BorderSizePixel increases, the border grows evenly inward and outward. The dimensions of the GuiObject's contents are reduced at a 1:1 ratio.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderMode#Middle", "code_sample": "" }, "@roblox/enum/BorderMode.Inset": { "documentation": "As GuiObject.BorderSizePixel increases, the border grows evenly inward only. The dimensions of the GuiObject's contents are reduced at a 1:2 ratio.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderMode#Inset", "code_sample": "" }, "@roblox/global/Enum.BorderMode": { "documentation": "Used by GuiObject.BorderMode to determine where borders are placed.", "keys": { "Outline": "@roblox/enum/BorderMode.Outline", "Middle": "@roblox/enum/BorderMode.Middle", "Inset": "@roblox/enum/BorderMode.Inset" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderMode", "code_sample": "" }, "@roblox/enum/ParticleFlipbookLayout.None": { "documentation": "Disable flipbook features and use the texture as a single static texture over the particle's lifetime.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookLayout#None", "code_sample": "" }, "@roblox/enum/ParticleFlipbookLayout.Grid2x2": { "documentation": "2×2 frames for a 4-frame animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookLayout#Grid2x2", "code_sample": "" }, "@roblox/enum/ParticleFlipbookLayout.Grid4x4": { "documentation": "4×4 frames for a 16-frame animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookLayout#Grid4x4", "code_sample": "" }, "@roblox/enum/ParticleFlipbookLayout.Grid8x8": { "documentation": "8×8 frames for a 64-frame animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookLayout#Grid8x8", "code_sample": "" }, "@roblox/enum/ParticleFlipbookLayout.Custom": { "documentation": "A custom grid size defined by FlipbookSizeX and FlipbookSizeY.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookLayout#Custom", "code_sample": "" }, "@roblox/global/Enum.ParticleFlipbookLayout": { "documentation": "Determines the layout of the flipbook texture.", "keys": { "None": "@roblox/enum/ParticleFlipbookLayout.None", "Grid2x2": "@roblox/enum/ParticleFlipbookLayout.Grid2x2", "Grid4x4": "@roblox/enum/ParticleFlipbookLayout.Grid4x4", "Grid8x8": "@roblox/enum/ParticleFlipbookLayout.Grid8x8", "Custom": "@roblox/enum/ParticleFlipbookLayout.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookLayout", "code_sample": "" }, "@roblox/enum/RsvpStatus.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RsvpStatus#None", "code_sample": "" }, "@roblox/enum/RsvpStatus.Going": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RsvpStatus#Going", "code_sample": "" }, "@roblox/enum/RsvpStatus.NotGoing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RsvpStatus#NotGoing", "code_sample": "" }, "@roblox/global/Enum.RsvpStatus": { "documentation": "", "keys": { "None": "@roblox/enum/RsvpStatus.None", "Going": "@roblox/enum/RsvpStatus.Going", "NotGoing": "@roblox/enum/RsvpStatus.NotGoing" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RsvpStatus", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.UserChoice": { "documentation": "Allows players to choose their desired control scheme from the in-experience menu. This is the default movement mode.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#UserChoice", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.Thumbstick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Thumbstick", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.DPad": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#DPad", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.Thumbpad": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Thumbpad", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.ClickToMove": { "documentation": "The player's character will attempt to move to a location in the world when the player taps a location.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#ClickToMove", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.Scriptable": { "documentation": "The player's character will not respond to default controls; any character movement must be defined in custom scripts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#Scriptable", "code_sample": "" }, "@roblox/enum/DevTouchMovementMode.DynamicThumbstick": { "documentation": "The player's character is controlled with a virtual thumbstick that appears when they touch the lower portion of the screen. Jumping is controlled with a separate button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode#DynamicThumbstick", "code_sample": "" }, "@roblox/global/Enum.DevTouchMovementMode": { "documentation": "Overrides the movement mode of players who are playing on touch-enabled devices.", "keys": { "UserChoice": "@roblox/enum/DevTouchMovementMode.UserChoice", "Thumbstick": "@roblox/enum/DevTouchMovementMode.Thumbstick", "DPad": "@roblox/enum/DevTouchMovementMode.DPad", "Thumbpad": "@roblox/enum/DevTouchMovementMode.Thumbpad", "ClickToMove": "@roblox/enum/DevTouchMovementMode.ClickToMove", "Scriptable": "@roblox/enum/DevTouchMovementMode.Scriptable", "DynamicThumbstick": "@roblox/enum/DevTouchMovementMode.DynamicThumbstick" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevTouchMovementMode", "code_sample": "" }, "@roblox/enum/DominantAxis.Width": { "documentation": "The X axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DominantAxis#Width", "code_sample": "" }, "@roblox/enum/DominantAxis.Height": { "documentation": "The Y axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DominantAxis#Height", "code_sample": "" }, "@roblox/global/Enum.DominantAxis": { "documentation": "Used by UIAspectRatioConstraint.DominantAxis for resizing the object to maintain the aspect ratio.", "keys": { "Width": "@roblox/enum/DominantAxis.Width", "Height": "@roblox/enum/DominantAxis.Height" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DominantAxis", "code_sample": "" }, "@roblox/enum/UsageContext.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UsageContext#Default", "code_sample": "" }, "@roblox/enum/UsageContext.Preview": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UsageContext#Preview", "code_sample": "" }, "@roblox/global/Enum.UsageContext": { "documentation": "", "keys": { "Default": "@roblox/enum/UsageContext.Default", "Preview": "@roblox/enum/UsageContext.Preview" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UsageContext", "code_sample": "" }, "@roblox/enum/CompletionItemTag.Deprecated": { "documentation": "Indicates that the completion is deprecated, applying a penalty towards its score and crossing it out in the completion list.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#Deprecated", "code_sample": "" }, "@roblox/enum/CompletionItemTag.IncorrectIndexType": { "documentation": "Indicates that the completion is a member and being accessed with the wrong index type (e.g. using : to access a property), hiding it from the completion list.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#IncorrectIndexType", "code_sample": "" }, "@roblox/enum/CompletionItemTag.PluginPermissions": { "documentation": "Indicates that the completion requires Plugin security level to access, hiding it if the client lacks this level.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#PluginPermissions", "code_sample": "" }, "@roblox/enum/CompletionItemTag.CommandLinePermissions": { "documentation": "Indicates that the completion requires Command line security level to access, hiding it if the client lacks this level.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#CommandLinePermissions", "code_sample": "" }, "@roblox/enum/CompletionItemTag.RobloxPermissions": { "documentation": "Indicates that the completion requires core script security level to access, hiding it if the client lacks this level.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#RobloxPermissions", "code_sample": "" }, "@roblox/enum/CompletionItemTag.AddParens": { "documentation": "Instructs the editor to add parentheses before the cursor after inserting the given completion, if accepted.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#AddParens", "code_sample": "" }, "@roblox/enum/CompletionItemTag.PutCursorInParens": { "documentation": "Instructs the editor to add parentheses before the cursor and move the cursor into the parentheses after inserting the given completion, if accepted.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#PutCursorInParens", "code_sample": "" }, "@roblox/enum/CompletionItemTag.TypeCorrect": { "documentation": "Indicates that the completion is type correct in the current context, granting a bonus to its score.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#TypeCorrect", "code_sample": "" }, "@roblox/enum/CompletionItemTag.ClientServerBoundaryViolation": { "documentation": "Indicates that the completion is being accessed from the wrong side of the client/server boundary (e.g. Players.LocalPlayer in a server script), hiding it from the completion list.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#ClientServerBoundaryViolation", "code_sample": "" }, "@roblox/enum/CompletionItemTag.Invalidated": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#Invalidated", "code_sample": "" }, "@roblox/enum/CompletionItemTag.PutCursorBeforeEnd": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag#PutCursorBeforeEnd", "code_sample": "" }, "@roblox/global/Enum.CompletionItemTag": { "documentation": "Determines the tags for completion items in ScriptEditorService:RegisterAutocompleteCallback().", "keys": { "Deprecated": "@roblox/enum/CompletionItemTag.Deprecated", "IncorrectIndexType": "@roblox/enum/CompletionItemTag.IncorrectIndexType", "PluginPermissions": "@roblox/enum/CompletionItemTag.PluginPermissions", "CommandLinePermissions": "@roblox/enum/CompletionItemTag.CommandLinePermissions", "RobloxPermissions": "@roblox/enum/CompletionItemTag.RobloxPermissions", "AddParens": "@roblox/enum/CompletionItemTag.AddParens", "PutCursorInParens": "@roblox/enum/CompletionItemTag.PutCursorInParens", "TypeCorrect": "@roblox/enum/CompletionItemTag.TypeCorrect", "ClientServerBoundaryViolation": "@roblox/enum/CompletionItemTag.ClientServerBoundaryViolation", "Invalidated": "@roblox/enum/CompletionItemTag.Invalidated", "PutCursorBeforeEnd": "@roblox/enum/CompletionItemTag.PutCursorBeforeEnd" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemTag", "code_sample": "" }, "@roblox/enum/AudioApiRollout.Disabled": { "documentation": "Voice chat will use an internal voice chat implementation that is automatic and hidden.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout#Disabled", "code_sample": "" }, "@roblox/enum/AudioApiRollout.Automatic": { "documentation": "Currently means the same thing as Disabled, but will be updated to mean Enabled in the future.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout#Automatic", "code_sample": "" }, "@roblox/enum/AudioApiRollout.Enabled": { "documentation": "Voice chat can be customized or controlled via AudioDeviceInputs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout#Enabled", "code_sample": "" }, "@roblox/global/Enum.AudioApiRollout": { "documentation": "Used to determine whether voice chat is represented and controlled by AudioDeviceInput objects.", "keys": { "Disabled": "@roblox/enum/AudioApiRollout.Disabled", "Automatic": "@roblox/enum/AudioApiRollout.Automatic", "Enabled": "@roblox/enum/AudioApiRollout.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioApiRollout", "code_sample": "" }, "@roblox/enum/VerticalAlignment.Center": { "documentation": "Grid is aligned to the center of its parent along the Y axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalAlignment#Center", "code_sample": "" }, "@roblox/enum/VerticalAlignment.Top": { "documentation": "Grid is aligned to the top edge of its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalAlignment#Top", "code_sample": "" }, "@roblox/enum/VerticalAlignment.Bottom": { "documentation": "Grid is aligned to the bottom edge of its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalAlignment#Bottom", "code_sample": "" }, "@roblox/global/Enum.VerticalAlignment": { "documentation": "Used by UIGridStyleLayout.VerticalAlignment to align the layout vertically within its parent.", "keys": { "Center": "@roblox/enum/VerticalAlignment.Center", "Top": "@roblox/enum/VerticalAlignment.Top", "Bottom": "@roblox/enum/VerticalAlignment.Bottom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VerticalAlignment", "code_sample": "" }, "@roblox/enum/AnnotationRequestType.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Unknown", "code_sample": "" }, "@roblox/enum/AnnotationRequestType.Create": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Create", "code_sample": "" }, "@roblox/enum/AnnotationRequestType.Resolve": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Resolve", "code_sample": "" }, "@roblox/enum/AnnotationRequestType.Delete": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Delete", "code_sample": "" }, "@roblox/enum/AnnotationRequestType.Edit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType#Edit", "code_sample": "" }, "@roblox/global/Enum.AnnotationRequestType": { "documentation": "", "keys": { "Unknown": "@roblox/enum/AnnotationRequestType.Unknown", "Create": "@roblox/enum/AnnotationRequestType.Create", "Resolve": "@roblox/enum/AnnotationRequestType.Resolve", "Delete": "@roblox/enum/AnnotationRequestType.Delete", "Edit": "@roblox/enum/AnnotationRequestType.Edit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestType", "code_sample": "" }, "@roblox/enum/TextureMode.Stretch": { "documentation": "For a Trail, the texture will stretch out based on the lifetime of the trail, and shrink inwards if the trail's attachments stop moving. For a Beam, the texture will repeat TextureLength times across the beam's overall length. See here for details.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureMode#Stretch", "code_sample": "" }, "@roblox/enum/TextureMode.Wrap": { "documentation": "For a Trail, the texture will be tiled as the length of the trail changes, but the textures will remain stationary relative to their attachments. For a Beam, the texture repetitions will equal the beam's overall length (in studs) divided by its TextureLength. See here for details.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureMode#Wrap", "code_sample": "" }, "@roblox/enum/TextureMode.Static": { "documentation": "For a Trail, the texture will be rolled out as the attachments move, and they will remain in place until their lifetime is met. This setting is ideal for trail textures that should appear \"stamped\" where rendered, such as paw prints or tire tracks. This value is not supported for Beam and therefore behaves identically to Wrap.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureMode#Static", "code_sample": "" }, "@roblox/global/Enum.TextureMode": { "documentation": "Describes how the texture of a Trail or Beam behaves.", "keys": { "Stretch": "@roblox/enum/TextureMode.Stretch", "Wrap": "@roblox/enum/TextureMode.Wrap", "Static": "@roblox/enum/TextureMode.Static" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextureMode", "code_sample": "" }, "@roblox/enum/GearType.MeleeWeapons": { "documentation": "Deprecated:
Gear with the 'Melee' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#MeleeWeapons", "code_sample": "" }, "@roblox/enum/GearType.RangedWeapons": { "documentation": "Deprecated:
Gear with the 'Ranged' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#RangedWeapons", "code_sample": "" }, "@roblox/enum/GearType.Explosives": { "documentation": "Deprecated:
Gear with the 'Explosive' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#Explosives", "code_sample": "" }, "@roblox/enum/GearType.PowerUps": { "documentation": "Deprecated:
Gear with the 'Power Up' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#PowerUps", "code_sample": "" }, "@roblox/enum/GearType.NavigationEnhancers": { "documentation": "Deprecated:
Gear with the 'Navigation' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#NavigationEnhancers", "code_sample": "" }, "@roblox/enum/GearType.MusicalInstruments": { "documentation": "Deprecated:
Gear with the 'Musical' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#MusicalInstruments", "code_sample": "" }, "@roblox/enum/GearType.SocialItems": { "documentation": "Deprecated:
Gear with the 'Social' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#SocialItems", "code_sample": "" }, "@roblox/enum/GearType.BuildingTools": { "documentation": "Deprecated:
Gear with the 'Building' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#BuildingTools", "code_sample": "" }, "@roblox/enum/GearType.Transport": { "documentation": "Deprecated:
Gear with the 'Transport' attribute.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType#Transport", "code_sample": "" }, "@roblox/global/Enum.GearType": { "documentation": "Deprecated: This enum is deprecated because it's used by deprecated properties. Don't use it.", "keys": { "MeleeWeapons": "@roblox/enum/GearType.MeleeWeapons", "RangedWeapons": "@roblox/enum/GearType.RangedWeapons", "Explosives": "@roblox/enum/GearType.Explosives", "PowerUps": "@roblox/enum/GearType.PowerUps", "NavigationEnhancers": "@roblox/enum/GearType.NavigationEnhancers", "MusicalInstruments": "@roblox/enum/GearType.MusicalInstruments", "SocialItems": "@roblox/enum/GearType.SocialItems", "BuildingTools": "@roblox/enum/GearType.BuildingTools", "Transport": "@roblox/enum/GearType.Transport" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearType", "code_sample": "" }, "@roblox/enum/ScaleType.Stretch": { "documentation": "The image is stretched to fit within the element.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScaleType#Stretch", "code_sample": "" }, "@roblox/enum/ScaleType.Slice": { "documentation": "9-Slice scaling: slice the image into 9 regions and apply different scaling rules to each region. The slice boundaries are determined by ImageLabel.SliceCenter or ImageButton.SliceCenter. See UI 9-Slice Design for more information. .", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScaleType#Slice", "code_sample": "" }, "@roblox/enum/ScaleType.Tile": { "documentation": "The image is tiled to fit within the element. For example, if the element is twice the X dimension of the image, the image will appear twice (2 tiles).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScaleType#Tile", "code_sample": "" }, "@roblox/enum/ScaleType.Fit": { "documentation": "The image is scaled fit within the element X or Y dimension (whichever fits first).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScaleType#Fit", "code_sample": "" }, "@roblox/enum/ScaleType.Crop": { "documentation": "The image is cropped to fit within the element.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScaleType#Crop", "code_sample": "" }, "@roblox/global/Enum.ScaleType": { "documentation": "Determines how an image (of a ImageLabel or ImageButton) is scaled.", "keys": { "Stretch": "@roblox/enum/ScaleType.Stretch", "Slice": "@roblox/enum/ScaleType.Slice", "Tile": "@roblox/enum/ScaleType.Tile", "Fit": "@roblox/enum/ScaleType.Fit", "Crop": "@roblox/enum/ScaleType.Crop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScaleType", "code_sample": "" }, "@roblox/enum/OutfitSource.All": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitSource#All", "code_sample": "" }, "@roblox/enum/OutfitSource.Created": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitSource#Created", "code_sample": "" }, "@roblox/enum/OutfitSource.Purchased": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitSource#Purchased", "code_sample": "" }, "@roblox/global/Enum.OutfitSource": { "documentation": "", "keys": { "All": "@roblox/enum/OutfitSource.All", "Created": "@roblox/enum/OutfitSource.Created", "Purchased": "@roblox/enum/OutfitSource.Purchased" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitSource", "code_sample": "" }, "@roblox/enum/WaterDirection.NegX": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection#NegX", "code_sample": "" }, "@roblox/enum/WaterDirection.X": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection#X", "code_sample": "" }, "@roblox/enum/WaterDirection.NegY": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection#NegY", "code_sample": "" }, "@roblox/enum/WaterDirection.Y": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection#Y", "code_sample": "" }, "@roblox/enum/WaterDirection.NegZ": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection#NegZ", "code_sample": "" }, "@roblox/enum/WaterDirection.Z": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection#Z", "code_sample": "" }, "@roblox/global/Enum.WaterDirection": { "documentation": "This Enum was once used to set the direction of Terrain water.", "keys": { "NegX": "@roblox/enum/WaterDirection.NegX", "X": "@roblox/enum/WaterDirection.X", "NegY": "@roblox/enum/WaterDirection.NegY", "Y": "@roblox/enum/WaterDirection.Y", "NegZ": "@roblox/enum/WaterDirection.NegZ", "Z": "@roblox/enum/WaterDirection.Z" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WaterDirection", "code_sample": "" }, "@roblox/enum/HandlesStyle.Resize": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandlesStyle#Resize", "code_sample": "" }, "@roblox/enum/HandlesStyle.Movement": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandlesStyle#Movement", "code_sample": "" }, "@roblox/global/Enum.HandlesStyle": { "documentation": "", "keys": { "Resize": "@roblox/enum/HandlesStyle.Resize", "Movement": "@roblox/enum/HandlesStyle.Movement" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandlesStyle", "code_sample": "" }, "@roblox/enum/ExperienceAuthScope.DefaultScope": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceAuthScope#DefaultScope", "code_sample": "" }, "@roblox/enum/ExperienceAuthScope.CreatorAssetsCreate": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceAuthScope#CreatorAssetsCreate", "code_sample": "" }, "@roblox/global/Enum.ExperienceAuthScope": { "documentation": "", "keys": { "DefaultScope": "@roblox/enum/ExperienceAuthScope.DefaultScope", "CreatorAssetsCreate": "@roblox/enum/ExperienceAuthScope.CreatorAssetsCreate" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceAuthScope", "code_sample": "" }, "@roblox/enum/ShowAdResult.ShowCompleted": { "documentation": "The ad was successfully shown to completion.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#ShowCompleted", "code_sample": "" }, "@roblox/enum/ShowAdResult.AdNotReady": { "documentation": "You are trying to show a full-screen ad before the ad has fully loaded. You might have failed to properly fetch the ad, or the ad might have expired.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#AdNotReady", "code_sample": "" }, "@roblox/enum/ShowAdResult.AdAlreadyShowing": { "documentation": "You are trying to show a full-screen ad while another full-screen ad is already playing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#AdAlreadyShowing", "code_sample": "" }, "@roblox/enum/ShowAdResult.InternalError": { "documentation": "An unspecified internal error occurred. Try showing the ad again.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#InternalError", "code_sample": "" }, "@roblox/enum/ShowAdResult.ShowInterrupted": { "documentation": "The ad view of the user has been interrupted. The user might have closed the ad view or left the experience, and should not receive a reward.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#ShowInterrupted", "code_sample": "" }, "@roblox/enum/ShowAdResult.InsufficientMemory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult#InsufficientMemory", "code_sample": "" }, "@roblox/global/Enum.ShowAdResult": { "documentation": "", "keys": { "ShowCompleted": "@roblox/enum/ShowAdResult.ShowCompleted", "AdNotReady": "@roblox/enum/ShowAdResult.AdNotReady", "AdAlreadyShowing": "@roblox/enum/ShowAdResult.AdAlreadyShowing", "InternalError": "@roblox/enum/ShowAdResult.InternalError", "ShowInterrupted": "@roblox/enum/ShowAdResult.ShowInterrupted", "InsufficientMemory": "@roblox/enum/ShowAdResult.InsufficientMemory" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ShowAdResult", "code_sample": "" }, "@roblox/enum/CloseReason.Unknown": { "documentation": "The server shut down for an unknown reason.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason#Unknown", "code_sample": "" }, "@roblox/enum/CloseReason.RobloxMaintenance": { "documentation": "The server shut down for maintenance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason#RobloxMaintenance", "code_sample": "" }, "@roblox/enum/CloseReason.DeveloperShutdown": { "documentation": "The experience developer has shut down the server, or functions bound by BindToClose() have been called inside Studio.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason#DeveloperShutdown", "code_sample": "" }, "@roblox/enum/CloseReason.DeveloperUpdate": { "documentation": "The experience developer has migrated the server to a new place version.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason#DeveloperUpdate", "code_sample": "" }, "@roblox/enum/CloseReason.ServerEmpty": { "documentation": "The last player has left and the experience is empty.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason#ServerEmpty", "code_sample": "" }, "@roblox/enum/CloseReason.OutOfMemory": { "documentation": "The experience has hit the memory limit for the game server.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason#OutOfMemory", "code_sample": "" }, "@roblox/global/Enum.CloseReason": { "documentation": "Specifies the reason for the experience server shutdown.", "keys": { "Unknown": "@roblox/enum/CloseReason.Unknown", "RobloxMaintenance": "@roblox/enum/CloseReason.RobloxMaintenance", "DeveloperShutdown": "@roblox/enum/CloseReason.DeveloperShutdown", "DeveloperUpdate": "@roblox/enum/CloseReason.DeveloperUpdate", "ServerEmpty": "@roblox/enum/CloseReason.ServerEmpty", "OutOfMemory": "@roblox/enum/CloseReason.OutOfMemory" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CloseReason", "code_sample": "" }, "@roblox/enum/TrackerPromptEvent.LODCameraRecommendDisable": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerPromptEvent#LODCameraRecommendDisable", "code_sample": "" }, "@roblox/global/Enum.TrackerPromptEvent": { "documentation": "", "keys": { "LODCameraRecommendDisable": "@roblox/enum/TrackerPromptEvent.LODCameraRecommendDisable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerPromptEvent", "code_sample": "" }, "@roblox/enum/AccessoryType.Unknown": { "documentation": "If the accessory type is not known.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Unknown", "code_sample": "" }, "@roblox/enum/AccessoryType.Hat": { "documentation": "A hat accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Hat", "code_sample": "" }, "@roblox/enum/AccessoryType.Hair": { "documentation": "A hair accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Hair", "code_sample": "" }, "@roblox/enum/AccessoryType.Face": { "documentation": "A face accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Face", "code_sample": "" }, "@roblox/enum/AccessoryType.Neck": { "documentation": "A neck Accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Neck", "code_sample": "" }, "@roblox/enum/AccessoryType.Shoulder": { "documentation": "A shoulder accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Shoulder", "code_sample": "" }, "@roblox/enum/AccessoryType.Front": { "documentation": "A front accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Front", "code_sample": "" }, "@roblox/enum/AccessoryType.Back": { "documentation": "A back accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Back", "code_sample": "" }, "@roblox/enum/AccessoryType.Waist": { "documentation": "A waist accessory (may be a rigid or layered accessory).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Waist", "code_sample": "" }, "@roblox/enum/AccessoryType.TShirt": { "documentation": "A layered clothing T-Shirt accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#TShirt", "code_sample": "" }, "@roblox/enum/AccessoryType.Shirt": { "documentation": "A layered clothing shirt accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Shirt", "code_sample": "" }, "@roblox/enum/AccessoryType.Pants": { "documentation": "A layered clothing pants accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Pants", "code_sample": "" }, "@roblox/enum/AccessoryType.Jacket": { "documentation": "A layered clothing jacket accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Jacket", "code_sample": "" }, "@roblox/enum/AccessoryType.Sweater": { "documentation": "A layered clothing sweater accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Sweater", "code_sample": "" }, "@roblox/enum/AccessoryType.Shorts": { "documentation": "A layered clothing shorts accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Shorts", "code_sample": "" }, "@roblox/enum/AccessoryType.LeftShoe": { "documentation": "A layered clothing left shoe accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#LeftShoe", "code_sample": "" }, "@roblox/enum/AccessoryType.RightShoe": { "documentation": "A layered clothing right shoe accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#RightShoe", "code_sample": "" }, "@roblox/enum/AccessoryType.DressSkirt": { "documentation": "A layered clothing dress or skirt accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#DressSkirt", "code_sample": "" }, "@roblox/enum/AccessoryType.Eyebrow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Eyebrow", "code_sample": "" }, "@roblox/enum/AccessoryType.Eyelash": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType#Eyelash", "code_sample": "" }, "@roblox/global/Enum.AccessoryType": { "documentation": "A subset of AssetTypes which are relevant to only accessories.", "keys": { "Unknown": "@roblox/enum/AccessoryType.Unknown", "Hat": "@roblox/enum/AccessoryType.Hat", "Hair": "@roblox/enum/AccessoryType.Hair", "Face": "@roblox/enum/AccessoryType.Face", "Neck": "@roblox/enum/AccessoryType.Neck", "Shoulder": "@roblox/enum/AccessoryType.Shoulder", "Front": "@roblox/enum/AccessoryType.Front", "Back": "@roblox/enum/AccessoryType.Back", "Waist": "@roblox/enum/AccessoryType.Waist", "TShirt": "@roblox/enum/AccessoryType.TShirt", "Shirt": "@roblox/enum/AccessoryType.Shirt", "Pants": "@roblox/enum/AccessoryType.Pants", "Jacket": "@roblox/enum/AccessoryType.Jacket", "Sweater": "@roblox/enum/AccessoryType.Sweater", "Shorts": "@roblox/enum/AccessoryType.Shorts", "LeftShoe": "@roblox/enum/AccessoryType.LeftShoe", "RightShoe": "@roblox/enum/AccessoryType.RightShoe", "DressSkirt": "@roblox/enum/AccessoryType.DressSkirt", "Eyebrow": "@roblox/enum/AccessoryType.Eyebrow", "Eyelash": "@roblox/enum/AccessoryType.Eyelash" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessoryType", "code_sample": "" }, "@roblox/enum/AvatarSettingsJumpMode.JumpHeight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsJumpMode#JumpHeight", "code_sample": "" }, "@roblox/enum/AvatarSettingsJumpMode.JumpPower": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsJumpMode#JumpPower", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsJumpMode": { "documentation": "", "keys": { "JumpHeight": "@roblox/enum/AvatarSettingsJumpMode.JumpHeight", "JumpPower": "@roblox/enum/AvatarSettingsJumpMode.JumpPower" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsJumpMode", "code_sample": "" }, "@roblox/enum/NameOcclusion.NoOcclusion": { "documentation": "Do not occlude (hide) any humanoid names.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NameOcclusion#NoOcclusion", "code_sample": "" }, "@roblox/enum/NameOcclusion.EnemyOcclusion": { "documentation": "Occlude (hide) all enemy humanoid names.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NameOcclusion#EnemyOcclusion", "code_sample": "" }, "@roblox/enum/NameOcclusion.OccludeAll": { "documentation": "Occlude (hide) all humanoid names.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NameOcclusion#OccludeAll", "code_sample": "" }, "@roblox/global/Enum.NameOcclusion": { "documentation": "The NameOcclusion Enum is used to set the Humanoid.NameOcclusion property.", "keys": { "NoOcclusion": "@roblox/enum/NameOcclusion.NoOcclusion", "EnemyOcclusion": "@roblox/enum/NameOcclusion.EnemyOcclusion", "OccludeAll": "@roblox/enum/NameOcclusion.OccludeAll" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NameOcclusion", "code_sample": "" }, "@roblox/enum/ReturnKeyType.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType#Default", "code_sample": "" }, "@roblox/enum/ReturnKeyType.Done": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType#Done", "code_sample": "" }, "@roblox/enum/ReturnKeyType.Go": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType#Go", "code_sample": "" }, "@roblox/enum/ReturnKeyType.Next": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType#Next", "code_sample": "" }, "@roblox/enum/ReturnKeyType.Search": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType#Search", "code_sample": "" }, "@roblox/enum/ReturnKeyType.Send": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType#Send", "code_sample": "" }, "@roblox/global/Enum.ReturnKeyType": { "documentation": "", "keys": { "Default": "@roblox/enum/ReturnKeyType.Default", "Done": "@roblox/enum/ReturnKeyType.Done", "Go": "@roblox/enum/ReturnKeyType.Go", "Next": "@roblox/enum/ReturnKeyType.Next", "Search": "@roblox/enum/ReturnKeyType.Search", "Send": "@roblox/enum/ReturnKeyType.Send" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReturnKeyType", "code_sample": "" }, "@roblox/enum/FontSize.Size8": { "documentation": "Font size 8.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size8", "code_sample": "" }, "@roblox/enum/FontSize.Size9": { "documentation": "Font size 9.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size9", "code_sample": "" }, "@roblox/enum/FontSize.Size10": { "documentation": "Font size 10.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size10", "code_sample": "" }, "@roblox/enum/FontSize.Size11": { "documentation": "Font size 11.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size11", "code_sample": "" }, "@roblox/enum/FontSize.Size12": { "documentation": "Font size 12.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size12", "code_sample": "" }, "@roblox/enum/FontSize.Size14": { "documentation": "Font size 14.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size14", "code_sample": "" }, "@roblox/enum/FontSize.Size18": { "documentation": "Font size 18.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size18", "code_sample": "" }, "@roblox/enum/FontSize.Size24": { "documentation": "Font size 24.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size24", "code_sample": "" }, "@roblox/enum/FontSize.Size36": { "documentation": "Font size 36.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size36", "code_sample": "" }, "@roblox/enum/FontSize.Size48": { "documentation": "Font size 48.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size48", "code_sample": "" }, "@roblox/enum/FontSize.Size28": { "documentation": "Font size 28.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size28", "code_sample": "" }, "@roblox/enum/FontSize.Size32": { "documentation": "Font size 32.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size32", "code_sample": "" }, "@roblox/enum/FontSize.Size42": { "documentation": "Font size 42.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size42", "code_sample": "" }, "@roblox/enum/FontSize.Size60": { "documentation": "Font size 60.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size60", "code_sample": "" }, "@roblox/enum/FontSize.Size96": { "documentation": "Font size 96.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize#Size96", "code_sample": "" }, "@roblox/global/Enum.FontSize": { "documentation": "", "keys": { "Size8": "@roblox/enum/FontSize.Size8", "Size9": "@roblox/enum/FontSize.Size9", "Size10": "@roblox/enum/FontSize.Size10", "Size11": "@roblox/enum/FontSize.Size11", "Size12": "@roblox/enum/FontSize.Size12", "Size14": "@roblox/enum/FontSize.Size14", "Size18": "@roblox/enum/FontSize.Size18", "Size24": "@roblox/enum/FontSize.Size24", "Size36": "@roblox/enum/FontSize.Size36", "Size48": "@roblox/enum/FontSize.Size48", "Size28": "@roblox/enum/FontSize.Size28", "Size32": "@roblox/enum/FontSize.Size32", "Size42": "@roblox/enum/FontSize.Size42", "Size60": "@roblox/enum/FontSize.Size60", "Size96": "@roblox/enum/FontSize.Size96" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontSize", "code_sample": "" }, "@roblox/enum/AppLifecycleManagerState.Detached": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Detached", "code_sample": "" }, "@roblox/enum/AppLifecycleManagerState.Active": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Active", "code_sample": "" }, "@roblox/enum/AppLifecycleManagerState.Inactive": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Inactive", "code_sample": "" }, "@roblox/enum/AppLifecycleManagerState.Hidden": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState#Hidden", "code_sample": "" }, "@roblox/global/Enum.AppLifecycleManagerState": { "documentation": "", "keys": { "Detached": "@roblox/enum/AppLifecycleManagerState.Detached", "Active": "@roblox/enum/AppLifecycleManagerState.Active", "Inactive": "@roblox/enum/AppLifecycleManagerState.Inactive", "Hidden": "@roblox/enum/AppLifecycleManagerState.Hidden" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppLifecycleManagerState", "code_sample": "" }, "@roblox/enum/MatchmakingType.Default": { "documentation": "Includes desktop, mobile, cross-play enabled players, etc.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#Default", "code_sample": "" }, "@roblox/enum/MatchmakingType.XboxOnly": { "documentation": "Xbox players with cross-play disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#XboxOnly", "code_sample": "" }, "@roblox/enum/MatchmakingType.PlayStationOnly": { "documentation": "PlayStation players with cross-play disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MatchmakingType#PlayStationOnly", "code_sample": "" }, "@roblox/global/Enum.MatchmakingType": { "documentation": "Used with DataModel.MatchmakingType to represent how players in the server are handled by matchmaking.", "keys": { "Default": "@roblox/enum/MatchmakingType.Default", "XboxOnly": "@roblox/enum/MatchmakingType.XboxOnly", "PlayStationOnly": "@roblox/enum/MatchmakingType.PlayStationOnly" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MatchmakingType", "code_sample": "" }, "@roblox/enum/OverrideMouseIconBehavior.None": { "documentation": "The mouse icon behavior is not overridden - default behavior is used.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OverrideMouseIconBehavior#None", "code_sample": "" }, "@roblox/enum/OverrideMouseIconBehavior.ForceShow": { "documentation": "The mouse icon is forced to always remain shown/visible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OverrideMouseIconBehavior#ForceShow", "code_sample": "" }, "@roblox/enum/OverrideMouseIconBehavior.ForceHide": { "documentation": "The mouse icon is forced to always remain hidden/invisible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OverrideMouseIconBehavior#ForceHide", "code_sample": "" }, "@roblox/global/Enum.OverrideMouseIconBehavior": { "documentation": "Overrides the behavior of the mouse icon to either force that it is always shown or force that it is always hidden.", "keys": { "None": "@roblox/enum/OverrideMouseIconBehavior.None", "ForceShow": "@roblox/enum/OverrideMouseIconBehavior.ForceShow", "ForceHide": "@roblox/enum/OverrideMouseIconBehavior.ForceHide" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OverrideMouseIconBehavior", "code_sample": "" }, "@roblox/enum/MarketplaceProductType.AvatarAsset": { "documentation": "Avatar asset", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceProductType#AvatarAsset", "code_sample": "" }, "@roblox/enum/MarketplaceProductType.AvatarBundle": { "documentation": "Avatar bundle", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceProductType#AvatarBundle", "code_sample": "" }, "@roblox/global/Enum.MarketplaceProductType": { "documentation": "Indicates if an avatar item is an asset or bundle. Used with MarketplaceService and similar services.", "keys": { "AvatarAsset": "@roblox/enum/MarketplaceProductType.AvatarAsset", "AvatarBundle": "@roblox/enum/MarketplaceProductType.AvatarBundle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceProductType", "code_sample": "" }, "@roblox/enum/SensorUpdateType.OnRead": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SensorUpdateType#OnRead", "code_sample": "" }, "@roblox/enum/SensorUpdateType.Manual": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SensorUpdateType#Manual", "code_sample": "" }, "@roblox/global/Enum.SensorUpdateType": { "documentation": "", "keys": { "OnRead": "@roblox/enum/SensorUpdateType.OnRead", "Manual": "@roblox/enum/SensorUpdateType.Manual" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SensorUpdateType", "code_sample": "" }, "@roblox/enum/LeftRight.Left": { "documentation": "The object is on the left side of its parent (X axis).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LeftRight#Left", "code_sample": "" }, "@roblox/enum/LeftRight.Center": { "documentation": "The object is centered on the center of its parent (X axis), expanding equally to the left and right of the parent's center.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LeftRight#Center", "code_sample": "" }, "@roblox/enum/LeftRight.Right": { "documentation": "The object is on the right side of its parent (X axis).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LeftRight#Right", "code_sample": "" }, "@roblox/global/Enum.LeftRight": { "documentation": "The LeftRight Enum is used to set where the object is on the side of its parent.", "keys": { "Left": "@roblox/enum/LeftRight.Left", "Center": "@roblox/enum/LeftRight.Center", "Right": "@roblox/enum/LeftRight.Right" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LeftRight", "code_sample": "" }, "@roblox/enum/VRComfortSetting.Comfort": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRComfortSetting#Comfort", "code_sample": "" }, "@roblox/enum/VRComfortSetting.Normal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRComfortSetting#Normal", "code_sample": "" }, "@roblox/enum/VRComfortSetting.Expert": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRComfortSetting#Expert", "code_sample": "" }, "@roblox/enum/VRComfortSetting.Custom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRComfortSetting#Custom", "code_sample": "" }, "@roblox/global/Enum.VRComfortSetting": { "documentation": "", "keys": { "Comfort": "@roblox/enum/VRComfortSetting.Comfort", "Normal": "@roblox/enum/VRComfortSetting.Normal", "Expert": "@roblox/enum/VRComfortSetting.Expert", "Custom": "@roblox/enum/VRComfortSetting.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRComfortSetting", "code_sample": "" }, "@roblox/enum/BinType.Script": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BinType#Script", "code_sample": "" }, "@roblox/enum/BinType.GameTool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BinType#GameTool", "code_sample": "" }, "@roblox/enum/BinType.Grab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BinType#Grab", "code_sample": "" }, "@roblox/enum/BinType.Clone": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BinType#Clone", "code_sample": "" }, "@roblox/enum/BinType.Hammer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BinType#Hammer", "code_sample": "" }, "@roblox/global/Enum.BinType": { "documentation": "", "keys": { "Script": "@roblox/enum/BinType.Script", "GameTool": "@roblox/enum/BinType.GameTool", "Grab": "@roblox/enum/BinType.Grab", "Clone": "@roblox/enum/BinType.Clone", "Hammer": "@roblox/enum/BinType.Hammer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BinType", "code_sample": "" }, "@roblox/enum/HumanoidDisplayDistanceType.Viewer": { "documentation": "A player selecting Viewer on their Humanoid will see the Name and healthbar of other players if those other players are within the distance settings set in the Humanoid selecting Viewer (this can be thought of as the lowest priority, and will not be taken into account if other players are selecting 'Subject' or 'None').", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidDisplayDistanceType#Viewer", "code_sample": "" }, "@roblox/enum/HumanoidDisplayDistanceType.Subject": { "documentation": "A player selecting Subject on their Humanoid will allow other players to see their Name and healthbar if those other players are within the distance settings set in the Humanoid selecting Subject (this can be thought of as the second highest priority).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidDisplayDistanceType#Subject", "code_sample": "" }, "@roblox/enum/HumanoidDisplayDistanceType.None": { "documentation": "A player selecting None on their Humanoid will not have their Name and healthbar displayed to other players under any circumstance (this can be thought of as the highest priority).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidDisplayDistanceType#None", "code_sample": "" }, "@roblox/global/Enum.HumanoidDisplayDistanceType": { "documentation": "HumanoidDisplayDistanceType determines how Humanoid.HealthDisplayDistance, and Humanoid.NameDisplayDistance are used in determining whether a players's name and health are visible to other players.", "keys": { "Viewer": "@roblox/enum/HumanoidDisplayDistanceType.Viewer", "Subject": "@roblox/enum/HumanoidDisplayDistanceType.Subject", "None": "@roblox/enum/HumanoidDisplayDistanceType.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidDisplayDistanceType", "code_sample": "" }, "@roblox/enum/PositionAlignmentMode.OneAttachment": { "documentation": "Use one attachment.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PositionAlignmentMode#OneAttachment", "code_sample": "" }, "@roblox/enum/PositionAlignmentMode.TwoAttachment": { "documentation": "Use two attachments.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PositionAlignmentMode#TwoAttachment", "code_sample": "" }, "@roblox/global/Enum.PositionAlignmentMode": { "documentation": "The PositionAlignmentMode Enum is used to select the number of Attachments used in an alignment.", "keys": { "OneAttachment": "@roblox/enum/PositionAlignmentMode.OneAttachment", "TwoAttachment": "@roblox/enum/PositionAlignmentMode.TwoAttachment" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PositionAlignmentMode", "code_sample": "" }, "@roblox/enum/AssetCreatorType.User": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetCreatorType#User", "code_sample": "" }, "@roblox/enum/AssetCreatorType.Group": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetCreatorType#Group", "code_sample": "" }, "@roblox/global/Enum.AssetCreatorType": { "documentation": "", "keys": { "User": "@roblox/enum/AssetCreatorType.User", "Group": "@roblox/enum/AssetCreatorType.Group" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetCreatorType", "code_sample": "" }, "@roblox/enum/CommandPermission.Plugin": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CommandPermission#Plugin", "code_sample": "" }, "@roblox/enum/CommandPermission.LocalUser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CommandPermission#LocalUser", "code_sample": "" }, "@roblox/global/Enum.CommandPermission": { "documentation": "", "keys": { "Plugin": "@roblox/enum/CommandPermission.Plugin", "LocalUser": "@roblox/enum/CommandPermission.LocalUser" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CommandPermission", "code_sample": "" }, "@roblox/enum/PartType.Ball": { "documentation": "A spherical shape.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PartType#Ball", "code_sample": "" }, "@roblox/enum/PartType.Block": { "documentation": "A block shape.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PartType#Block", "code_sample": "" }, "@roblox/enum/PartType.Cylinder": { "documentation": "A cylinder shape oriented along the X axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PartType#Cylinder", "code_sample": "" }, "@roblox/enum/PartType.Wedge": { "documentation": "A wedge shape with a slope on one side.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PartType#Wedge", "code_sample": "" }, "@roblox/enum/PartType.CornerWedge": { "documentation": "A wedge shape with slopes on two sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PartType#CornerWedge", "code_sample": "" }, "@roblox/global/Enum.PartType": { "documentation": "Controls the Part.Shape of an object.", "keys": { "Ball": "@roblox/enum/PartType.Ball", "Block": "@roblox/enum/PartType.Block", "Cylinder": "@roblox/enum/PartType.Cylinder", "Wedge": "@roblox/enum/PartType.Wedge", "CornerWedge": "@roblox/enum/PartType.CornerWedge" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PartType", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionStatus.Default": { "documentation": "Default status. Used for an undefined status.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Default", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionStatus.Begin": { "documentation": "Indicates the beginning of progression.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Begin", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionStatus.Complete": { "documentation": "Indicates the progression completed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Complete", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionStatus.Abandon": { "documentation": "Indicates the progression abandoned.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Abandon", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionStatus.Fail": { "documentation": "Indicates the progression failed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus#Fail", "code_sample": "" }, "@roblox/global/Enum.AnalyticsProgressionStatus": { "documentation": "This enum is used as an argument in AnalyticsService:FirePlayerProgressionEvent() to describe the status of progression.", "keys": { "Default": "@roblox/enum/AnalyticsProgressionStatus.Default", "Begin": "@roblox/enum/AnalyticsProgressionStatus.Begin", "Complete": "@roblox/enum/AnalyticsProgressionStatus.Complete", "Abandon": "@roblox/enum/AnalyticsProgressionStatus.Abandon", "Fail": "@roblox/enum/AnalyticsProgressionStatus.Fail" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionStatus", "code_sample": "" }, "@roblox/enum/Platform.Windows": { "documentation": "The client is running on a Windows Operating System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#Windows", "code_sample": "" }, "@roblox/enum/Platform.OSX": { "documentation": "The client is running on OSX (Apple desktop).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#OSX", "code_sample": "" }, "@roblox/enum/Platform.IOS": { "documentation": "The client is running on IOS (Apple mobile).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#IOS", "code_sample": "" }, "@roblox/enum/Platform.Android": { "documentation": "The client is running on Android (Google mobile).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#Android", "code_sample": "" }, "@roblox/enum/Platform.XBoxOne": { "documentation": "The client is running on an XBox One (console).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#XBoxOne", "code_sample": "" }, "@roblox/enum/Platform.PS4": { "documentation": "The client is running on a PS4 (console).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#PS4", "code_sample": "" }, "@roblox/enum/Platform.PS3": { "documentation": "The client is running on a PS3 (console).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#PS3", "code_sample": "" }, "@roblox/enum/Platform.XBox360": { "documentation": "The client is running on an XBox 360 (console).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#XBox360", "code_sample": "" }, "@roblox/enum/Platform.WiiU": { "documentation": "The client is running on a Wii U (console).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#WiiU", "code_sample": "" }, "@roblox/enum/Platform.NX": { "documentation": "The client is running on an NX Operating System (Cisco Nexus).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#NX", "code_sample": "" }, "@roblox/enum/Platform.Ouya": { "documentation": "The client is running on an Ouya Operating System (Android-Based).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#Ouya", "code_sample": "" }, "@roblox/enum/Platform.AndroidTV": { "documentation": "The client is running on an Android TV.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#AndroidTV", "code_sample": "" }, "@roblox/enum/Platform.Chromecast": { "documentation": "The client is running on Chromecast.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#Chromecast", "code_sample": "" }, "@roblox/enum/Platform.Linux": { "documentation": "The client is running on a Linux Operating System (desktop).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#Linux", "code_sample": "" }, "@roblox/enum/Platform.SteamOS": { "documentation": "The client is running on Steam.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#SteamOS", "code_sample": "" }, "@roblox/enum/Platform.WebOS": { "documentation": "The client is running on WebOS.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#WebOS", "code_sample": "" }, "@roblox/enum/Platform.DOS": { "documentation": "The client is running on DOS.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#DOS", "code_sample": "" }, "@roblox/enum/Platform.BeOS": { "documentation": "The client is running on BeOS.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#BeOS", "code_sample": "" }, "@roblox/enum/Platform.UWP": { "documentation": "The client is running on UWP.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#UWP", "code_sample": "" }, "@roblox/enum/Platform.PS5": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#PS5", "code_sample": "" }, "@roblox/enum/Platform.MetaOS": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#MetaOS", "code_sample": "" }, "@roblox/enum/Platform.None": { "documentation": "The client's operating system is unknown.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform#None", "code_sample": "" }, "@roblox/global/Enum.Platform": { "documentation": "Host operating system of the client.", "keys": { "Windows": "@roblox/enum/Platform.Windows", "OSX": "@roblox/enum/Platform.OSX", "IOS": "@roblox/enum/Platform.IOS", "Android": "@roblox/enum/Platform.Android", "XBoxOne": "@roblox/enum/Platform.XBoxOne", "PS4": "@roblox/enum/Platform.PS4", "PS3": "@roblox/enum/Platform.PS3", "XBox360": "@roblox/enum/Platform.XBox360", "WiiU": "@roblox/enum/Platform.WiiU", "NX": "@roblox/enum/Platform.NX", "Ouya": "@roblox/enum/Platform.Ouya", "AndroidTV": "@roblox/enum/Platform.AndroidTV", "Chromecast": "@roblox/enum/Platform.Chromecast", "Linux": "@roblox/enum/Platform.Linux", "SteamOS": "@roblox/enum/Platform.SteamOS", "WebOS": "@roblox/enum/Platform.WebOS", "DOS": "@roblox/enum/Platform.DOS", "BeOS": "@roblox/enum/Platform.BeOS", "UWP": "@roblox/enum/Platform.UWP", "PS5": "@roblox/enum/Platform.PS5", "MetaOS": "@roblox/enum/Platform.MetaOS", "None": "@roblox/enum/Platform.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Platform", "code_sample": "" }, "@roblox/enum/HttpCompression.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCompression#None", "code_sample": "" }, "@roblox/enum/HttpCompression.Gzip": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCompression#Gzip", "code_sample": "" }, "@roblox/global/Enum.HttpCompression": { "documentation": "", "keys": { "None": "@roblox/enum/HttpCompression.None", "Gzip": "@roblox/enum/HttpCompression.Gzip" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpCompression", "code_sample": "" }, "@roblox/enum/SizeConstraint.RelativeXY": { "documentation": "The scale of X and Y are independent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SizeConstraint#RelativeXY", "code_sample": "" }, "@roblox/enum/SizeConstraint.RelativeXX": { "documentation": "The scale of X is shared with Y.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SizeConstraint#RelativeXX", "code_sample": "" }, "@roblox/enum/SizeConstraint.RelativeYY": { "documentation": "The scale of Y is shared with X.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SizeConstraint#RelativeYY", "code_sample": "" }, "@roblox/global/Enum.SizeConstraint": { "documentation": "Used to constrain the scale of a GUI object.", "keys": { "RelativeXY": "@roblox/enum/SizeConstraint.RelativeXY", "RelativeXX": "@roblox/enum/SizeConstraint.RelativeXX", "RelativeYY": "@roblox/enum/SizeConstraint.RelativeYY" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SizeConstraint", "code_sample": "" }, "@roblox/enum/AnnotationRequestStatus.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#Success", "code_sample": "" }, "@roblox/enum/AnnotationRequestStatus.Loading": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#Loading", "code_sample": "" }, "@roblox/enum/AnnotationRequestStatus.ErrorInternalFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#ErrorInternalFailure", "code_sample": "" }, "@roblox/enum/AnnotationRequestStatus.ErrorNotFound": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#ErrorNotFound", "code_sample": "" }, "@roblox/enum/AnnotationRequestStatus.ErrorModerated": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus#ErrorModerated", "code_sample": "" }, "@roblox/global/Enum.AnnotationRequestStatus": { "documentation": "", "keys": { "Success": "@roblox/enum/AnnotationRequestStatus.Success", "Loading": "@roblox/enum/AnnotationRequestStatus.Loading", "ErrorInternalFailure": "@roblox/enum/AnnotationRequestStatus.ErrorInternalFailure", "ErrorNotFound": "@roblox/enum/AnnotationRequestStatus.ErrorNotFound", "ErrorModerated": "@roblox/enum/AnnotationRequestStatus.ErrorModerated" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationRequestStatus", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Boolean": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Boolean", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.CFrame": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#CFrame", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Color3": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Color3", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Float": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Float", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Instance": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Instance", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Random": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Random", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Vector2": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Vector2", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.Vector3": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#Vector3", "code_sample": "" }, "@roblox/enum/StateObjectFieldType.INVALID": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType#INVALID", "code_sample": "" }, "@roblox/global/Enum.StateObjectFieldType": { "documentation": "", "keys": { "Boolean": "@roblox/enum/StateObjectFieldType.Boolean", "CFrame": "@roblox/enum/StateObjectFieldType.CFrame", "Color3": "@roblox/enum/StateObjectFieldType.Color3", "Float": "@roblox/enum/StateObjectFieldType.Float", "Instance": "@roblox/enum/StateObjectFieldType.Instance", "Random": "@roblox/enum/StateObjectFieldType.Random", "Vector2": "@roblox/enum/StateObjectFieldType.Vector2", "Vector3": "@roblox/enum/StateObjectFieldType.Vector3", "INVALID": "@roblox/enum/StateObjectFieldType.INVALID" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StateObjectFieldType", "code_sample": "" }, "@roblox/enum/FormFactor.Symmetric": { "documentation": "Increases by a rate of 1 along all axes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FormFactor#Symmetric", "code_sample": "" }, "@roblox/enum/FormFactor.Brick": { "documentation": "Increases by a rate of 1 along the x- and z- axes, 1.2 along the y-axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FormFactor#Brick", "code_sample": "" }, "@roblox/enum/FormFactor.Plate": { "documentation": "Increases by a rate of 1 along the x- and z- axes, 0.4 along the y-axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FormFactor#Plate", "code_sample": "" }, "@roblox/enum/FormFactor.Custom": { "documentation": "Increases by a rate as low as .001 along all axes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FormFactor#Custom", "code_sample": "" }, "@roblox/global/Enum.FormFactor": { "documentation": "", "keys": { "Symmetric": "@roblox/enum/FormFactor.Symmetric", "Brick": "@roblox/enum/FormFactor.Brick", "Plate": "@roblox/enum/FormFactor.Plate", "Custom": "@roblox/enum/FormFactor.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FormFactor", "code_sample": "" }, "@roblox/enum/AlphaMode.Overlay": { "documentation": "Overlays the ColorMap on top of the underlying part color based on the map's alpha channel. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlphaMode#Overlay", "code_sample": "" }, "@roblox/enum/AlphaMode.Transparency": { "documentation": "Uses the ColorMap alpha channel to control the transparency of the surface. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlphaMode#Transparency", "code_sample": "" }, "@roblox/enum/AlphaMode.TintMask": { "documentation": "Uses the ColorMap alpha channel to control the amount of SurfaceAppearance.Color tinting.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlphaMode#TintMask", "code_sample": "" }, "@roblox/global/Enum.AlphaMode": { "documentation": "Used by SurfaceAppearance.AlphaMode to determine how the alpha channel of the SurfaceAppearance.ColorMap of a SurfaceAppearance is used.", "keys": { "Overlay": "@roblox/enum/AlphaMode.Overlay", "Transparency": "@roblox/enum/AlphaMode.Transparency", "TintMask": "@roblox/enum/AlphaMode.TintMask" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AlphaMode", "code_sample": "" }, "@roblox/enum/ScrollBarInset.None": { "documentation": "The canvas will never be inset for the respective scroll bar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset#None", "code_sample": "" }, "@roblox/enum/ScrollBarInset.ScrollBar": { "documentation": "The canvas will only be inset if the respective scroll bar is showing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset#ScrollBar", "code_sample": "" }, "@roblox/enum/ScrollBarInset.Always": { "documentation": "The canvas will always be inset for the respective scroll bar, regardless of whether that scroll bar is showing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset#Always", "code_sample": "" }, "@roblox/global/Enum.ScrollBarInset": { "documentation": "This enum is used with ScrollingFrame.HorizontalScrollBarInset and ScrollingFrame.VerticalScrollBarInset to indicate whether the canvas should be inset by ScrollBarThickness for the respective scroll bar.", "keys": { "None": "@roblox/enum/ScrollBarInset.None", "ScrollBar": "@roblox/enum/ScrollBarInset.ScrollBar", "Always": "@roblox/enum/ScrollBarInset.Always" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollBarInset", "code_sample": "" }, "@roblox/enum/AvatarSettingsCustomClothingMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomClothingMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsCustomClothingMode.CustomClothing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomClothingMode#CustomClothing", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsCustomClothingMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsCustomClothingMode.PlayerChoice", "CustomClothing": "@roblox/enum/AvatarSettingsCustomClothingMode.CustomClothing" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomClothingMode", "code_sample": "" }, "@roblox/enum/AudioSimulationFidelity.None": { "documentation": "No acoustic simulation occurs; only direction and distance are taken into account.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioSimulationFidelity#None", "code_sample": "" }, "@roblox/enum/AudioSimulationFidelity.Automatic": { "documentation": "The audio engine simulates transmission, diffraction, and reflections at a level of detail suitable to most devices.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioSimulationFidelity#Automatic", "code_sample": "" }, "@roblox/global/Enum.AudioSimulationFidelity": { "documentation": "Enum which determines how detailed audio simulation should be for AudioEmitters and AudioListeners.", "keys": { "None": "@roblox/enum/AudioSimulationFidelity.None", "Automatic": "@roblox/enum/AudioSimulationFidelity.Automatic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioSimulationFidelity", "code_sample": "" }, "@roblox/enum/ParticleEmitterShape.Box": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShape#Box", "code_sample": "" }, "@roblox/enum/ParticleEmitterShape.Sphere": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShape#Sphere", "code_sample": "" }, "@roblox/enum/ParticleEmitterShape.Cylinder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShape#Cylinder", "code_sample": "" }, "@roblox/enum/ParticleEmitterShape.Disc": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShape#Disc", "code_sample": "" }, "@roblox/global/Enum.ParticleEmitterShape": { "documentation": "", "keys": { "Box": "@roblox/enum/ParticleEmitterShape.Box", "Sphere": "@roblox/enum/ParticleEmitterShape.Sphere", "Cylinder": "@roblox/enum/ParticleEmitterShape.Cylinder", "Disc": "@roblox/enum/ParticleEmitterShape.Disc" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShape", "code_sample": "" }, "@roblox/enum/CaptureGalleryPermission.ReadAndUpload": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CaptureGalleryPermission#ReadAndUpload", "code_sample": "" }, "@roblox/global/Enum.CaptureGalleryPermission": { "documentation": "", "keys": { "ReadAndUpload": "@roblox/enum/CaptureGalleryPermission.ReadAndUpload" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CaptureGalleryPermission", "code_sample": "" }, "@roblox/enum/RaycastFilterType.Exclude": { "documentation": "Every BasePart in the raycast operation will be considered except those that are descendants of objects in the filter list.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RaycastFilterType#Exclude", "code_sample": "" }, "@roblox/enum/RaycastFilterType.Include": { "documentation": "Only BaseParts which are descendants of objects in the filter list will be considered in the raycast operation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RaycastFilterType#Include", "code_sample": "" }, "@roblox/global/Enum.RaycastFilterType": { "documentation": "Used in a RaycastParams object to determine how its FilterDescendantsInstances list will be used.", "keys": { "Exclude": "@roblox/enum/RaycastFilterType.Exclude", "Include": "@roblox/enum/RaycastFilterType.Include" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RaycastFilterType", "code_sample": "" }, "@roblox/enum/PoseEasingStyle.Linear": { "documentation": "Poses interpolate linearly between key frames.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle#Linear", "code_sample": "" }, "@roblox/enum/PoseEasingStyle.Constant": { "documentation": "Poses do not interpolate but snap to the key frame indicated by the PoseEasingDirection.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle#Constant", "code_sample": "" }, "@roblox/enum/PoseEasingStyle.Elastic": { "documentation": "Pose interpolation will overshoot like it is elastic.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle#Elastic", "code_sample": "" }, "@roblox/enum/PoseEasingStyle.Cubic": { "documentation": "Deprecated - Use PoseEasingStyle.CubicV2. Pose interpolation is a cubic curve between keyframes based on the PoseEasingDirection.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle#Cubic", "code_sample": "" }, "@roblox/enum/PoseEasingStyle.Bounce": { "documentation": "Pose interpolation produces a bounce like effect between key frames.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle#Bounce", "code_sample": "" }, "@roblox/enum/PoseEasingStyle.CubicV2": { "documentation": "Pose interpolation is a cubic curve between keyframes based on PoseEasingDirection.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle#CubicV2", "code_sample": "" }, "@roblox/global/Enum.PoseEasingStyle": { "documentation": "", "keys": { "Linear": "@roblox/enum/PoseEasingStyle.Linear", "Constant": "@roblox/enum/PoseEasingStyle.Constant", "Elastic": "@roblox/enum/PoseEasingStyle.Elastic", "Cubic": "@roblox/enum/PoseEasingStyle.Cubic", "Bounce": "@roblox/enum/PoseEasingStyle.Bounce", "CubicV2": "@roblox/enum/PoseEasingStyle.CubicV2" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingStyle", "code_sample": "" }, "@roblox/enum/ImageCombineType.BlendSourceOver": { "documentation": "Blends pixels from the source with pixels from the destination using source over alpha blending.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageCombineType#BlendSourceOver", "code_sample": "" }, "@roblox/enum/ImageCombineType.Overwrite": { "documentation": "Overwrites all pixels in the destination image with pixels from the source image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageCombineType#Overwrite", "code_sample": "" }, "@roblox/enum/ImageCombineType.Add": { "documentation": "Adds pixels from the source and pixels from the destination together.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageCombineType#Add", "code_sample": "" }, "@roblox/enum/ImageCombineType.Multiply": { "documentation": "Multiplies pixels from the source and pixels from the destination together. RGBA values are multiplied as values between 0 and 1. Values lower than 1 have a darkening effect on the image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageCombineType#Multiply", "code_sample": "" }, "@roblox/enum/ImageCombineType.AlphaBlend": { "documentation": "Blends pixels from the source with pixels from the destination based on the alpha of the source pixels. Unlike BlendSourceOver, the destination color in AlphaBlend affects the resulting color of the image, regardless of the destination color's alpha.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageCombineType#AlphaBlend", "code_sample": "" }, "@roblox/global/Enum.ImageCombineType": { "documentation": "Enum for determining how two images are combined together.", "keys": { "BlendSourceOver": "@roblox/enum/ImageCombineType.BlendSourceOver", "Overwrite": "@roblox/enum/ImageCombineType.Overwrite", "Add": "@roblox/enum/ImageCombineType.Add", "Multiply": "@roblox/enum/ImageCombineType.Multiply", "AlphaBlend": "@roblox/enum/ImageCombineType.AlphaBlend" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageCombineType", "code_sample": "" }, "@roblox/enum/MarketplaceBulkPurchasePromptStatus.Completed": { "documentation": "User confirmed the purchase and the transaction has been processed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceBulkPurchasePromptStatus#Completed", "code_sample": "" }, "@roblox/enum/MarketplaceBulkPurchasePromptStatus.Aborted": { "documentation": "User closed the prompt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceBulkPurchasePromptStatus#Aborted", "code_sample": "" }, "@roblox/enum/MarketplaceBulkPurchasePromptStatus.Error": { "documentation": "User confirmed the purchase, but the transaction cannot be sent to the backend for processing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceBulkPurchasePromptStatus#Error", "code_sample": "" }, "@roblox/global/Enum.MarketplaceBulkPurchasePromptStatus": { "documentation": "The status of the BulkPurchasePrompt after player interaction.", "keys": { "Completed": "@roblox/enum/MarketplaceBulkPurchasePromptStatus.Completed", "Aborted": "@roblox/enum/MarketplaceBulkPurchasePromptStatus.Aborted", "Error": "@roblox/enum/MarketplaceBulkPurchasePromptStatus.Error" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceBulkPurchasePromptStatus", "code_sample": "" }, "@roblox/enum/UIDragDetectorBoundingBehavior.Automatic": { "documentation": "Mimics EntireObject behavior for a UI object that's entirely contained by the BoundingUI, or else HitPoint for a UI object that's partially outside the BoundingUI.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorBoundingBehavior#Automatic", "code_sample": "" }, "@roblox/enum/UIDragDetectorBoundingBehavior.EntireObject": { "documentation": "Bounds the entire dragged UI object within the BoundingUI.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorBoundingBehavior#EntireObject", "code_sample": "" }, "@roblox/enum/UIDragDetectorBoundingBehavior.HitPoint": { "documentation": "Bounds the dragged UI only by the exact hit/grab point and its respective position after translation/rotation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorBoundingBehavior#HitPoint", "code_sample": "" }, "@roblox/global/Enum.UIDragDetectorBoundingBehavior": { "documentation": "Used with UIDragDetector to determine bounding behavior of the dragged UI object when UIDragDetector.BoundingUI is set.", "keys": { "Automatic": "@roblox/enum/UIDragDetectorBoundingBehavior.Automatic", "EntireObject": "@roblox/enum/UIDragDetectorBoundingBehavior.EntireObject", "HitPoint": "@roblox/enum/UIDragDetectorBoundingBehavior.HitPoint" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorBoundingBehavior", "code_sample": "" }, "@roblox/enum/ServerLiveEditingMode.Uninitialized": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServerLiveEditingMode#Uninitialized", "code_sample": "" }, "@roblox/enum/ServerLiveEditingMode.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServerLiveEditingMode#Enabled", "code_sample": "" }, "@roblox/enum/ServerLiveEditingMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServerLiveEditingMode#Disabled", "code_sample": "" }, "@roblox/global/Enum.ServerLiveEditingMode": { "documentation": "", "keys": { "Uninitialized": "@roblox/enum/ServerLiveEditingMode.Uninitialized", "Enabled": "@roblox/enum/ServerLiveEditingMode.Enabled", "Disabled": "@roblox/enum/ServerLiveEditingMode.Disabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServerLiveEditingMode", "code_sample": "" }, "@roblox/enum/RecommendationDepartureIntent.Neutral": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationDepartureIntent#Neutral", "code_sample": "" }, "@roblox/enum/RecommendationDepartureIntent.Positive": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationDepartureIntent#Positive", "code_sample": "" }, "@roblox/enum/RecommendationDepartureIntent.Negative": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationDepartureIntent#Negative", "code_sample": "" }, "@roblox/global/Enum.RecommendationDepartureIntent": { "documentation": "", "keys": { "Neutral": "@roblox/enum/RecommendationDepartureIntent.Neutral", "Positive": "@roblox/enum/RecommendationDepartureIntent.Positive", "Negative": "@roblox/enum/RecommendationDepartureIntent.Negative" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationDepartureIntent", "code_sample": "" }, "@roblox/enum/RecommendationItemContentType.Static": { "documentation": "The item is static, such as an image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemContentType#Static", "code_sample": "" }, "@roblox/enum/RecommendationItemContentType.Dynamic": { "documentation": "The item is dynamic; for example, it is a video.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemContentType#Dynamic", "code_sample": "" }, "@roblox/enum/RecommendationItemContentType.Interactive": { "documentation": "The item is interactive, such as a 3D model or a mini-game.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemContentType#Interactive", "code_sample": "" }, "@roblox/global/Enum.RecommendationItemContentType": { "documentation": "", "keys": { "Static": "@roblox/enum/RecommendationItemContentType.Static", "Dynamic": "@roblox/enum/RecommendationItemContentType.Dynamic", "Interactive": "@roblox/enum/RecommendationItemContentType.Interactive" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationItemContentType", "code_sample": "" }, "@roblox/enum/CompileTarget.Client": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompileTarget#Client", "code_sample": "" }, "@roblox/enum/CompileTarget.CoreScript": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompileTarget#CoreScript", "code_sample": "" }, "@roblox/enum/CompileTarget.Studio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompileTarget#Studio", "code_sample": "" }, "@roblox/enum/CompileTarget.CoreScriptRaw": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompileTarget#CoreScriptRaw", "code_sample": "" }, "@roblox/global/Enum.CompileTarget": { "documentation": "", "keys": { "Client": "@roblox/enum/CompileTarget.Client", "CoreScript": "@roblox/enum/CompileTarget.CoreScript", "Studio": "@roblox/enum/CompileTarget.Studio", "CoreScriptRaw": "@roblox/enum/CompileTarget.CoreScriptRaw" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompileTarget", "code_sample": "" }, "@roblox/enum/MeshPartHeadsAndAccessories.Default": { "documentation": "The default option to control the Workspace.MeshPartHeadsAndAccessories feature. This currently has the same meaning as \"Enabled\".", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartHeadsAndAccessories#Default", "code_sample": "" }, "@roblox/enum/MeshPartHeadsAndAccessories.Disabled": { "documentation": "Disables the Workspace.MeshPartHeadsAndAccessories feature.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartHeadsAndAccessories#Disabled", "code_sample": "" }, "@roblox/enum/MeshPartHeadsAndAccessories.Enabled": { "documentation": "Enables the Workspace.MeshPartHeadsAndAccessories feature.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartHeadsAndAccessories#Enabled", "code_sample": "" }, "@roblox/global/Enum.MeshPartHeadsAndAccessories": { "documentation": "Controls the Workspace.MeshPartHeadsAndAccessories feature.", "keys": { "Default": "@roblox/enum/MeshPartHeadsAndAccessories.Default", "Disabled": "@roblox/enum/MeshPartHeadsAndAccessories.Disabled", "Enabled": "@roblox/enum/MeshPartHeadsAndAccessories.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartHeadsAndAccessories", "code_sample": "" }, "@roblox/enum/VideoCaptureStartedResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureStartedResult#Success", "code_sample": "" }, "@roblox/enum/VideoCaptureStartedResult.OtherError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureStartedResult#OtherError", "code_sample": "" }, "@roblox/enum/VideoCaptureStartedResult.CapturingAlready": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureStartedResult#CapturingAlready", "code_sample": "" }, "@roblox/enum/VideoCaptureStartedResult.NoDeviceSupport": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureStartedResult#NoDeviceSupport", "code_sample": "" }, "@roblox/enum/VideoCaptureStartedResult.NoSpaceOnDevice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureStartedResult#NoSpaceOnDevice", "code_sample": "" }, "@roblox/global/Enum.VideoCaptureStartedResult": { "documentation": "", "keys": { "Success": "@roblox/enum/VideoCaptureStartedResult.Success", "OtherError": "@roblox/enum/VideoCaptureStartedResult.OtherError", "CapturingAlready": "@roblox/enum/VideoCaptureStartedResult.CapturingAlready", "NoDeviceSupport": "@roblox/enum/VideoCaptureStartedResult.NoDeviceSupport", "NoSpaceOnDevice": "@roblox/enum/VideoCaptureStartedResult.NoSpaceOnDevice" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureStartedResult", "code_sample": "" }, "@roblox/enum/ScreenOrientation.LandscapeLeft": { "documentation": "A preference where the game is displayed landscape (horizontally) with the bottom of the device on the left side of the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenOrientation#LandscapeLeft", "code_sample": "" }, "@roblox/enum/ScreenOrientation.LandscapeRight": { "documentation": "A preference where the game is displayed landscape (horizontally) with the bottom of the device on the right side of the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenOrientation#LandscapeRight", "code_sample": "" }, "@roblox/enum/ScreenOrientation.LandscapeSensor": { "documentation": "A preference where the game is displayed landscape (horizontally) with the bottom of the device on the left of right side of the screen depending on the device's orientation (the sensor determines which side allows for the game to be displayed right-side-up).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenOrientation#LandscapeSensor", "code_sample": "" }, "@roblox/enum/ScreenOrientation.Portrait": { "documentation": "A preference where the game is displayed portrait (vertically) with the bottom of the device on the bottom of the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenOrientation#Portrait", "code_sample": "" }, "@roblox/enum/ScreenOrientation.Sensor": { "documentation": "A preference where the game is displayed depending on the best match to the device's current orientation - either landscape (left/right) or portrait.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenOrientation#Sensor", "code_sample": "" }, "@roblox/global/Enum.ScreenOrientation": { "documentation": "The preference of in-game screen orientation on hand-held devices.", "keys": { "LandscapeLeft": "@roblox/enum/ScreenOrientation.LandscapeLeft", "LandscapeRight": "@roblox/enum/ScreenOrientation.LandscapeRight", "LandscapeSensor": "@roblox/enum/ScreenOrientation.LandscapeSensor", "Portrait": "@roblox/enum/ScreenOrientation.Portrait", "Sensor": "@roblox/enum/ScreenOrientation.Sensor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenOrientation", "code_sample": "" }, "@roblox/enum/AdornCullingMode.Automatic": { "documentation": "Automatically culls adornment based on distance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdornCullingMode#Automatic", "code_sample": "" }, "@roblox/enum/AdornCullingMode.Never": { "documentation": "Never culls adornment. Adornment is always visible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdornCullingMode#Never", "code_sample": "" }, "@roblox/global/Enum.AdornCullingMode": { "documentation": "Culling method used for adornments.", "keys": { "Automatic": "@roblox/enum/AdornCullingMode.Automatic", "Never": "@roblox/enum/AdornCullingMode.Never" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdornCullingMode", "code_sample": "" }, "@roblox/enum/Style.AlternatingSupports": { "documentation": "Truss beams contain alternating supports.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Style#AlternatingSupports", "code_sample": "" }, "@roblox/enum/Style.BridgeStyleSupports": { "documentation": "Truss beams contain bridge style supports.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Style#BridgeStyleSupports", "code_sample": "" }, "@roblox/enum/Style.NoSupports": { "documentation": "Truss beams do not contain supports.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Style#NoSupports", "code_sample": "" }, "@roblox/global/Enum.Style": { "documentation": "The Style Enum is used to set what style of supports the TrussPart has.", "keys": { "AlternatingSupports": "@roblox/enum/Style.AlternatingSupports", "BridgeStyleSupports": "@roblox/enum/Style.BridgeStyleSupports", "NoSupports": "@roblox/enum/Style.NoSupports" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Style", "code_sample": "" }, "@roblox/enum/HashAlgorithm.Blake2b": { "documentation": "Used to compute a 256-bit (32-byte) hash digest using the BLAKE2b algorithm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HashAlgorithm#Blake2b", "code_sample": "" }, "@roblox/enum/HashAlgorithm.Blake3": { "documentation": "Used to compute a 256-bit (32-byte) hash digest using the BLAKE3 algorithm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HashAlgorithm#Blake3", "code_sample": "" }, "@roblox/enum/HashAlgorithm.Md5": { "documentation": "Used to compute a 128-bit (16-byte) hash digest using the MD5 algorithm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HashAlgorithm#Md5", "code_sample": "" }, "@roblox/enum/HashAlgorithm.Sha1": { "documentation": "Used to compute a 160-bit (20-byte) hash digest using the SHA-1 algorithm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HashAlgorithm#Sha1", "code_sample": "" }, "@roblox/enum/HashAlgorithm.Sha256": { "documentation": "Used to compute a 256-bit (32-byte) hash digest using the SHA256 algorithm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HashAlgorithm#Sha256", "code_sample": "" }, "@roblox/global/Enum.HashAlgorithm": { "documentation": "A Cryptographic hash function to use in EncodingService methods.", "keys": { "Blake2b": "@roblox/enum/HashAlgorithm.Blake2b", "Blake3": "@roblox/enum/HashAlgorithm.Blake3", "Md5": "@roblox/enum/HashAlgorithm.Md5", "Sha1": "@roblox/enum/HashAlgorithm.Sha1", "Sha256": "@roblox/enum/HashAlgorithm.Sha256" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HashAlgorithm", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.DefaultAuto": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#DefaultAuto", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Disabled", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.Always": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Always", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.Skip2": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip2", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.Skip4": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip4", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.Skip8": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip8", "code_sample": "" }, "@roblox/enum/EnviromentalPhysicsThrottle.Skip16": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle#Skip16", "code_sample": "" }, "@roblox/global/Enum.EnviromentalPhysicsThrottle": { "documentation": "", "keys": { "DefaultAuto": "@roblox/enum/EnviromentalPhysicsThrottle.DefaultAuto", "Disabled": "@roblox/enum/EnviromentalPhysicsThrottle.Disabled", "Always": "@roblox/enum/EnviromentalPhysicsThrottle.Always", "Skip2": "@roblox/enum/EnviromentalPhysicsThrottle.Skip2", "Skip4": "@roblox/enum/EnviromentalPhysicsThrottle.Skip4", "Skip8": "@roblox/enum/EnviromentalPhysicsThrottle.Skip8", "Skip16": "@roblox/enum/EnviromentalPhysicsThrottle.Skip16" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EnviromentalPhysicsThrottle", "code_sample": "" }, "@roblox/enum/PredictionStatus.Authoritative": { "documentation": "This instance is authoritative.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionStatus#Authoritative", "code_sample": "" }, "@roblox/enum/PredictionStatus.Predicted": { "documentation": "This instance is being predicted.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionStatus#Predicted", "code_sample": "" }, "@roblox/enum/PredictionStatus.None": { "documentation": "The instance will not be resimulated; classic simulation rules apply instead.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionStatus#None", "code_sample": "" }, "@roblox/global/Enum.PredictionStatus": { "documentation": "Enum used with RunService:GetPredictionStatus() to check the status of a specific instance.", "keys": { "Authoritative": "@roblox/enum/PredictionStatus.Authoritative", "Predicted": "@roblox/enum/PredictionStatus.Predicted", "None": "@roblox/enum/PredictionStatus.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionStatus", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.GetAsync": { "documentation": "Refers to GetAsync() and the read of UpdateAsync().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#GetAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.SetIncrementAsync": { "documentation": "Refers to SetAsync(), IncrementAsync(), RemoveAsync(), and the write of UpdateAsync() when it returns a non-nil value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#SetIncrementAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.UpdateAsync": { "documentation": "Refers to UpdateAsync().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#UpdateAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.GetSortedAsync": { "documentation": "Refers to GetSortedAsync().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#GetSortedAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.SetIncrementSortedAsync": { "documentation": "Refers to SetAsync() IncrementAsync(), RemoveAsync(), and the write of UpdateAsync() while using an OrderedDataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#SetIncrementSortedAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.OnUpdate": { "documentation": "Refers to OnUpdate().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OnUpdate", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.ListAsync": { "documentation": "Refers to ListKeysAsync() and ListVersionsAsync().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#ListAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.GetVersionAsync": { "documentation": "Refers to GetVersionAsync().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#GetVersionAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.RemoveVersionAsync": { "documentation": "Refers to RemoveVersionAsync().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#RemoveVersionAsync", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.StandardRead": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to GetAsync(), GetVersionAsync(), GetVersionAtTimeAsync(), and the read of UpdateAsync() for DataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardRead", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.StandardWrite": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to SetAsync(), IncrementAsync(), and the write of UpdateAsync() for DataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardWrite", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.StandardList": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to ListDataStoresAsync(), and ListKeysAsync() and ListVersionsAsync() for DataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardList", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.StandardRemove": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to RemoveAsync() for DataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#StandardRemove", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.OrderedRead": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to GetAsync() and the read of UpdateAsync() for OrderedDataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedRead", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.OrderedWrite": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to SetAsync(), IncrementAsync(), and the write of UpdateAsync() for OrderedDataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedWrite", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.OrderedList": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to GetSortedAsync() for OrderedDataStore. GetRequestBudgetForRequestType()with this enum will return0`.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedList", "code_sample": "" }, "@roblox/enum/DataStoreRequestType.OrderedRemove": { "documentation": "This request type is not yet active, GetRequestBudgetForRequestType() with this enum will return 0.

Refers to RemoveAsync() for OrderedDataStore.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType#OrderedRemove", "code_sample": "" }, "@roblox/global/Enum.DataStoreRequestType": { "documentation": "Indicates the type of data store request being made.", "keys": { "GetAsync": "@roblox/enum/DataStoreRequestType.GetAsync", "SetIncrementAsync": "@roblox/enum/DataStoreRequestType.SetIncrementAsync", "UpdateAsync": "@roblox/enum/DataStoreRequestType.UpdateAsync", "GetSortedAsync": "@roblox/enum/DataStoreRequestType.GetSortedAsync", "SetIncrementSortedAsync": "@roblox/enum/DataStoreRequestType.SetIncrementSortedAsync", "OnUpdate": "@roblox/enum/DataStoreRequestType.OnUpdate", "ListAsync": "@roblox/enum/DataStoreRequestType.ListAsync", "GetVersionAsync": "@roblox/enum/DataStoreRequestType.GetVersionAsync", "RemoveVersionAsync": "@roblox/enum/DataStoreRequestType.RemoveVersionAsync", "StandardRead": "@roblox/enum/DataStoreRequestType.StandardRead", "StandardWrite": "@roblox/enum/DataStoreRequestType.StandardWrite", "StandardList": "@roblox/enum/DataStoreRequestType.StandardList", "StandardRemove": "@roblox/enum/DataStoreRequestType.StandardRemove", "OrderedRead": "@roblox/enum/DataStoreRequestType.OrderedRead", "OrderedWrite": "@roblox/enum/DataStoreRequestType.OrderedWrite", "OrderedList": "@roblox/enum/DataStoreRequestType.OrderedList", "OrderedRemove": "@roblox/enum/DataStoreRequestType.OrderedRemove" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DataStoreRequestType", "code_sample": "" }, "@roblox/enum/NotificationButtonType.Primary": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NotificationButtonType#Primary", "code_sample": "" }, "@roblox/enum/NotificationButtonType.Secondary": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NotificationButtonType#Secondary", "code_sample": "" }, "@roblox/global/Enum.NotificationButtonType": { "documentation": "", "keys": { "Primary": "@roblox/enum/NotificationButtonType.Primary", "Secondary": "@roblox/enum/NotificationButtonType.Secondary" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NotificationButtonType", "code_sample": "" }, "@roblox/enum/DebuggerStatus.Success": { "documentation": "Request has completed successfully.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#Success", "code_sample": "" }, "@roblox/enum/DebuggerStatus.Timeout": { "documentation": "Timed out while waiting for response.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#Timeout", "code_sample": "" }, "@roblox/enum/DebuggerStatus.ConnectionLost": { "documentation": "Connection to the debugger was lost.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#ConnectionLost", "code_sample": "" }, "@roblox/enum/DebuggerStatus.InvalidResponse": { "documentation": "Failed to parse response.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InvalidResponse", "code_sample": "" }, "@roblox/enum/DebuggerStatus.InternalError": { "documentation": "Exception encountered while processing response.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InternalError", "code_sample": "" }, "@roblox/enum/DebuggerStatus.InvalidState": { "documentation": "The request was not appropriate for the current debugger state.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InvalidState", "code_sample": "" }, "@roblox/enum/DebuggerStatus.RpcError": { "documentation": "Response was an error.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#RpcError", "code_sample": "" }, "@roblox/enum/DebuggerStatus.InvalidArgument": { "documentation": "One of the request arguments was invalid.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#InvalidArgument", "code_sample": "" }, "@roblox/enum/DebuggerStatus.ConnectionClosed": { "documentation": "Connection closed while waiting for response.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus#ConnectionClosed", "code_sample": "" }, "@roblox/global/Enum.DebuggerStatus": { "documentation": "Result of a debugger request.", "keys": { "Success": "@roblox/enum/DebuggerStatus.Success", "Timeout": "@roblox/enum/DebuggerStatus.Timeout", "ConnectionLost": "@roblox/enum/DebuggerStatus.ConnectionLost", "InvalidResponse": "@roblox/enum/DebuggerStatus.InvalidResponse", "InternalError": "@roblox/enum/DebuggerStatus.InternalError", "InvalidState": "@roblox/enum/DebuggerStatus.InvalidState", "RpcError": "@roblox/enum/DebuggerStatus.RpcError", "InvalidArgument": "@roblox/enum/DebuggerStatus.InvalidArgument", "ConnectionClosed": "@roblox/enum/DebuggerStatus.ConnectionClosed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerStatus", "code_sample": "" }, "@roblox/enum/HighlightDepthMode.AlwaysOnTop": { "documentation": "Allows the Highlight to display regardless if there are objects between the camera and the highlighted object. This means the viewer is always able to see the highlight regardless of what is between the highlighted object and the camera. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HighlightDepthMode#AlwaysOnTop", "code_sample": "" }, "@roblox/enum/HighlightDepthMode.Occluded": { "documentation": "Hides the Highlight if there are objects between the camera and the highlighted object. This means the viewer is only able to see the object if there are no obstructing objects between the highlighted object and the camera's view. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HighlightDepthMode#Occluded", "code_sample": "" }, "@roblox/global/Enum.HighlightDepthMode": { "documentation": "Controls how the Highlight effect displays with respect to other objects in the world.", "keys": { "AlwaysOnTop": "@roblox/enum/HighlightDepthMode.AlwaysOnTop", "Occluded": "@roblox/enum/HighlightDepthMode.Occluded" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HighlightDepthMode", "code_sample": "" }, "@roblox/enum/CenterDialogType.UnsolicitedDialog": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#UnsolicitedDialog", "code_sample": "" }, "@roblox/enum/CenterDialogType.PlayerInitiatedDialog": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#PlayerInitiatedDialog", "code_sample": "" }, "@roblox/enum/CenterDialogType.ModalDialog": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#ModalDialog", "code_sample": "" }, "@roblox/enum/CenterDialogType.QuitDialog": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CenterDialogType#QuitDialog", "code_sample": "" }, "@roblox/global/Enum.CenterDialogType": { "documentation": "", "keys": { "UnsolicitedDialog": "@roblox/enum/CenterDialogType.UnsolicitedDialog", "PlayerInitiatedDialog": "@roblox/enum/CenterDialogType.PlayerInitiatedDialog", "ModalDialog": "@roblox/enum/CenterDialogType.ModalDialog", "QuitDialog": "@roblox/enum/CenterDialogType.QuitDialog" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CenterDialogType", "code_sample": "" }, "@roblox/enum/AnalyticsLogLevel.Trace": { "documentation": "Trace is the noisiest level, rarely (if ever) enabled for a production app.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Trace", "code_sample": "" }, "@roblox/enum/AnalyticsLogLevel.Debug": { "documentation": "Used for debugging.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Debug", "code_sample": "" }, "@roblox/enum/AnalyticsLogLevel.Information": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Information", "code_sample": "" }, "@roblox/enum/AnalyticsLogLevel.Warning": { "documentation": "Used for warning.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Warning", "code_sample": "" }, "@roblox/enum/AnalyticsLogLevel.Error": { "documentation": "When functionality is unavailable or expectations broken.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Error", "code_sample": "" }, "@roblox/enum/AnalyticsLogLevel.Fatal": { "documentation": "The most critical level, Fatal events demand immediate attention.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel#Fatal", "code_sample": "" }, "@roblox/global/Enum.AnalyticsLogLevel": { "documentation": "", "keys": { "Trace": "@roblox/enum/AnalyticsLogLevel.Trace", "Debug": "@roblox/enum/AnalyticsLogLevel.Debug", "Information": "@roblox/enum/AnalyticsLogLevel.Information", "Warning": "@roblox/enum/AnalyticsLogLevel.Warning", "Error": "@roblox/enum/AnalyticsLogLevel.Error", "Fatal": "@roblox/enum/AnalyticsLogLevel.Fatal" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsLogLevel", "code_sample": "" }, "@roblox/enum/LiveEditingBroadcastMessageType.Normal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingBroadcastMessageType#Normal", "code_sample": "" }, "@roblox/enum/LiveEditingBroadcastMessageType.Warning": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingBroadcastMessageType#Warning", "code_sample": "" }, "@roblox/enum/LiveEditingBroadcastMessageType.Error": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingBroadcastMessageType#Error", "code_sample": "" }, "@roblox/global/Enum.LiveEditingBroadcastMessageType": { "documentation": "", "keys": { "Normal": "@roblox/enum/LiveEditingBroadcastMessageType.Normal", "Warning": "@roblox/enum/LiveEditingBroadcastMessageType.Warning", "Error": "@roblox/enum/LiveEditingBroadcastMessageType.Error" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingBroadcastMessageType", "code_sample": "" }, "@roblox/enum/Technology.Legacy": { "documentation": "Deprecated: This option is deprecated and cannot be selected in Studio.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology#Legacy", "code_sample": "" }, "@roblox/enum/Technology.Voxel": { "documentation": "Uses a 4×4×4 voxel map for light and shadow calculation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology#Voxel", "code_sample": "" }, "@roblox/enum/Technology.Compatibility": { "documentation": "Simulates the removed legacy technology and is now deprecated. To achieve a similar look, use Voxel Lighting and add a ColorGradingEffect post‑processing effect set to the Retro preset.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology#Compatibility", "code_sample": "" }, "@roblox/enum/Technology.ShadowMap": { "documentation": "Features shadow mapping that produces more realistic and crisp shadows from sunlight or directional light sources.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology#ShadowMap", "code_sample": "" }, "@roblox/enum/Technology.Future": { "documentation": "Features the most advanced technology for high-fidelity lighting and shadows.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology#Future", "code_sample": "" }, "@roblox/enum/Technology.Unified": { "documentation": "Deprecated: This option is deprecated and cannot be selected in Studio.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology#Unified", "code_sample": "" }, "@roblox/global/Enum.Technology": { "documentation": "Enum used by Lighting.Technology to represent the different lighting systems available for rendering the 3D world.", "keys": { "Legacy": "@roblox/enum/Technology.Legacy", "Voxel": "@roblox/enum/Technology.Voxel", "Compatibility": "@roblox/enum/Technology.Compatibility", "ShadowMap": "@roblox/enum/Technology.ShadowMap", "Future": "@roblox/enum/Technology.Future", "Unified": "@roblox/enum/Technology.Unified" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Technology", "code_sample": "" }, "@roblox/enum/TextFilterContext.PublicChat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextFilterContext#PublicChat", "code_sample": "" }, "@roblox/enum/TextFilterContext.PrivateChat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextFilterContext#PrivateChat", "code_sample": "" }, "@roblox/global/Enum.TextFilterContext": { "documentation": "", "keys": { "PublicChat": "@roblox/enum/TextFilterContext.PublicChat", "PrivateChat": "@roblox/enum/TextFilterContext.PrivateChat" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextFilterContext", "code_sample": "" }, "@roblox/enum/RejectCharacterDeletions.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RejectCharacterDeletions#Default", "code_sample": "" }, "@roblox/enum/RejectCharacterDeletions.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RejectCharacterDeletions#Disabled", "code_sample": "" }, "@roblox/enum/RejectCharacterDeletions.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RejectCharacterDeletions#Enabled", "code_sample": "" }, "@roblox/global/Enum.RejectCharacterDeletions": { "documentation": "", "keys": { "Default": "@roblox/enum/RejectCharacterDeletions.Default", "Disabled": "@roblox/enum/RejectCharacterDeletions.Disabled", "Enabled": "@roblox/enum/RejectCharacterDeletions.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RejectCharacterDeletions", "code_sample": "" }, "@roblox/enum/RibbonTool.Select": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Select", "code_sample": "" }, "@roblox/enum/RibbonTool.Scale": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Scale", "code_sample": "" }, "@roblox/enum/RibbonTool.Rotate": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Rotate", "code_sample": "" }, "@roblox/enum/RibbonTool.Move": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Move", "code_sample": "" }, "@roblox/enum/RibbonTool.Transform": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Transform", "code_sample": "" }, "@roblox/enum/RibbonTool.ColorPicker": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#ColorPicker", "code_sample": "" }, "@roblox/enum/RibbonTool.MaterialPicker": { "documentation": "Deprecated in favor of Material Manager. Don't use.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#MaterialPicker", "code_sample": "" }, "@roblox/enum/RibbonTool.Group": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Group", "code_sample": "" }, "@roblox/enum/RibbonTool.Ungroup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#Ungroup", "code_sample": "" }, "@roblox/enum/RibbonTool.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#None", "code_sample": "" }, "@roblox/enum/RibbonTool.PivotEditor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool#PivotEditor", "code_sample": "" }, "@roblox/global/Enum.RibbonTool": { "documentation": "", "keys": { "Select": "@roblox/enum/RibbonTool.Select", "Scale": "@roblox/enum/RibbonTool.Scale", "Rotate": "@roblox/enum/RibbonTool.Rotate", "Move": "@roblox/enum/RibbonTool.Move", "Transform": "@roblox/enum/RibbonTool.Transform", "ColorPicker": "@roblox/enum/RibbonTool.ColorPicker", "MaterialPicker": "@roblox/enum/RibbonTool.MaterialPicker", "Group": "@roblox/enum/RibbonTool.Group", "Ungroup": "@roblox/enum/RibbonTool.Ungroup", "None": "@roblox/enum/RibbonTool.None", "PivotEditor": "@roblox/enum/RibbonTool.PivotEditor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RibbonTool", "code_sample": "" }, "@roblox/enum/AdShape.HorizontalRectangle": { "documentation": "The ad has an aspect ratio of 16:9 and a minimum size of 8 by 4.5 studs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdShape#HorizontalRectangle", "code_sample": "" }, "@roblox/global/Enum.AdShape": { "documentation": "Describes the form factor of an ad in an AdGui. There is currently only one available size.", "keys": { "HorizontalRectangle": "@roblox/enum/AdShape.HorizontalRectangle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdShape", "code_sample": "" }, "@roblox/enum/ParticleEmitterShapeStyle.Volume": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeStyle#Volume", "code_sample": "" }, "@roblox/enum/ParticleEmitterShapeStyle.Surface": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeStyle#Surface", "code_sample": "" }, "@roblox/global/Enum.ParticleEmitterShapeStyle": { "documentation": "", "keys": { "Volume": "@roblox/enum/ParticleEmitterShapeStyle.Volume", "Surface": "@roblox/enum/ParticleEmitterShapeStyle.Surface" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeStyle", "code_sample": "" }, "@roblox/enum/VoiceChatState.Idle": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#Idle", "code_sample": "" }, "@roblox/enum/VoiceChatState.Joining": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#Joining", "code_sample": "" }, "@roblox/enum/VoiceChatState.JoiningRetry": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#JoiningRetry", "code_sample": "" }, "@roblox/enum/VoiceChatState.Joined": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#Joined", "code_sample": "" }, "@roblox/enum/VoiceChatState.Leaving": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#Leaving", "code_sample": "" }, "@roblox/enum/VoiceChatState.Ended": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#Ended", "code_sample": "" }, "@roblox/enum/VoiceChatState.Failed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState#Failed", "code_sample": "" }, "@roblox/global/Enum.VoiceChatState": { "documentation": "", "keys": { "Idle": "@roblox/enum/VoiceChatState.Idle", "Joining": "@roblox/enum/VoiceChatState.Joining", "JoiningRetry": "@roblox/enum/VoiceChatState.JoiningRetry", "Joined": "@roblox/enum/VoiceChatState.Joined", "Leaving": "@roblox/enum/VoiceChatState.Leaving", "Ended": "@roblox/enum/VoiceChatState.Ended", "Failed": "@roblox/enum/VoiceChatState.Failed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatState", "code_sample": "" }, "@roblox/enum/TriStateBoolean.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TriStateBoolean#Unknown", "code_sample": "" }, "@roblox/enum/TriStateBoolean.True": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TriStateBoolean#True", "code_sample": "" }, "@roblox/enum/TriStateBoolean.False": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TriStateBoolean#False", "code_sample": "" }, "@roblox/global/Enum.TriStateBoolean": { "documentation": "", "keys": { "Unknown": "@roblox/enum/TriStateBoolean.Unknown", "True": "@roblox/enum/TriStateBoolean.True", "False": "@roblox/enum/TriStateBoolean.False" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TriStateBoolean", "code_sample": "" }, "@roblox/enum/StudioCloseMode.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioCloseMode#None", "code_sample": "" }, "@roblox/enum/StudioCloseMode.CloseStudio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioCloseMode#CloseStudio", "code_sample": "" }, "@roblox/enum/StudioCloseMode.CloseDoc": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioCloseMode#CloseDoc", "code_sample": "" }, "@roblox/enum/StudioCloseMode.LogOut": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioCloseMode#LogOut", "code_sample": "" }, "@roblox/global/Enum.StudioCloseMode": { "documentation": "", "keys": { "None": "@roblox/enum/StudioCloseMode.None", "CloseStudio": "@roblox/enum/StudioCloseMode.CloseStudio", "CloseDoc": "@roblox/enum/StudioCloseMode.CloseDoc", "LogOut": "@roblox/enum/StudioCloseMode.LogOut" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioCloseMode", "code_sample": "" }, "@roblox/enum/TrackerLodValueMode.Force0": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodValueMode#Force0", "code_sample": "" }, "@roblox/enum/TrackerLodValueMode.Force1": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodValueMode#Force1", "code_sample": "" }, "@roblox/enum/TrackerLodValueMode.Auto": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodValueMode#Auto", "code_sample": "" }, "@roblox/global/Enum.TrackerLodValueMode": { "documentation": "", "keys": { "Force0": "@roblox/enum/TrackerLodValueMode.Force0", "Force1": "@roblox/enum/TrackerLodValueMode.Force1", "Auto": "@roblox/enum/TrackerLodValueMode.Auto" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodValueMode", "code_sample": "" }, "@roblox/enum/TextInputType.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#Default", "code_sample": "" }, "@roblox/enum/TextInputType.NoSuggestions": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#NoSuggestions", "code_sample": "" }, "@roblox/enum/TextInputType.Number": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#Number", "code_sample": "" }, "@roblox/enum/TextInputType.Email": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#Email", "code_sample": "" }, "@roblox/enum/TextInputType.Phone": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#Phone", "code_sample": "" }, "@roblox/enum/TextInputType.Password": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#Password", "code_sample": "" }, "@roblox/enum/TextInputType.PasswordShown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#PasswordShown", "code_sample": "" }, "@roblox/enum/TextInputType.Username": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#Username", "code_sample": "" }, "@roblox/enum/TextInputType.OneTimePassword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType#OneTimePassword", "code_sample": "" }, "@roblox/global/Enum.TextInputType": { "documentation": "", "keys": { "Default": "@roblox/enum/TextInputType.Default", "NoSuggestions": "@roblox/enum/TextInputType.NoSuggestions", "Number": "@roblox/enum/TextInputType.Number", "Email": "@roblox/enum/TextInputType.Email", "Phone": "@roblox/enum/TextInputType.Phone", "Password": "@roblox/enum/TextInputType.Password", "PasswordShown": "@roblox/enum/TextInputType.PasswordShown", "Username": "@roblox/enum/TextInputType.Username", "OneTimePassword": "@roblox/enum/TextInputType.OneTimePassword" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextInputType", "code_sample": "" }, "@roblox/enum/SpecialKey.Insert": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey#Insert", "code_sample": "" }, "@roblox/enum/SpecialKey.Home": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey#Home", "code_sample": "" }, "@roblox/enum/SpecialKey.End": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey#End", "code_sample": "" }, "@roblox/enum/SpecialKey.PageUp": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey#PageUp", "code_sample": "" }, "@roblox/enum/SpecialKey.PageDown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey#PageDown", "code_sample": "" }, "@roblox/enum/SpecialKey.ChatHotkey": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey#ChatHotkey", "code_sample": "" }, "@roblox/global/Enum.SpecialKey": { "documentation": "", "keys": { "Insert": "@roblox/enum/SpecialKey.Insert", "Home": "@roblox/enum/SpecialKey.Home", "End": "@roblox/enum/SpecialKey.End", "PageUp": "@roblox/enum/SpecialKey.PageUp", "PageDown": "@roblox/enum/SpecialKey.PageDown", "ChatHotkey": "@roblox/enum/SpecialKey.ChatHotkey" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SpecialKey", "code_sample": "" }, "@roblox/enum/VibrationMotor.Large": { "documentation": "Large motor.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor#Large", "code_sample": "" }, "@roblox/enum/VibrationMotor.Small": { "documentation": "Small motor.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor#Small", "code_sample": "" }, "@roblox/enum/VibrationMotor.LeftTrigger": { "documentation": "Left trigger motor.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor#LeftTrigger", "code_sample": "" }, "@roblox/enum/VibrationMotor.RightTrigger": { "documentation": "Right trigger motor.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor#RightTrigger", "code_sample": "" }, "@roblox/enum/VibrationMotor.LeftHand": { "documentation": "Left hand motor for VR devices.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor#LeftHand", "code_sample": "" }, "@roblox/enum/VibrationMotor.RightHand": { "documentation": "Right hand motor for VR devices.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor#RightHand", "code_sample": "" }, "@roblox/global/Enum.VibrationMotor": { "documentation": "Describes various types of haptic motor sizes and locations.", "keys": { "Large": "@roblox/enum/VibrationMotor.Large", "Small": "@roblox/enum/VibrationMotor.Small", "LeftTrigger": "@roblox/enum/VibrationMotor.LeftTrigger", "RightTrigger": "@roblox/enum/VibrationMotor.RightTrigger", "LeftHand": "@roblox/enum/VibrationMotor.LeftHand", "RightHand": "@roblox/enum/VibrationMotor.RightHand" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VibrationMotor", "code_sample": "" }, "@roblox/enum/CreateOutfitFailure.InvalidName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure#InvalidName", "code_sample": "" }, "@roblox/enum/CreateOutfitFailure.OutfitLimitReached": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure#OutfitLimitReached", "code_sample": "" }, "@roblox/enum/CreateOutfitFailure.Other": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure#Other", "code_sample": "" }, "@roblox/global/Enum.CreateOutfitFailure": { "documentation": "", "keys": { "InvalidName": "@roblox/enum/CreateOutfitFailure.InvalidName", "OutfitLimitReached": "@roblox/enum/CreateOutfitFailure.OutfitLimitReached", "Other": "@roblox/enum/CreateOutfitFailure.Other" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateOutfitFailure", "code_sample": "" }, "@roblox/enum/ConnectionError.OK": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#OK", "code_sample": "" }, "@roblox/enum/ConnectionError.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#Unknown", "code_sample": "" }, "@roblox/enum/ConnectionError.ConnectErrors": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ConnectErrors", "code_sample": "" }, "@roblox/enum/ConnectionError.AlreadyConnected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AlreadyConnected", "code_sample": "" }, "@roblox/enum/ConnectionError.NoFreeIncomingConnections": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NoFreeIncomingConnections", "code_sample": "" }, "@roblox/enum/ConnectionError.ConnectionBanned": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ConnectionBanned", "code_sample": "" }, "@roblox/enum/ConnectionError.InvalidPassword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#InvalidPassword", "code_sample": "" }, "@roblox/enum/ConnectionError.IncompatibleProtocolVersion": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#IncompatibleProtocolVersion", "code_sample": "" }, "@roblox/enum/ConnectionError.IPRecentlyConnected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#IPRecentlyConnected", "code_sample": "" }, "@roblox/enum/ConnectionError.OurSystemRequiresSecurity": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#OurSystemRequiresSecurity", "code_sample": "" }, "@roblox/enum/ConnectionError.SecurityKeyMismatch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#SecurityKeyMismatch", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectErrors": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectErrors", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectBadhash": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectBadhash", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectSecurityKeyMismatch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectSecurityKeyMismatch", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectProtocolMismatch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectProtocolMismatch", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectReceivePacketError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectReceivePacketError", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectReceivePacketStreamError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectReceivePacketStreamError", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectSendPacketError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectSendPacketError", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectIllegalTeleport": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectIllegalTeleport", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectDuplicatePlayer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectDuplicatePlayer", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectDuplicateTicket": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectDuplicateTicket", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectTimeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectTimeout", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectLuaKick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectLuaKick", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectOnRemoteSysStats": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectOnRemoteSysStats", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectHashTimeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectHashTimeout", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectCloudEditKick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCloudEditKick", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectPlayerless": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectPlayerless", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectNewSecurityKeyMismatch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectNewSecurityKeyMismatch", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectEvicted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectEvicted", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectDevMaintenance": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectDevMaintenance", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectRobloxMaintenance": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRobloxMaintenance", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectRejoin": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRejoin", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectConnectionLost": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectConnectionLost", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectIdle": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectIdle", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectRaknetErrors": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRaknetErrors", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectWrongVersion": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectWrongVersion", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectBySecurityPolicy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectBySecurityPolicy", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectBlockedIP": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectBlockedIP", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectClientFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectClientFailure", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectClientRequest": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectClientRequest", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectPrivateServerKickout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectPrivateServerKickout", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectModeratedGame": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectModeratedGame", "code_sample": "" }, "@roblox/enum/ConnectionError.ServerShutdown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ServerShutdown", "code_sample": "" }, "@roblox/enum/ConnectionError.ReplicatorTimeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ReplicatorTimeout", "code_sample": "" }, "@roblox/enum/ConnectionError.PlayerRemoved": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlayerRemoved", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectOutOfMemoryKeepPlayingLeave", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectRomarkEndOfTest": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectRomarkEndOfTest", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectCollaboratorPermissionRevoked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorPermissionRevoked", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectCollaboratorUnderage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectCollaboratorUnderage", "code_sample": "" }, "@roblox/enum/ConnectionError.NetworkInternal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkInternal", "code_sample": "" }, "@roblox/enum/ConnectionError.NetworkSend": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkSend", "code_sample": "" }, "@roblox/enum/ConnectionError.NetworkTimeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkTimeout", "code_sample": "" }, "@roblox/enum/ConnectionError.NetworkMisbehavior": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkMisbehavior", "code_sample": "" }, "@roblox/enum/ConnectionError.NetworkSecurity": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#NetworkSecurity", "code_sample": "" }, "@roblox/enum/ConnectionError.ReplacementReady": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ReplacementReady", "code_sample": "" }, "@roblox/enum/ConnectionError.ServerEmpty": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ServerEmpty", "code_sample": "" }, "@roblox/enum/ConnectionError.PhantomFreeze": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PhantomFreeze", "code_sample": "" }, "@roblox/enum/ConnectionError.AndroidAnticheatKick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidAnticheatKick", "code_sample": "" }, "@roblox/enum/ConnectionError.AndroidEmulatorKick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidEmulatorKick", "code_sample": "" }, "@roblox/enum/ConnectionError.AndroidRootedKick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#AndroidRootedKick", "code_sample": "" }, "@roblox/enum/ConnectionError.ScreentimeLockoutKick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#ScreentimeLockoutKick", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectionNotification": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectionNotification", "code_sample": "" }, "@roblox/enum/ConnectionError.DisconnectVerboselyModeratedGame": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#DisconnectVerboselyModeratedGame", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchErrors": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchErrors", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchDisabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchDisabled", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchError", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchGameEnded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchGameEnded", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchGameFull": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchGameFull", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchUserLeft": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchUserLeft", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchRestricted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchRestricted", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchUnauthorized": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchUnauthorized", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchFlooded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchFlooded", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchHashExpired": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchHashExpired", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchHashException": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchHashException", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchPartyCannotFit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchPartyCannotFit", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchHttpError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchHttpError", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchUserPrivacyUnauthorized": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchUserPrivacyUnauthorized", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchCreatorBan": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchCreatorBan", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchCustomMessage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchCustomMessage", "code_sample": "" }, "@roblox/enum/ConnectionError.PlacelaunchOtherError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#PlacelaunchOtherError", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportErrors": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportErrors", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportFailure", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportGameNotFound": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportGameNotFound", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportGameEnded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportGameEnded", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportGameFull": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportGameFull", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportUnauthorized": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportUnauthorized", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportFlooded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportFlooded", "code_sample": "" }, "@roblox/enum/ConnectionError.TeleportIsTeleporting": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError#TeleportIsTeleporting", "code_sample": "" }, "@roblox/global/Enum.ConnectionError": { "documentation": "", "keys": { "OK": "@roblox/enum/ConnectionError.OK", "Unknown": "@roblox/enum/ConnectionError.Unknown", "ConnectErrors": "@roblox/enum/ConnectionError.ConnectErrors", "AlreadyConnected": "@roblox/enum/ConnectionError.AlreadyConnected", "NoFreeIncomingConnections": "@roblox/enum/ConnectionError.NoFreeIncomingConnections", "ConnectionBanned": "@roblox/enum/ConnectionError.ConnectionBanned", "InvalidPassword": "@roblox/enum/ConnectionError.InvalidPassword", "IncompatibleProtocolVersion": "@roblox/enum/ConnectionError.IncompatibleProtocolVersion", "IPRecentlyConnected": "@roblox/enum/ConnectionError.IPRecentlyConnected", "OurSystemRequiresSecurity": "@roblox/enum/ConnectionError.OurSystemRequiresSecurity", "SecurityKeyMismatch": "@roblox/enum/ConnectionError.SecurityKeyMismatch", "DisconnectErrors": "@roblox/enum/ConnectionError.DisconnectErrors", "DisconnectBadhash": "@roblox/enum/ConnectionError.DisconnectBadhash", "DisconnectSecurityKeyMismatch": "@roblox/enum/ConnectionError.DisconnectSecurityKeyMismatch", "DisconnectProtocolMismatch": "@roblox/enum/ConnectionError.DisconnectProtocolMismatch", "DisconnectReceivePacketError": "@roblox/enum/ConnectionError.DisconnectReceivePacketError", "DisconnectReceivePacketStreamError": "@roblox/enum/ConnectionError.DisconnectReceivePacketStreamError", "DisconnectSendPacketError": "@roblox/enum/ConnectionError.DisconnectSendPacketError", "DisconnectIllegalTeleport": "@roblox/enum/ConnectionError.DisconnectIllegalTeleport", "DisconnectDuplicatePlayer": "@roblox/enum/ConnectionError.DisconnectDuplicatePlayer", "DisconnectDuplicateTicket": "@roblox/enum/ConnectionError.DisconnectDuplicateTicket", "DisconnectTimeout": "@roblox/enum/ConnectionError.DisconnectTimeout", "DisconnectLuaKick": "@roblox/enum/ConnectionError.DisconnectLuaKick", "DisconnectOnRemoteSysStats": "@roblox/enum/ConnectionError.DisconnectOnRemoteSysStats", "DisconnectHashTimeout": "@roblox/enum/ConnectionError.DisconnectHashTimeout", "DisconnectCloudEditKick": "@roblox/enum/ConnectionError.DisconnectCloudEditKick", "DisconnectPlayerless": "@roblox/enum/ConnectionError.DisconnectPlayerless", "DisconnectNewSecurityKeyMismatch": "@roblox/enum/ConnectionError.DisconnectNewSecurityKeyMismatch", "DisconnectEvicted": "@roblox/enum/ConnectionError.DisconnectEvicted", "DisconnectDevMaintenance": "@roblox/enum/ConnectionError.DisconnectDevMaintenance", "DisconnectRobloxMaintenance": "@roblox/enum/ConnectionError.DisconnectRobloxMaintenance", "DisconnectRejoin": "@roblox/enum/ConnectionError.DisconnectRejoin", "DisconnectConnectionLost": "@roblox/enum/ConnectionError.DisconnectConnectionLost", "DisconnectIdle": "@roblox/enum/ConnectionError.DisconnectIdle", "DisconnectRaknetErrors": "@roblox/enum/ConnectionError.DisconnectRaknetErrors", "DisconnectWrongVersion": "@roblox/enum/ConnectionError.DisconnectWrongVersion", "DisconnectBySecurityPolicy": "@roblox/enum/ConnectionError.DisconnectBySecurityPolicy", "DisconnectBlockedIP": "@roblox/enum/ConnectionError.DisconnectBlockedIP", "DisconnectClientFailure": "@roblox/enum/ConnectionError.DisconnectClientFailure", "DisconnectClientRequest": "@roblox/enum/ConnectionError.DisconnectClientRequest", "DisconnectPrivateServerKickout": "@roblox/enum/ConnectionError.DisconnectPrivateServerKickout", "DisconnectModeratedGame": "@roblox/enum/ConnectionError.DisconnectModeratedGame", "ServerShutdown": "@roblox/enum/ConnectionError.ServerShutdown", "ReplicatorTimeout": "@roblox/enum/ConnectionError.ReplicatorTimeout", "PlayerRemoved": "@roblox/enum/ConnectionError.PlayerRemoved", "DisconnectOutOfMemoryKeepPlayingLeave": "@roblox/enum/ConnectionError.DisconnectOutOfMemoryKeepPlayingLeave", "DisconnectRomarkEndOfTest": "@roblox/enum/ConnectionError.DisconnectRomarkEndOfTest", "DisconnectCollaboratorPermissionRevoked": "@roblox/enum/ConnectionError.DisconnectCollaboratorPermissionRevoked", "DisconnectCollaboratorUnderage": "@roblox/enum/ConnectionError.DisconnectCollaboratorUnderage", "NetworkInternal": "@roblox/enum/ConnectionError.NetworkInternal", "NetworkSend": "@roblox/enum/ConnectionError.NetworkSend", "NetworkTimeout": "@roblox/enum/ConnectionError.NetworkTimeout", "NetworkMisbehavior": "@roblox/enum/ConnectionError.NetworkMisbehavior", "NetworkSecurity": "@roblox/enum/ConnectionError.NetworkSecurity", "ReplacementReady": "@roblox/enum/ConnectionError.ReplacementReady", "ServerEmpty": "@roblox/enum/ConnectionError.ServerEmpty", "PhantomFreeze": "@roblox/enum/ConnectionError.PhantomFreeze", "AndroidAnticheatKick": "@roblox/enum/ConnectionError.AndroidAnticheatKick", "AndroidEmulatorKick": "@roblox/enum/ConnectionError.AndroidEmulatorKick", "AndroidRootedKick": "@roblox/enum/ConnectionError.AndroidRootedKick", "ScreentimeLockoutKick": "@roblox/enum/ConnectionError.ScreentimeLockoutKick", "DisconnectionNotification": "@roblox/enum/ConnectionError.DisconnectionNotification", "DisconnectVerboselyModeratedGame": "@roblox/enum/ConnectionError.DisconnectVerboselyModeratedGame", "PlacelaunchErrors": "@roblox/enum/ConnectionError.PlacelaunchErrors", "PlacelaunchDisabled": "@roblox/enum/ConnectionError.PlacelaunchDisabled", "PlacelaunchError": "@roblox/enum/ConnectionError.PlacelaunchError", "PlacelaunchGameEnded": "@roblox/enum/ConnectionError.PlacelaunchGameEnded", "PlacelaunchGameFull": "@roblox/enum/ConnectionError.PlacelaunchGameFull", "PlacelaunchUserLeft": "@roblox/enum/ConnectionError.PlacelaunchUserLeft", "PlacelaunchRestricted": "@roblox/enum/ConnectionError.PlacelaunchRestricted", "PlacelaunchUnauthorized": "@roblox/enum/ConnectionError.PlacelaunchUnauthorized", "PlacelaunchFlooded": "@roblox/enum/ConnectionError.PlacelaunchFlooded", "PlacelaunchHashExpired": "@roblox/enum/ConnectionError.PlacelaunchHashExpired", "PlacelaunchHashException": "@roblox/enum/ConnectionError.PlacelaunchHashException", "PlacelaunchPartyCannotFit": "@roblox/enum/ConnectionError.PlacelaunchPartyCannotFit", "PlacelaunchHttpError": "@roblox/enum/ConnectionError.PlacelaunchHttpError", "PlacelaunchUserPrivacyUnauthorized": "@roblox/enum/ConnectionError.PlacelaunchUserPrivacyUnauthorized", "PlacelaunchCreatorBan": "@roblox/enum/ConnectionError.PlacelaunchCreatorBan", "PlacelaunchCustomMessage": "@roblox/enum/ConnectionError.PlacelaunchCustomMessage", "PlacelaunchOtherError": "@roblox/enum/ConnectionError.PlacelaunchOtherError", "TeleportErrors": "@roblox/enum/ConnectionError.TeleportErrors", "TeleportFailure": "@roblox/enum/ConnectionError.TeleportFailure", "TeleportGameNotFound": "@roblox/enum/ConnectionError.TeleportGameNotFound", "TeleportGameEnded": "@roblox/enum/ConnectionError.TeleportGameEnded", "TeleportGameFull": "@roblox/enum/ConnectionError.TeleportGameFull", "TeleportUnauthorized": "@roblox/enum/ConnectionError.TeleportUnauthorized", "TeleportFlooded": "@roblox/enum/ConnectionError.TeleportFlooded", "TeleportIsTeleporting": "@roblox/enum/ConnectionError.TeleportIsTeleporting" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionError", "code_sample": "" }, "@roblox/enum/GearGenreSetting.AllGenres": { "documentation": "Deprecated:
All gear genres are allowed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearGenreSetting#AllGenres", "code_sample": "" }, "@roblox/enum/GearGenreSetting.MatchingGenreOnly": { "documentation": "Deprecated:
Only gear genres matching the allowed genres specified in a place's configuration settings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearGenreSetting#MatchingGenreOnly", "code_sample": "" }, "@roblox/global/Enum.GearGenreSetting": { "documentation": "Deprecated: This enum is deprecated as it is used by deprecated properties that are no longer functional. It should not be used.", "keys": { "AllGenres": "@roblox/enum/GearGenreSetting.AllGenres", "MatchingGenreOnly": "@roblox/enum/GearGenreSetting.MatchingGenreOnly" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GearGenreSetting", "code_sample": "" }, "@roblox/enum/ActuatorRelativeTo.Attachment0": { "documentation": "The constraint is expressed relative to Attachment0.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo#Attachment0", "code_sample": "" }, "@roblox/enum/ActuatorRelativeTo.Attachment1": { "documentation": "The constraint is expressed relative to Attachment1.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo#Attachment1", "code_sample": "" }, "@roblox/enum/ActuatorRelativeTo.World": { "documentation": "The constraint is expressed relative to the game world.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo#World", "code_sample": "" }, "@roblox/global/Enum.ActuatorRelativeTo": { "documentation": "The CFrame value in which the body mover constraint is expressed.", "keys": { "Attachment0": "@roblox/enum/ActuatorRelativeTo.Attachment0", "Attachment1": "@roblox/enum/ActuatorRelativeTo.Attachment1", "World": "@roblox/enum/ActuatorRelativeTo.World" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActuatorRelativeTo", "code_sample": "" }, "@roblox/enum/HoverAnimateSpeed.VerySlow": { "documentation": "2 seconds per cycle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HoverAnimateSpeed#VerySlow", "code_sample": "" }, "@roblox/enum/HoverAnimateSpeed.Slow": { "documentation": "1 second per cycle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HoverAnimateSpeed#Slow", "code_sample": "" }, "@roblox/enum/HoverAnimateSpeed.Medium": { "documentation": "0.5 seconds per cycle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HoverAnimateSpeed#Medium", "code_sample": "" }, "@roblox/enum/HoverAnimateSpeed.Fast": { "documentation": "0.25 seconds per cycle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HoverAnimateSpeed#Fast", "code_sample": "" }, "@roblox/enum/HoverAnimateSpeed.VeryFast": { "documentation": "0.1 seconds per cycle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HoverAnimateSpeed#VeryFast", "code_sample": "" }, "@roblox/global/Enum.HoverAnimateSpeed": { "documentation": "", "keys": { "VerySlow": "@roblox/enum/HoverAnimateSpeed.VerySlow", "Slow": "@roblox/enum/HoverAnimateSpeed.Slow", "Medium": "@roblox/enum/HoverAnimateSpeed.Medium", "Fast": "@roblox/enum/HoverAnimateSpeed.Fast", "VeryFast": "@roblox/enum/HoverAnimateSpeed.VeryFast" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HoverAnimateSpeed", "code_sample": "" }, "@roblox/enum/FilterResult.Accepted": { "documentation": "Text accepted by filter.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterResult#Accepted", "code_sample": "" }, "@roblox/enum/FilterResult.Rejected": { "documentation": "Text rejected by filter.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterResult#Rejected", "code_sample": "" }, "@roblox/global/Enum.FilterResult": { "documentation": "Used to determine the result of a text filter request.", "keys": { "Accepted": "@roblox/enum/FilterResult.Accepted", "Rejected": "@roblox/enum/FilterResult.Rejected" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterResult", "code_sample": "" }, "@roblox/global/Enum.AudioCaptureMode": { "documentation": "", "keys": {}, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioCaptureMode", "code_sample": "" }, "@roblox/enum/RenderPriority.First": { "documentation": "This should run first.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderPriority#First", "code_sample": "" }, "@roblox/enum/RenderPriority.Input": { "documentation": "This should run as second.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderPriority#Input", "code_sample": "" }, "@roblox/enum/RenderPriority.Camera": { "documentation": "This should run after Input.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderPriority#Camera", "code_sample": "" }, "@roblox/enum/RenderPriority.Character": { "documentation": "This should run after Camera.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderPriority#Character", "code_sample": "" }, "@roblox/enum/RenderPriority.Last": { "documentation": "This should run as last, after Character.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderPriority#Last", "code_sample": "" }, "@roblox/global/Enum.RenderPriority": { "documentation": "A list of standard reserved values in BindToRenderStep.", "keys": { "First": "@roblox/enum/RenderPriority.First", "Input": "@roblox/enum/RenderPriority.Input", "Camera": "@roblox/enum/RenderPriority.Camera", "Character": "@roblox/enum/RenderPriority.Character", "Last": "@roblox/enum/RenderPriority.Last" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderPriority", "code_sample": "" }, "@roblox/enum/AvatarSettingsCustomBodyType.AvatarReference": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomBodyType#AvatarReference", "code_sample": "" }, "@roblox/enum/AvatarSettingsCustomBodyType.BundleId": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomBodyType#BundleId", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsCustomBodyType": { "documentation": "", "keys": { "AvatarReference": "@roblox/enum/AvatarSettingsCustomBodyType.AvatarReference", "BundleId": "@roblox/enum/AvatarSettingsCustomBodyType.BundleId" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomBodyType", "code_sample": "" }, "@roblox/enum/UserCFrame.Head": { "documentation": "The CFrame of the user's head.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserCFrame#Head", "code_sample": "" }, "@roblox/enum/UserCFrame.LeftHand": { "documentation": "The CFrame of the user's left hand.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserCFrame#LeftHand", "code_sample": "" }, "@roblox/enum/UserCFrame.RightHand": { "documentation": "The CFrame of the user's right hand.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserCFrame#RightHand", "code_sample": "" }, "@roblox/enum/UserCFrame.Floor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserCFrame#Floor", "code_sample": "" }, "@roblox/global/Enum.UserCFrame": { "documentation": "Determines what body part is being tracked by a VR device, and what its CFrame actually is.", "keys": { "Head": "@roblox/enum/UserCFrame.Head", "LeftHand": "@roblox/enum/UserCFrame.LeftHand", "RightHand": "@roblox/enum/UserCFrame.RightHand", "Floor": "@roblox/enum/UserCFrame.Floor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserCFrame", "code_sample": "" }, "@roblox/enum/RenderingTestComparisonMethod.psnr": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingTestComparisonMethod#psnr", "code_sample": "" }, "@roblox/enum/RenderingTestComparisonMethod.diff": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingTestComparisonMethod#diff", "code_sample": "" }, "@roblox/global/Enum.RenderingTestComparisonMethod": { "documentation": "", "keys": { "psnr": "@roblox/enum/RenderingTestComparisonMethod.psnr", "diff": "@roblox/enum/RenderingTestComparisonMethod.diff" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingTestComparisonMethod", "code_sample": "" }, "@roblox/enum/VideoError.Ok": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#Ok", "code_sample": "" }, "@roblox/enum/VideoError.Eof": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#Eof", "code_sample": "" }, "@roblox/enum/VideoError.EAgain": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#EAgain", "code_sample": "" }, "@roblox/enum/VideoError.BadParameter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#BadParameter", "code_sample": "" }, "@roblox/enum/VideoError.AllocFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#AllocFailed", "code_sample": "" }, "@roblox/enum/VideoError.CodecInitFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#CodecInitFailed", "code_sample": "" }, "@roblox/enum/VideoError.CodecCloseFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#CodecCloseFailed", "code_sample": "" }, "@roblox/enum/VideoError.DecodeFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#DecodeFailed", "code_sample": "" }, "@roblox/enum/VideoError.ParsingFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#ParsingFailed", "code_sample": "" }, "@roblox/enum/VideoError.Unsupported": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#Unsupported", "code_sample": "" }, "@roblox/enum/VideoError.Generic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#Generic", "code_sample": "" }, "@roblox/enum/VideoError.DownloadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#DownloadFailed", "code_sample": "" }, "@roblox/enum/VideoError.StreamNotFound": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#StreamNotFound", "code_sample": "" }, "@roblox/enum/VideoError.EncodeFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#EncodeFailed", "code_sample": "" }, "@roblox/enum/VideoError.CreateFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#CreateFailed", "code_sample": "" }, "@roblox/enum/VideoError.NoPermission": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#NoPermission", "code_sample": "" }, "@roblox/enum/VideoError.NoService": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#NoService", "code_sample": "" }, "@roblox/enum/VideoError.ReleaseFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#ReleaseFailed", "code_sample": "" }, "@roblox/enum/VideoError.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError#Unknown", "code_sample": "" }, "@roblox/global/Enum.VideoError": { "documentation": "", "keys": { "Ok": "@roblox/enum/VideoError.Ok", "Eof": "@roblox/enum/VideoError.Eof", "EAgain": "@roblox/enum/VideoError.EAgain", "BadParameter": "@roblox/enum/VideoError.BadParameter", "AllocFailed": "@roblox/enum/VideoError.AllocFailed", "CodecInitFailed": "@roblox/enum/VideoError.CodecInitFailed", "CodecCloseFailed": "@roblox/enum/VideoError.CodecCloseFailed", "DecodeFailed": "@roblox/enum/VideoError.DecodeFailed", "ParsingFailed": "@roblox/enum/VideoError.ParsingFailed", "Unsupported": "@roblox/enum/VideoError.Unsupported", "Generic": "@roblox/enum/VideoError.Generic", "DownloadFailed": "@roblox/enum/VideoError.DownloadFailed", "StreamNotFound": "@roblox/enum/VideoError.StreamNotFound", "EncodeFailed": "@roblox/enum/VideoError.EncodeFailed", "CreateFailed": "@roblox/enum/VideoError.CreateFailed", "NoPermission": "@roblox/enum/VideoError.NoPermission", "NoService": "@roblox/enum/VideoError.NoService", "ReleaseFailed": "@roblox/enum/VideoError.ReleaseFailed", "Unknown": "@roblox/enum/VideoError.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoError", "code_sample": "" }, "@roblox/enum/IntermediateMeshGenerationResult.HighQualityMesh": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IntermediateMeshGenerationResult#HighQualityMesh", "code_sample": "" }, "@roblox/global/Enum.IntermediateMeshGenerationResult": { "documentation": "", "keys": { "HighQualityMesh": "@roblox/enum/IntermediateMeshGenerationResult.HighQualityMesh" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IntermediateMeshGenerationResult", "code_sample": "" }, "@roblox/enum/ConnectionState.Connected": { "documentation": "The client is connected.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionState#Connected", "code_sample": "" }, "@roblox/enum/ConnectionState.Disconnected": { "documentation": "The client is disconnected.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionState#Disconnected", "code_sample": "" }, "@roblox/global/Enum.ConnectionState": { "documentation": "Used to determine the connection state of the client to the game server.", "keys": { "Connected": "@roblox/enum/ConnectionState.Connected", "Disconnected": "@roblox/enum/ConnectionState.Disconnected" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ConnectionState", "code_sample": "" }, "@roblox/enum/UIFlexAlignment.None": { "documentation": "No flex behavior; siblings maintain their defined width or height.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexAlignment#None", "code_sample": "" }, "@roblox/enum/UIFlexAlignment.Fill": { "documentation": "Siblings resize to fill the entire parent container, overriding their defined width or height.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexAlignment#Fill", "code_sample": "" }, "@roblox/enum/UIFlexAlignment.SpaceAround": { "documentation": "Siblings maintain their defined width or height. Equal spacing is added on both sides of each sibling.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexAlignment#SpaceAround", "code_sample": "" }, "@roblox/enum/UIFlexAlignment.SpaceBetween": { "documentation": "Siblings maintain their defined width or height. Equal spacing is added between siblings, but no additional space is added around siblings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexAlignment#SpaceBetween", "code_sample": "" }, "@roblox/enum/UIFlexAlignment.SpaceEvenly": { "documentation": "Siblings maintain their defined width or height. Equal spacing is added both between and around siblings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexAlignment#SpaceEvenly", "code_sample": "" }, "@roblox/global/Enum.UIFlexAlignment": { "documentation": "In a UIListLayout flex layout, specifies how to distribute extra space in the parent container.", "keys": { "None": "@roblox/enum/UIFlexAlignment.None", "Fill": "@roblox/enum/UIFlexAlignment.Fill", "SpaceAround": "@roblox/enum/UIFlexAlignment.SpaceAround", "SpaceBetween": "@roblox/enum/UIFlexAlignment.SpaceBetween", "SpaceEvenly": "@roblox/enum/UIFlexAlignment.SpaceEvenly" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIFlexAlignment", "code_sample": "" }, "@roblox/enum/MembershipType.None": { "documentation": "The player does not have an active paid membership.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MembershipType#None", "code_sample": "" }, "@roblox/enum/MembershipType.BuildersClub": { "documentation": "(no longer available).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MembershipType#BuildersClub", "code_sample": "" }, "@roblox/enum/MembershipType.TurboBuildersClub": { "documentation": "(no longer available).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MembershipType#TurboBuildersClub", "code_sample": "" }, "@roblox/enum/MembershipType.OutrageousBuildersClub": { "documentation": "(no longer available).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MembershipType#OutrageousBuildersClub", "code_sample": "" }, "@roblox/enum/MembershipType.Premium": { "documentation": "The player has an active Premium membership.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MembershipType#Premium", "code_sample": "" }, "@roblox/global/Enum.MembershipType": { "documentation": "The membership type of a Player.", "keys": { "None": "@roblox/enum/MembershipType.None", "BuildersClub": "@roblox/enum/MembershipType.BuildersClub", "TurboBuildersClub": "@roblox/enum/MembershipType.TurboBuildersClub", "OutrageousBuildersClub": "@roblox/enum/MembershipType.OutrageousBuildersClub", "Premium": "@roblox/enum/MembershipType.Premium" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MembershipType", "code_sample": "" }, "@roblox/enum/AnimatorRetargetingMode.Default": { "documentation": "Retargeting in default state, opt-in initially but subject to change.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode#Default", "code_sample": "" }, "@roblox/enum/AnimatorRetargetingMode.Disabled": { "documentation": "Retargeting disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode#Disabled", "code_sample": "" }, "@roblox/enum/AnimatorRetargetingMode.Enabled": { "documentation": "Retargeting enabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.AnimatorRetargetingMode": { "documentation": "Animation Retargeting setting.", "keys": { "Default": "@roblox/enum/AnimatorRetargetingMode.Default", "Disabled": "@roblox/enum/AnimatorRetargetingMode.Disabled", "Enabled": "@roblox/enum/AnimatorRetargetingMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimatorRetargetingMode", "code_sample": "" }, "@roblox/enum/ChatCallbackType.OnCreatingChatWindow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnCreatingChatWindow", "code_sample": "" }, "@roblox/enum/ChatCallbackType.OnClientSendingMessage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnClientSendingMessage", "code_sample": "" }, "@roblox/enum/ChatCallbackType.OnClientFormattingMessage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnClientFormattingMessage", "code_sample": "" }, "@roblox/enum/ChatCallbackType.OnServerReceivingMessage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType#OnServerReceivingMessage", "code_sample": "" }, "@roblox/global/Enum.ChatCallbackType": { "documentation": "", "keys": { "OnCreatingChatWindow": "@roblox/enum/ChatCallbackType.OnCreatingChatWindow", "OnClientSendingMessage": "@roblox/enum/ChatCallbackType.OnClientSendingMessage", "OnClientFormattingMessage": "@roblox/enum/ChatCallbackType.OnClientFormattingMessage", "OnServerReceivingMessage": "@roblox/enum/ChatCallbackType.OnServerReceivingMessage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatCallbackType", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorPresets.RobloxDefault": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorPresets#RobloxDefault", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorPresets.Extra1": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorPresets#Extra1", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorPresets.Extra2": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorPresets#Extra2", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorPresets.Custom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorPresets#Custom", "code_sample": "" }, "@roblox/global/Enum.StudioScriptEditorColorPresets": { "documentation": "", "keys": { "RobloxDefault": "@roblox/enum/StudioScriptEditorColorPresets.RobloxDefault", "Extra1": "@roblox/enum/StudioScriptEditorColorPresets.Extra1", "Extra2": "@roblox/enum/StudioScriptEditorColorPresets.Extra2", "Custom": "@roblox/enum/StudioScriptEditorColorPresets.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorPresets", "code_sample": "" }, "@roblox/enum/Genre.All": { "documentation": "The game's genre is set to All. The game will be listed as all possible genres.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#All", "code_sample": "" }, "@roblox/enum/Genre.TownAndCity": { "documentation": "The game's genre is set to Town and City.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#TownAndCity", "code_sample": "" }, "@roblox/enum/Genre.Fantasy": { "documentation": "The game's genre is set to Fantasy.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Fantasy", "code_sample": "" }, "@roblox/enum/Genre.SciFi": { "documentation": "The game's genre is set to SciFi (Science Fiction).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#SciFi", "code_sample": "" }, "@roblox/enum/Genre.Ninja": { "documentation": "The game's genre is set to Ninja.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Ninja", "code_sample": "" }, "@roblox/enum/Genre.Scary": { "documentation": "The game's genre is set to Scary.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Scary", "code_sample": "" }, "@roblox/enum/Genre.Pirate": { "documentation": "The game's genre is set to Pirate.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Pirate", "code_sample": "" }, "@roblox/enum/Genre.Adventure": { "documentation": "The game's genre is set to Adventure.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Adventure", "code_sample": "" }, "@roblox/enum/Genre.Sports": { "documentation": "The game's genre is set to Sports.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Sports", "code_sample": "" }, "@roblox/enum/Genre.Funny": { "documentation": "The game's genre is set to Funny.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Funny", "code_sample": "" }, "@roblox/enum/Genre.WildWest": { "documentation": "The game's genre is set to Wild West.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#WildWest", "code_sample": "" }, "@roblox/enum/Genre.War": { "documentation": "The game's genre is set to War.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#War", "code_sample": "" }, "@roblox/enum/Genre.SkatePark": { "documentation": "The game's genre is set to Skate Park.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#SkatePark", "code_sample": "" }, "@roblox/enum/Genre.Tutorial": { "documentation": "The game's genre is set to Tutorial.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre#Tutorial", "code_sample": "" }, "@roblox/global/Enum.Genre": { "documentation": "Deprecated:
Used to represent the type of game.", "keys": { "All": "@roblox/enum/Genre.All", "TownAndCity": "@roblox/enum/Genre.TownAndCity", "Fantasy": "@roblox/enum/Genre.Fantasy", "SciFi": "@roblox/enum/Genre.SciFi", "Ninja": "@roblox/enum/Genre.Ninja", "Scary": "@roblox/enum/Genre.Scary", "Pirate": "@roblox/enum/Genre.Pirate", "Adventure": "@roblox/enum/Genre.Adventure", "Sports": "@roblox/enum/Genre.Sports", "Funny": "@roblox/enum/Genre.Funny", "WildWest": "@roblox/enum/Genre.WildWest", "War": "@roblox/enum/Genre.War", "SkatePark": "@roblox/enum/Genre.SkatePark", "Tutorial": "@roblox/enum/Genre.Tutorial" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Genre", "code_sample": "" }, "@roblox/enum/ImageAlphaType.Default": { "documentation": "The default behavior in which neither color nor alpha values are locked.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageAlphaType#Default", "code_sample": "" }, "@roblox/enum/ImageAlphaType.LockCanvasAlpha": { "documentation": "The alpha values of the image will not be modified.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageAlphaType#LockCanvasAlpha", "code_sample": "" }, "@roblox/enum/ImageAlphaType.LockCanvasColor": { "documentation": "The color values of the image will not be modified.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageAlphaType#LockCanvasColor", "code_sample": "" }, "@roblox/global/Enum.ImageAlphaType": { "documentation": "Enum for determining if the alpha or color is locked while combining two images.", "keys": { "Default": "@roblox/enum/ImageAlphaType.Default", "LockCanvasAlpha": "@roblox/enum/ImageAlphaType.LockCanvasAlpha", "LockCanvasColor": "@roblox/enum/ImageAlphaType.LockCanvasColor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ImageAlphaType", "code_sample": "" }, "@roblox/enum/PoseEasingDirection.In": { "documentation": "The EasingStyle curve is reversed, with the easing becoming linear as it approaches the next keyframe.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingDirection#In", "code_sample": "" }, "@roblox/enum/PoseEasingDirection.Out": { "documentation": "EasingStyle curves are applied in the forward direction, from the current keyframe to the next.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingDirection#Out", "code_sample": "" }, "@roblox/enum/PoseEasingDirection.InOut": { "documentation": "Two easing curves are applied back-to-back with the linear ends of the curves meeting in the middle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingDirection#InOut", "code_sample": "" }, "@roblox/global/Enum.PoseEasingDirection": { "documentation": "Used exclusively by Pose.EasingDirection to specify direction of the EasingStyle curve.", "keys": { "In": "@roblox/enum/PoseEasingDirection.In", "Out": "@roblox/enum/PoseEasingDirection.Out", "InOut": "@roblox/enum/PoseEasingDirection.InOut" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PoseEasingDirection", "code_sample": "" }, "@roblox/enum/AvatarPromptResult.Success": { "documentation": "The prompted action was completed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult#Success", "code_sample": "" }, "@roblox/enum/AvatarPromptResult.PermissionDenied": { "documentation": "Denied permission to take the prompted action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult#PermissionDenied", "code_sample": "" }, "@roblox/enum/AvatarPromptResult.Failed": { "documentation": "Failure while trying to take the prompted action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult#Failed", "code_sample": "" }, "@roblox/global/Enum.AvatarPromptResult": { "documentation": "The result of prompt operations of AvatarEditorService.", "keys": { "Success": "@roblox/enum/AvatarPromptResult.Success", "PermissionDenied": "@roblox/enum/AvatarPromptResult.PermissionDenied", "Failed": "@roblox/enum/AvatarPromptResult.Failed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarPromptResult", "code_sample": "" }, "@roblox/enum/PlayerDataErrorState.LoadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#LoadFailed", "code_sample": "" }, "@roblox/enum/PlayerDataErrorState.FlushFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#FlushFailed", "code_sample": "" }, "@roblox/enum/PlayerDataErrorState.ReleaseFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#ReleaseFailed", "code_sample": "" }, "@roblox/enum/PlayerDataErrorState.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState#None", "code_sample": "" }, "@roblox/global/Enum.PlayerDataErrorState": { "documentation": "", "keys": { "LoadFailed": "@roblox/enum/PlayerDataErrorState.LoadFailed", "FlushFailed": "@roblox/enum/PlayerDataErrorState.FlushFailed", "ReleaseFailed": "@roblox/enum/PlayerDataErrorState.ReleaseFailed", "None": "@roblox/enum/PlayerDataErrorState.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerDataErrorState", "code_sample": "" }, "@roblox/enum/TeleportState.RequestedFromServer": { "documentation": "The server has requested that the client teleport.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportState#RequestedFromServer", "code_sample": "" }, "@roblox/enum/TeleportState.Started": { "documentation": "The client has started attempting to teleport.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportState#Started", "code_sample": "" }, "@roblox/enum/TeleportState.WaitingForServer": { "documentation": "The client is waiting for the server to respond to the teleport request.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportState#WaitingForServer", "code_sample": "" }, "@roblox/enum/TeleportState.Failed": { "documentation": "The teleport failed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportState#Failed", "code_sample": "" }, "@roblox/enum/TeleportState.InProgress": { "documentation": "The teleport is currently in progress. The player usually disconnects and teleports to the destination after this.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportState#InProgress", "code_sample": "" }, "@roblox/global/Enum.TeleportState": { "documentation": "Determines the current teleportation state of a player.", "keys": { "RequestedFromServer": "@roblox/enum/TeleportState.RequestedFromServer", "Started": "@roblox/enum/TeleportState.Started", "WaitingForServer": "@roblox/enum/TeleportState.WaitingForServer", "Failed": "@roblox/enum/TeleportState.Failed", "InProgress": "@roblox/enum/TeleportState.InProgress" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportState", "code_sample": "" }, "@roblox/enum/CompletionAcceptanceBehavior.Insert": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#Insert", "code_sample": "" }, "@roblox/enum/CompletionAcceptanceBehavior.Replace": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#Replace", "code_sample": "" }, "@roblox/enum/CompletionAcceptanceBehavior.ReplaceOnEnterInsertOnTab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#ReplaceOnEnterInsertOnTab", "code_sample": "" }, "@roblox/enum/CompletionAcceptanceBehavior.InsertOnEnterReplaceOnTab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior#InsertOnEnterReplaceOnTab", "code_sample": "" }, "@roblox/global/Enum.CompletionAcceptanceBehavior": { "documentation": "", "keys": { "Insert": "@roblox/enum/CompletionAcceptanceBehavior.Insert", "Replace": "@roblox/enum/CompletionAcceptanceBehavior.Replace", "ReplaceOnEnterInsertOnTab": "@roblox/enum/CompletionAcceptanceBehavior.ReplaceOnEnterInsertOnTab", "InsertOnEnterReplaceOnTab": "@roblox/enum/CompletionAcceptanceBehavior.InsertOnEnterReplaceOnTab" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionAcceptanceBehavior", "code_sample": "" }, "@roblox/enum/AvatarSettingsAppearanceMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsAppearanceMode.CustomParts": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode#CustomParts", "code_sample": "" }, "@roblox/enum/AvatarSettingsAppearanceMode.CustomBody": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode#CustomBody", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsAppearanceMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsAppearanceMode.PlayerChoice", "CustomParts": "@roblox/enum/AvatarSettingsAppearanceMode.CustomParts", "CustomBody": "@roblox/enum/AvatarSettingsAppearanceMode.CustomBody" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAppearanceMode", "code_sample": "" }, "@roblox/enum/RigType.R15": { "documentation": "A rig type of R15.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigType#R15", "code_sample": "" }, "@roblox/enum/RigType.Custom": { "documentation": "A rig type of Custom.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigType#Custom", "code_sample": "" }, "@roblox/enum/RigType.None": { "documentation": "A rig type of None.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigType#None", "code_sample": "" }, "@roblox/global/Enum.RigType": { "documentation": "The type of rig being imported with the 3D Importer.", "keys": { "R15": "@roblox/enum/RigType.R15", "Custom": "@roblox/enum/RigType.Custom", "None": "@roblox/enum/RigType.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigType", "code_sample": "" }, "@roblox/enum/RotationType.MovementRelative": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationType#MovementRelative", "code_sample": "" }, "@roblox/enum/RotationType.CameraRelative": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationType#CameraRelative", "code_sample": "" }, "@roblox/global/Enum.RotationType": { "documentation": "", "keys": { "MovementRelative": "@roblox/enum/RotationType.MovementRelative", "CameraRelative": "@roblox/enum/RotationType.CameraRelative" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationType", "code_sample": "" }, "@roblox/enum/DraftStatusCode.OK": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#OK", "code_sample": "" }, "@roblox/enum/DraftStatusCode.DraftOutdated": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#DraftOutdated", "code_sample": "" }, "@roblox/enum/DraftStatusCode.ScriptRemoved": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#ScriptRemoved", "code_sample": "" }, "@roblox/enum/DraftStatusCode.DraftCommitted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode#DraftCommitted", "code_sample": "" }, "@roblox/global/Enum.DraftStatusCode": { "documentation": "", "keys": { "OK": "@roblox/enum/DraftStatusCode.OK", "DraftOutdated": "@roblox/enum/DraftStatusCode.DraftOutdated", "ScriptRemoved": "@roblox/enum/DraftStatusCode.ScriptRemoved", "DraftCommitted": "@roblox/enum/DraftStatusCode.DraftCommitted" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraftStatusCode", "code_sample": "" }, "@roblox/enum/IKControlConstraintSupport.Default": { "documentation": "The default option for IKControls. The default is currently set to Enabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlConstraintSupport#Default", "code_sample": "" }, "@roblox/enum/IKControlConstraintSupport.Disabled": { "documentation": "Disables support for constraints for IKControls. When disabled, IKControls still work, but ignore physics constraints.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlConstraintSupport#Disabled", "code_sample": "" }, "@roblox/enum/IKControlConstraintSupport.Enabled": { "documentation": "Enables support for constraints for IKControls.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlConstraintSupport#Enabled", "code_sample": "" }, "@roblox/global/Enum.IKControlConstraintSupport": { "documentation": "Values for Workspace.IKControlConstraintSupport. Sets the support for constraints for IKControls in your experience.", "keys": { "Default": "@roblox/enum/IKControlConstraintSupport.Default", "Disabled": "@roblox/enum/IKControlConstraintSupport.Disabled", "Enabled": "@roblox/enum/IKControlConstraintSupport.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlConstraintSupport", "code_sample": "" }, "@roblox/enum/HttpContentType.ApplicationJson": { "documentation": "Represents the \"application/json\" Content-Type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpContentType#ApplicationJson", "code_sample": "" }, "@roblox/enum/HttpContentType.ApplicationXml": { "documentation": "Represents the \"application/xml\" Content-Type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpContentType#ApplicationXml", "code_sample": "" }, "@roblox/enum/HttpContentType.ApplicationUrlEncoded": { "documentation": "Represents the \"application/x-www-form-urlencoded\" Content-Type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpContentType#ApplicationUrlEncoded", "code_sample": "" }, "@roblox/enum/HttpContentType.TextPlain": { "documentation": "Represents the \"text/plain\" Content-Type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpContentType#TextPlain", "code_sample": "" }, "@roblox/enum/HttpContentType.TextXml": { "documentation": "Represents the \"text/xml\" Content-Type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpContentType#TextXml", "code_sample": "" }, "@roblox/global/Enum.HttpContentType": { "documentation": "Specifies the value of the HTTP Content-Type header which describes the HTTP request data type.", "keys": { "ApplicationJson": "@roblox/enum/HttpContentType.ApplicationJson", "ApplicationXml": "@roblox/enum/HttpContentType.ApplicationXml", "ApplicationUrlEncoded": "@roblox/enum/HttpContentType.ApplicationUrlEncoded", "TextPlain": "@roblox/enum/HttpContentType.TextPlain", "TextXml": "@roblox/enum/HttpContentType.TextXml" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpContentType", "code_sample": "" }, "@roblox/enum/AssetFetchStatus.Success": { "documentation": "The asset loaded successfully.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#Success", "code_sample": "" }, "@roblox/enum/AssetFetchStatus.Failure": { "documentation": "The asset failed to load successfully. Subsequent attempts are likely to fail; there may be something wrong with the Content string.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#Failure", "code_sample": "" }, "@roblox/enum/AssetFetchStatus.None": { "documentation": "The engine has no information about this asset. The engine never tried to load it.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#None", "code_sample": "" }, "@roblox/enum/AssetFetchStatus.Loading": { "documentation": "The engine is in the middle of trying to load this asset.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#Loading", "code_sample": "" }, "@roblox/enum/AssetFetchStatus.TimedOut": { "documentation": "The engine tried to load this asset but timed out. Future attempts to load may succeed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus#TimedOut", "code_sample": "" }, "@roblox/global/Enum.AssetFetchStatus": { "documentation": "", "keys": { "Success": "@roblox/enum/AssetFetchStatus.Success", "Failure": "@roblox/enum/AssetFetchStatus.Failure", "None": "@roblox/enum/AssetFetchStatus.None", "Loading": "@roblox/enum/AssetFetchStatus.Loading", "TimedOut": "@roblox/enum/AssetFetchStatus.TimedOut" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetFetchStatus", "code_sample": "" }, "@roblox/enum/CameraSpeedAdjustBinding.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding#None", "code_sample": "" }, "@roblox/enum/CameraSpeedAdjustBinding.RmbScroll": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding#RmbScroll", "code_sample": "" }, "@roblox/enum/CameraSpeedAdjustBinding.AltScroll": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding#AltScroll", "code_sample": "" }, "@roblox/global/Enum.CameraSpeedAdjustBinding": { "documentation": "", "keys": { "None": "@roblox/enum/CameraSpeedAdjustBinding.None", "RmbScroll": "@roblox/enum/CameraSpeedAdjustBinding.RmbScroll", "AltScroll": "@roblox/enum/CameraSpeedAdjustBinding.AltScroll" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraSpeedAdjustBinding", "code_sample": "" }, "@roblox/enum/BreakpointRemoveReason.Requested": { "documentation": "Breakpoint removal was requested by user or a command.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason#Requested", "code_sample": "" }, "@roblox/enum/BreakpointRemoveReason.ScriptChanged": { "documentation": "Script that contained the breakpoint has changed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason#ScriptChanged", "code_sample": "" }, "@roblox/enum/BreakpointRemoveReason.ScriptRemoved": { "documentation": "Script that contained the breakpoint was removed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason#ScriptRemoved", "code_sample": "" }, "@roblox/global/Enum.BreakpointRemoveReason": { "documentation": "Reason that a breakpoint was removed.", "keys": { "Requested": "@roblox/enum/BreakpointRemoveReason.Requested", "ScriptChanged": "@roblox/enum/BreakpointRemoveReason.ScriptChanged", "ScriptRemoved": "@roblox/enum/BreakpointRemoveReason.ScriptRemoved" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakpointRemoveReason", "code_sample": "" }, "@roblox/enum/ParticleFlipbookTextureCompatible.NotCompatible": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookTextureCompatible#NotCompatible", "code_sample": "" }, "@roblox/enum/ParticleFlipbookTextureCompatible.Compatible": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookTextureCompatible#Compatible", "code_sample": "" }, "@roblox/enum/ParticleFlipbookTextureCompatible.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookTextureCompatible#Unknown", "code_sample": "" }, "@roblox/global/Enum.ParticleFlipbookTextureCompatible": { "documentation": "", "keys": { "NotCompatible": "@roblox/enum/ParticleFlipbookTextureCompatible.NotCompatible", "Compatible": "@roblox/enum/ParticleFlipbookTextureCompatible.Compatible", "Unknown": "@roblox/enum/ParticleFlipbookTextureCompatible.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookTextureCompatible", "code_sample": "" }, "@roblox/enum/AvatarSettingsAnimationClipsMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationClipsMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsAnimationClipsMode.CustomClips": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationClipsMode#CustomClips", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsAnimationClipsMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsAnimationClipsMode.PlayerChoice", "CustomClips": "@roblox/enum/AvatarSettingsAnimationClipsMode.CustomClips" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAnimationClipsMode", "code_sample": "" }, "@roblox/enum/ListDisplayMode.Horizontal": { "documentation": "Scrolling along the X-axis (fixed Y-Axis).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListDisplayMode#Horizontal", "code_sample": "" }, "@roblox/enum/ListDisplayMode.Vertical": { "documentation": "Scrolling along the Y-axis (fixed X-Axis).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListDisplayMode#Vertical", "code_sample": "" }, "@roblox/global/Enum.ListDisplayMode": { "documentation": "Used to set the scrolling mode of the Advanced Objects tab.", "keys": { "Horizontal": "@roblox/enum/ListDisplayMode.Horizontal", "Vertical": "@roblox/enum/ListDisplayMode.Vertical" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListDisplayMode", "code_sample": "" }, "@roblox/enum/FrameStyle.Custom": { "documentation": "Uses the frame's GuiObject.BackgroundColor3, GuiObject.BorderColor3, and GuiObject.BackgroundTransparency properties to determine the frame's appearance. It has no padding; elements with the position UDim2.new(0, 0, 0, 0) will appear at the frame's top-left corner.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#Custom", "code_sample": "" }, "@roblox/enum/FrameStyle.ChatBlue": { "documentation": "Causes the frame to appear similar to a Dialog with its Tone property set to DialogTone.Neutral. Like ChatGreen and ChatRed, this has a padding of fifteen pixels on all sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#ChatBlue", "code_sample": "" }, "@roblox/enum/FrameStyle.RobloxSquare": { "documentation": "Causes the frame to appear as a translucent dark gray rectangle with a padding of five pixels on all sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#RobloxSquare", "code_sample": "" }, "@roblox/enum/FrameStyle.RobloxRound": { "documentation": "Causes the frame to appear as a translucent dark gray rectangle with rounded edges. Like RobloxSquare, this has a padding of five pixels on all sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#RobloxRound", "code_sample": "" }, "@roblox/enum/FrameStyle.ChatGreen": { "documentation": "Causes the frame to appear similar to a Dialog with its Tone property set to DialogTone.Friendly. Like ChatBlue and ChatRed, this has a padding of fifteen pixels on all sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#ChatGreen", "code_sample": "" }, "@roblox/enum/FrameStyle.ChatRed": { "documentation": "Causes the frame to appear similar to a Dialog with its Tone property set to DialogTone.Enemy. Like ChatBlue and ChatGreen, this has a padding of fifteen pixels on all sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#ChatRed", "code_sample": "" }, "@roblox/enum/FrameStyle.DropShadow": { "documentation": "Causes the frame to appear as a translucent gray rectangle with blurred sides. The blur is more apparent on the bottom edge. It has a padding of eight pixels on all sides.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle#DropShadow", "code_sample": "" }, "@roblox/global/Enum.FrameStyle": { "documentation": "Used to set the style of a Frame.", "keys": { "Custom": "@roblox/enum/FrameStyle.Custom", "ChatBlue": "@roblox/enum/FrameStyle.ChatBlue", "RobloxSquare": "@roblox/enum/FrameStyle.RobloxSquare", "RobloxRound": "@roblox/enum/FrameStyle.RobloxRound", "ChatGreen": "@roblox/enum/FrameStyle.ChatGreen", "ChatRed": "@roblox/enum/FrameStyle.ChatRed", "DropShadow": "@roblox/enum/FrameStyle.DropShadow" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FrameStyle", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragRelativity.Absolute": { "documentation": "Designates the input and return values as the absolute target position/rotation in the space defined by DragSpace.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragRelativity#Absolute", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragRelativity.Relative": { "documentation": "Designates the input and return values as the change from the current position/rotation in the space defined by DragSpace.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragRelativity#Relative", "code_sample": "" }, "@roblox/global/Enum.UIDragDetectorDragRelativity": { "documentation": "Used with DragDetector to set the paradigm which defines the relativity of inputs/outputs from a custom drag function.", "keys": { "Absolute": "@roblox/enum/UIDragDetectorDragRelativity.Absolute", "Relative": "@roblox/enum/UIDragDetectorDragRelativity.Relative" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragRelativity", "code_sample": "" }, "@roblox/enum/AvatarSettingsCustomAccessoryMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomAccessoryMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsCustomAccessoryMode.CustomAccessories": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomAccessoryMode#CustomAccessories", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsCustomAccessoryMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsCustomAccessoryMode.PlayerChoice", "CustomAccessories": "@roblox/enum/AvatarSettingsCustomAccessoryMode.CustomAccessories" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCustomAccessoryMode", "code_sample": "" }, "@roblox/enum/SecurityCapability.RunClientScript": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RunClientScript", "code_sample": "" }, "@roblox/enum/SecurityCapability.RunServerScript": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RunServerScript", "code_sample": "" }, "@roblox/enum/SecurityCapability.AccessOutsideWrite": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AccessOutsideWrite", "code_sample": "" }, "@roblox/enum/SecurityCapability.AssetRequire": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#AssetRequire", "code_sample": "" }, "@roblox/enum/SecurityCapability.LoadString": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LoadString", "code_sample": "" }, "@roblox/enum/SecurityCapability.ScriptGlobals": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#ScriptGlobals", "code_sample": "" }, "@roblox/enum/SecurityCapability.CreateInstances": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CreateInstances", "code_sample": "" }, "@roblox/enum/SecurityCapability.Basic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Basic", "code_sample": "" }, "@roblox/enum/SecurityCapability.Audio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Audio", "code_sample": "" }, "@roblox/enum/SecurityCapability.DataStore": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#DataStore", "code_sample": "" }, "@roblox/enum/SecurityCapability.Network": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Network", "code_sample": "" }, "@roblox/enum/SecurityCapability.Physics": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Physics", "code_sample": "" }, "@roblox/enum/SecurityCapability.UI": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#UI", "code_sample": "" }, "@roblox/enum/SecurityCapability.CSG": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CSG", "code_sample": "" }, "@roblox/enum/SecurityCapability.Chat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Chat", "code_sample": "" }, "@roblox/enum/SecurityCapability.Animation": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Animation", "code_sample": "" }, "@roblox/enum/SecurityCapability.Avatar": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Avatar", "code_sample": "" }, "@roblox/enum/SecurityCapability.Input": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Input", "code_sample": "" }, "@roblox/enum/SecurityCapability.Environment": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Environment", "code_sample": "" }, "@roblox/enum/SecurityCapability.RemoteEvent": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#RemoteEvent", "code_sample": "" }, "@roblox/enum/SecurityCapability.LegacySound": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#LegacySound", "code_sample": "" }, "@roblox/enum/SecurityCapability.Players": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#Players", "code_sample": "" }, "@roblox/enum/SecurityCapability.CapabilityControl": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability#CapabilityControl", "code_sample": "" }, "@roblox/global/Enum.SecurityCapability": { "documentation": "", "keys": { "RunClientScript": "@roblox/enum/SecurityCapability.RunClientScript", "RunServerScript": "@roblox/enum/SecurityCapability.RunServerScript", "AccessOutsideWrite": "@roblox/enum/SecurityCapability.AccessOutsideWrite", "AssetRequire": "@roblox/enum/SecurityCapability.AssetRequire", "LoadString": "@roblox/enum/SecurityCapability.LoadString", "ScriptGlobals": "@roblox/enum/SecurityCapability.ScriptGlobals", "CreateInstances": "@roblox/enum/SecurityCapability.CreateInstances", "Basic": "@roblox/enum/SecurityCapability.Basic", "Audio": "@roblox/enum/SecurityCapability.Audio", "DataStore": "@roblox/enum/SecurityCapability.DataStore", "Network": "@roblox/enum/SecurityCapability.Network", "Physics": "@roblox/enum/SecurityCapability.Physics", "UI": "@roblox/enum/SecurityCapability.UI", "CSG": "@roblox/enum/SecurityCapability.CSG", "Chat": "@roblox/enum/SecurityCapability.Chat", "Animation": "@roblox/enum/SecurityCapability.Animation", "Avatar": "@roblox/enum/SecurityCapability.Avatar", "Input": "@roblox/enum/SecurityCapability.Input", "Environment": "@roblox/enum/SecurityCapability.Environment", "RemoteEvent": "@roblox/enum/SecurityCapability.RemoteEvent", "LegacySound": "@roblox/enum/SecurityCapability.LegacySound", "Players": "@roblox/enum/SecurityCapability.Players", "CapabilityControl": "@roblox/enum/SecurityCapability.CapabilityControl" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SecurityCapability", "code_sample": "" }, "@roblox/enum/SolverConvergenceVisualizationMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceVisualizationMode#Disabled", "code_sample": "" }, "@roblox/enum/SolverConvergenceVisualizationMode.PerIsland": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceVisualizationMode#PerIsland", "code_sample": "" }, "@roblox/enum/SolverConvergenceVisualizationMode.PerEdge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceVisualizationMode#PerEdge", "code_sample": "" }, "@roblox/global/Enum.SolverConvergenceVisualizationMode": { "documentation": "", "keys": { "Disabled": "@roblox/enum/SolverConvergenceVisualizationMode.Disabled", "PerIsland": "@roblox/enum/SolverConvergenceVisualizationMode.PerIsland", "PerEdge": "@roblox/enum/SolverConvergenceVisualizationMode.PerEdge" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceVisualizationMode", "code_sample": "" }, "@roblox/enum/AvatarUnificationMode.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode#Default", "code_sample": "" }, "@roblox/enum/AvatarUnificationMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode#Disabled", "code_sample": "" }, "@roblox/enum/AvatarUnificationMode.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.AvatarUnificationMode": { "documentation": "", "keys": { "Default": "@roblox/enum/AvatarUnificationMode.Default", "Disabled": "@roblox/enum/AvatarUnificationMode.Disabled", "Enabled": "@roblox/enum/AvatarUnificationMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarUnificationMode", "code_sample": "" }, "@roblox/enum/ControlMode.Classic": { "documentation": "Allows the camera to be moved by clicking and dragging with the right mouse button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ControlMode#Classic", "code_sample": "" }, "@roblox/enum/ControlMode.MouseLockSwitch": { "documentation": "Similar to classic, but allows the player to toggle mouse locking, causing the camera to rotate as the player moves the mouse (without holding down a button).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ControlMode#MouseLockSwitch", "code_sample": "" }, "@roblox/global/Enum.ControlMode": { "documentation": "The ControlMode Enum sets how the player is controlled.", "keys": { "Classic": "@roblox/enum/ControlMode.Classic", "MouseLockSwitch": "@roblox/enum/ControlMode.MouseLockSwitch" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ControlMode", "code_sample": "" }, "@roblox/enum/TrackerExtrapolationFlagMode.ForceDisabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerExtrapolationFlagMode#ForceDisabled", "code_sample": "" }, "@roblox/enum/TrackerExtrapolationFlagMode.ExtrapolateFacsAndPose": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerExtrapolationFlagMode#ExtrapolateFacsAndPose", "code_sample": "" }, "@roblox/enum/TrackerExtrapolationFlagMode.ExtrapolateFacsOnly": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerExtrapolationFlagMode#ExtrapolateFacsOnly", "code_sample": "" }, "@roblox/enum/TrackerExtrapolationFlagMode.Auto": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerExtrapolationFlagMode#Auto", "code_sample": "" }, "@roblox/global/Enum.TrackerExtrapolationFlagMode": { "documentation": "", "keys": { "ForceDisabled": "@roblox/enum/TrackerExtrapolationFlagMode.ForceDisabled", "ExtrapolateFacsAndPose": "@roblox/enum/TrackerExtrapolationFlagMode.ExtrapolateFacsAndPose", "ExtrapolateFacsOnly": "@roblox/enum/TrackerExtrapolationFlagMode.ExtrapolateFacsOnly", "Auto": "@roblox/enum/TrackerExtrapolationFlagMode.Auto" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerExtrapolationFlagMode", "code_sample": "" }, "@roblox/enum/CellOrientation.NegZ": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellOrientation#NegZ", "code_sample": "" }, "@roblox/enum/CellOrientation.X": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellOrientation#X", "code_sample": "" }, "@roblox/enum/CellOrientation.Z": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellOrientation#Z", "code_sample": "" }, "@roblox/enum/CellOrientation.NegX": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellOrientation#NegX", "code_sample": "" }, "@roblox/global/Enum.CellOrientation": { "documentation": "", "keys": { "NegZ": "@roblox/enum/CellOrientation.NegZ", "X": "@roblox/enum/CellOrientation.X", "Z": "@roblox/enum/CellOrientation.Z", "NegX": "@roblox/enum/CellOrientation.NegX" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellOrientation", "code_sample": "" }, "@roblox/enum/TextXAlignment.Left": { "documentation": "Alignment starts at the left side of the GUI object.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextXAlignment#Left", "code_sample": "" }, "@roblox/enum/TextXAlignment.Right": { "documentation": "Alignment starts at the right side of the GUI object.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextXAlignment#Right", "code_sample": "" }, "@roblox/enum/TextXAlignment.Center": { "documentation": "Aligned starts at the center of the GUI object and spreads equally left and right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextXAlignment#Center", "code_sample": "" }, "@roblox/global/Enum.TextXAlignment": { "documentation": "Determines horizontal alignment of text.", "keys": { "Left": "@roblox/enum/TextXAlignment.Left", "Right": "@roblox/enum/TextXAlignment.Right", "Center": "@roblox/enum/TextXAlignment.Center" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextXAlignment", "code_sample": "" }, "@roblox/enum/DevComputerMovementMode.UserChoice": { "documentation": "Allows players to choose their desired control scheme from the in-experience menu. This is the default movement mode.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#UserChoice", "code_sample": "" }, "@roblox/enum/DevComputerMovementMode.KeyboardMouse": { "documentation": "The player's character will be controlled using the keyboard and mouse.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#KeyboardMouse", "code_sample": "" }, "@roblox/enum/DevComputerMovementMode.ClickToMove": { "documentation": "Players can only move through the experience by clicking a target location. The player's character will automatically jump when reaching a surmountable obstacle/gap while moving to the click destination.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#ClickToMove", "code_sample": "" }, "@roblox/enum/DevComputerMovementMode.Scriptable": { "documentation": "Disables all default controls and allows you to script your own control scheme.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode#Scriptable", "code_sample": "" }, "@roblox/global/Enum.DevComputerMovementMode": { "documentation": "Sets the movement mode of players who are playing on computers.", "keys": { "UserChoice": "@roblox/enum/DevComputerMovementMode.UserChoice", "KeyboardMouse": "@roblox/enum/DevComputerMovementMode.KeyboardMouse", "ClickToMove": "@roblox/enum/DevComputerMovementMode.ClickToMove", "Scriptable": "@roblox/enum/DevComputerMovementMode.Scriptable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerMovementMode", "code_sample": "" }, "@roblox/enum/FilterErrorType.BackslashNotEscapingAnything": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#BackslashNotEscapingAnything", "code_sample": "" }, "@roblox/enum/FilterErrorType.BadBespokeFilter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#BadBespokeFilter", "code_sample": "" }, "@roblox/enum/FilterErrorType.BadName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#BadName", "code_sample": "" }, "@roblox/enum/FilterErrorType.IncompleteOr": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#IncompleteOr", "code_sample": "" }, "@roblox/enum/FilterErrorType.IncompleteParenthesis": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#IncompleteParenthesis", "code_sample": "" }, "@roblox/enum/FilterErrorType.InvalidDoubleStar": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#InvalidDoubleStar", "code_sample": "" }, "@roblox/enum/FilterErrorType.InvalidTilde": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#InvalidTilde", "code_sample": "" }, "@roblox/enum/FilterErrorType.PropertyBadOperator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyBadOperator", "code_sample": "" }, "@roblox/enum/FilterErrorType.PropertyDoesNotExist": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyDoesNotExist", "code_sample": "" }, "@roblox/enum/FilterErrorType.PropertyInvalidField": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyInvalidField", "code_sample": "" }, "@roblox/enum/FilterErrorType.PropertyInvalidValue": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyInvalidValue", "code_sample": "" }, "@roblox/enum/FilterErrorType.PropertyUnsupportedFields": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyUnsupportedFields", "code_sample": "" }, "@roblox/enum/FilterErrorType.PropertyUnsupportedProperty": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#PropertyUnsupportedProperty", "code_sample": "" }, "@roblox/enum/FilterErrorType.UnexpectedNameIndex": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnexpectedNameIndex", "code_sample": "" }, "@roblox/enum/FilterErrorType.UnexpectedToken": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnexpectedToken", "code_sample": "" }, "@roblox/enum/FilterErrorType.UnfinishedBinaryOperator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnfinishedBinaryOperator", "code_sample": "" }, "@roblox/enum/FilterErrorType.UnfinishedQuote": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnfinishedQuote", "code_sample": "" }, "@roblox/enum/FilterErrorType.UnknownBespokeFilter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#UnknownBespokeFilter", "code_sample": "" }, "@roblox/enum/FilterErrorType.WildcardInProperty": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType#WildcardInProperty", "code_sample": "" }, "@roblox/global/Enum.FilterErrorType": { "documentation": "", "keys": { "BackslashNotEscapingAnything": "@roblox/enum/FilterErrorType.BackslashNotEscapingAnything", "BadBespokeFilter": "@roblox/enum/FilterErrorType.BadBespokeFilter", "BadName": "@roblox/enum/FilterErrorType.BadName", "IncompleteOr": "@roblox/enum/FilterErrorType.IncompleteOr", "IncompleteParenthesis": "@roblox/enum/FilterErrorType.IncompleteParenthesis", "InvalidDoubleStar": "@roblox/enum/FilterErrorType.InvalidDoubleStar", "InvalidTilde": "@roblox/enum/FilterErrorType.InvalidTilde", "PropertyBadOperator": "@roblox/enum/FilterErrorType.PropertyBadOperator", "PropertyDoesNotExist": "@roblox/enum/FilterErrorType.PropertyDoesNotExist", "PropertyInvalidField": "@roblox/enum/FilterErrorType.PropertyInvalidField", "PropertyInvalidValue": "@roblox/enum/FilterErrorType.PropertyInvalidValue", "PropertyUnsupportedFields": "@roblox/enum/FilterErrorType.PropertyUnsupportedFields", "PropertyUnsupportedProperty": "@roblox/enum/FilterErrorType.PropertyUnsupportedProperty", "UnexpectedNameIndex": "@roblox/enum/FilterErrorType.UnexpectedNameIndex", "UnexpectedToken": "@roblox/enum/FilterErrorType.UnexpectedToken", "UnfinishedBinaryOperator": "@roblox/enum/FilterErrorType.UnfinishedBinaryOperator", "UnfinishedQuote": "@roblox/enum/FilterErrorType.UnfinishedQuote", "UnknownBespokeFilter": "@roblox/enum/FilterErrorType.UnknownBespokeFilter", "WildcardInProperty": "@roblox/enum/FilterErrorType.WildcardInProperty" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FilterErrorType", "code_sample": "" }, "@roblox/enum/SortOrder.Name": { "documentation": "Elements are ordered by their Instance.Name in alphanumeric order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortOrder#Name", "code_sample": "" }, "@roblox/enum/SortOrder.Custom": { "documentation": "Deprecated:
Elements are ordered by the function passed to UIGridStyleLayout:SetCustomSortFunction().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortOrder#Custom", "code_sample": "" }, "@roblox/enum/SortOrder.LayoutOrder": { "documentation": "Elements are ordered by GuiObject.LayoutOrder in ascending order; for example 0 will be placed before 1.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortOrder#LayoutOrder", "code_sample": "" }, "@roblox/global/Enum.SortOrder": { "documentation": "Used by UIGridStyleLayout.SortOrder to order the elements in the layout.", "keys": { "Name": "@roblox/enum/SortOrder.Name", "Custom": "@roblox/enum/SortOrder.Custom", "LayoutOrder": "@roblox/enum/SortOrder.LayoutOrder" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortOrder", "code_sample": "" }, "@roblox/enum/WhisperChatPrivacyMode.AllUsers": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WhisperChatPrivacyMode#AllUsers", "code_sample": "" }, "@roblox/enum/WhisperChatPrivacyMode.NoOne": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WhisperChatPrivacyMode#NoOne", "code_sample": "" }, "@roblox/global/Enum.WhisperChatPrivacyMode": { "documentation": "", "keys": { "AllUsers": "@roblox/enum/WhisperChatPrivacyMode.AllUsers", "NoOne": "@roblox/enum/WhisperChatPrivacyMode.NoOne" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WhisperChatPrivacyMode", "code_sample": "" }, "@roblox/enum/TextTruncate.None": { "documentation": "Text is not truncated.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextTruncate#None", "code_sample": "" }, "@roblox/enum/TextTruncate.AtEnd": { "documentation": "Text is truncated at the end of the text; extra graphemes that cannot fit into the space are replaced with .... Word boundaries are respected if possible. For example, if the control is between -> and <- like so: ->Long text is truncated at the en<-d of the last complete word The text will be: Long text is truncated at the...", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextTruncate#AtEnd", "code_sample": "" }, "@roblox/enum/TextTruncate.SplitWord": { "documentation": "If the end of the line occurs in the middle of a word, the text is truncated inside of that word. Extra graphemes that cannot fit into the space are replaced with .... For example, if the control is between -> and <- like so: ->Long text is truncated at the en<-d of the last complete word The text will be: Long text is truncated at the en...", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextTruncate#SplitWord", "code_sample": "" }, "@roblox/global/Enum.TextTruncate": { "documentation": "Controls the truncation of text when using the TextTruncate property.", "keys": { "None": "@roblox/enum/TextTruncate.None", "AtEnd": "@roblox/enum/TextTruncate.AtEnd", "SplitWord": "@roblox/enum/TextTruncate.SplitWord" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextTruncate", "code_sample": "" }, "@roblox/enum/DisplaySize.Small": { "documentation": "Viewport is categorized as small. Applies to most tablet/mobile/handheld devices.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Small", "code_sample": "" }, "@roblox/enum/DisplaySize.Medium": { "documentation": "Viewport is categorized as medium. Applies to most laptops and monitors.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Medium", "code_sample": "" }, "@roblox/enum/DisplaySize.Large": { "documentation": "Viewport is categorized as large. Applies to most TVs or larger.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DisplaySize#Large", "code_sample": "" }, "@roblox/global/Enum.DisplaySize": { "documentation": "This enum is used with GuiService.ViewportDisplaySize to indicate the internally-categorized rendering size of the viewport.", "keys": { "Small": "@roblox/enum/DisplaySize.Small", "Medium": "@roblox/enum/DisplaySize.Medium", "Large": "@roblox/enum/DisplaySize.Large" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DisplaySize", "code_sample": "" }, "@roblox/enum/CameraType.Fixed": { "documentation": "Camera is stationary.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Fixed", "code_sample": "" }, "@roblox/enum/CameraType.Attach": { "documentation": "Camera moves with the subject at a fixed offset and will rotate as the subject rotates.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Attach", "code_sample": "" }, "@roblox/enum/CameraType.Watch": { "documentation": "Camera is stationary but will rotate to keep the subject in the center of the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Watch", "code_sample": "" }, "@roblox/enum/CameraType.Track": { "documentation": "Camera moves with the subject but does not rotate automatically.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Track", "code_sample": "" }, "@roblox/enum/CameraType.Follow": { "documentation": "Camera moves with the subject and rotates to keep the subject in the center.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Follow", "code_sample": "" }, "@roblox/enum/CameraType.Custom": { "documentation": "Default mode used by Roblox core scripts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Custom", "code_sample": "" }, "@roblox/enum/CameraType.Scriptable": { "documentation": "No default behavior. Used when developers need to script custom behavior.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Scriptable", "code_sample": "" }, "@roblox/enum/CameraType.Orbital": { "documentation": "The camera has a fixed Y position, but can be rotated around the player.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType#Orbital", "code_sample": "" }, "@roblox/global/Enum.CameraType": { "documentation": "Describes the camera behavior mode if using the default PlayerScripts.", "keys": { "Fixed": "@roblox/enum/CameraType.Fixed", "Attach": "@roblox/enum/CameraType.Attach", "Watch": "@roblox/enum/CameraType.Watch", "Track": "@roblox/enum/CameraType.Track", "Follow": "@roblox/enum/CameraType.Follow", "Custom": "@roblox/enum/CameraType.Custom", "Scriptable": "@roblox/enum/CameraType.Scriptable", "Orbital": "@roblox/enum/CameraType.Orbital" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraType", "code_sample": "" }, "@roblox/enum/OrientationAlignmentMode.OneAttachment": { "documentation": "Use one attachment.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OrientationAlignmentMode#OneAttachment", "code_sample": "" }, "@roblox/enum/OrientationAlignmentMode.TwoAttachment": { "documentation": "Use two attachments.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OrientationAlignmentMode#TwoAttachment", "code_sample": "" }, "@roblox/global/Enum.OrientationAlignmentMode": { "documentation": "The OrientationAlignmentMode Enum is used to select the number of Attachments used in an alignment.", "keys": { "OneAttachment": "@roblox/enum/OrientationAlignmentMode.OneAttachment", "TwoAttachment": "@roblox/enum/OrientationAlignmentMode.TwoAttachment" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OrientationAlignmentMode", "code_sample": "" }, "@roblox/enum/AudioSubType.Music": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioSubType#Music", "code_sample": "" }, "@roblox/enum/AudioSubType.SoundEffect": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioSubType#SoundEffect", "code_sample": "" }, "@roblox/global/Enum.AudioSubType": { "documentation": "", "keys": { "Music": "@roblox/enum/AudioSubType.Music", "SoundEffect": "@roblox/enum/AudioSubType.SoundEffect" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioSubType", "code_sample": "" }, "@roblox/enum/MeshScaleUnit.Stud": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit#Stud", "code_sample": "" }, "@roblox/enum/MeshScaleUnit.Meter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit#Meter", "code_sample": "" }, "@roblox/enum/MeshScaleUnit.CM": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit#CM", "code_sample": "" }, "@roblox/enum/MeshScaleUnit.MM": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit#MM", "code_sample": "" }, "@roblox/enum/MeshScaleUnit.Foot": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit#Foot", "code_sample": "" }, "@roblox/enum/MeshScaleUnit.Inch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit#Inch", "code_sample": "" }, "@roblox/global/Enum.MeshScaleUnit": { "documentation": "", "keys": { "Stud": "@roblox/enum/MeshScaleUnit.Stud", "Meter": "@roblox/enum/MeshScaleUnit.Meter", "CM": "@roblox/enum/MeshScaleUnit.CM", "MM": "@roblox/enum/MeshScaleUnit.MM", "Foot": "@roblox/enum/MeshScaleUnit.Foot", "Inch": "@roblox/enum/MeshScaleUnit.Inch" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshScaleUnit", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.Success": { "documentation": "The item is purchased successfully.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#Success", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.SystemError": { "documentation": "Unable to purchase item due to Roblox system error.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#SystemError", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.AlreadyOwned": { "documentation": "Unable to purchase item because user already owns the item. Users can only own one copy of non-limited item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#AlreadyOwned", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.InsufficientRobux": { "documentation": "Unable to purchase item because of insufficient Robux.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#InsufficientRobux", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.QuantityLimitExceeded": { "documentation": "User has reached the max quantity allowed per user set by the creator for limited items.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#QuantityLimitExceeded", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.QuotaExceeded": { "documentation": "The user has exceeded our purchase request limit.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#QuotaExceeded", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.NotForSale": { "documentation": "Item is not for sale.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#NotForSale", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.NotAvailableForPurchaser": { "documentation": "This item is restricted to a group of users and the purchaser is not in this group.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#NotAvailableForPurchaser", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.PriceMismatch": { "documentation": "The provided price does not match the item price. Most likely the price changed since displayed to the user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#PriceMismatch", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.SoldOut": { "documentation": "The item is sold out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#SoldOut", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.PurchaserIsSeller": { "documentation": "The purchaser is the same user as the seller, for a resale purchase.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#PurchaserIsSeller", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.InsufficientMembership": { "documentation": "The user does not have sufficient premium membership to purchase this item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#InsufficientMembership", "code_sample": "" }, "@roblox/enum/MarketplaceItemPurchaseStatus.PlaceInvalid": { "documentation": "The item is not allowed to be sold in the place.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus#PlaceInvalid", "code_sample": "" }, "@roblox/global/Enum.MarketplaceItemPurchaseStatus": { "documentation": "The status of the item purchase through MarketplaceService.", "keys": { "Success": "@roblox/enum/MarketplaceItemPurchaseStatus.Success", "SystemError": "@roblox/enum/MarketplaceItemPurchaseStatus.SystemError", "AlreadyOwned": "@roblox/enum/MarketplaceItemPurchaseStatus.AlreadyOwned", "InsufficientRobux": "@roblox/enum/MarketplaceItemPurchaseStatus.InsufficientRobux", "QuantityLimitExceeded": "@roblox/enum/MarketplaceItemPurchaseStatus.QuantityLimitExceeded", "QuotaExceeded": "@roblox/enum/MarketplaceItemPurchaseStatus.QuotaExceeded", "NotForSale": "@roblox/enum/MarketplaceItemPurchaseStatus.NotForSale", "NotAvailableForPurchaser": "@roblox/enum/MarketplaceItemPurchaseStatus.NotAvailableForPurchaser", "PriceMismatch": "@roblox/enum/MarketplaceItemPurchaseStatus.PriceMismatch", "SoldOut": "@roblox/enum/MarketplaceItemPurchaseStatus.SoldOut", "PurchaserIsSeller": "@roblox/enum/MarketplaceItemPurchaseStatus.PurchaserIsSeller", "InsufficientMembership": "@roblox/enum/MarketplaceItemPurchaseStatus.InsufficientMembership", "PlaceInvalid": "@roblox/enum/MarketplaceItemPurchaseStatus.PlaceInvalid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MarketplaceItemPurchaseStatus", "code_sample": "" }, "@roblox/enum/WeldConstraintPreserve.All": { "documentation": "All WeldConstraints will be returned in the recommended table.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WeldConstraintPreserve#All", "code_sample": "" }, "@roblox/enum/WeldConstraintPreserve.None": { "documentation": "WeldConstraints will be ignored and not returned in the recommended table.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WeldConstraintPreserve#None", "code_sample": "" }, "@roblox/enum/WeldConstraintPreserve.Touching": { "documentation": "Only WeldConstraints that connect touching parts in the performed operation will be returned in the recommended table.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WeldConstraintPreserve#Touching", "code_sample": "" }, "@roblox/global/Enum.WeldConstraintPreserve": { "documentation": "", "keys": { "All": "@roblox/enum/WeldConstraintPreserve.All", "None": "@roblox/enum/WeldConstraintPreserve.None", "Touching": "@roblox/enum/WeldConstraintPreserve.Touching" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WeldConstraintPreserve", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.MainBackground": { "documentation": "The primary background color used by the toolbar and windows.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#MainBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Titlebar": { "documentation": "The color of windows' title bars.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Titlebar", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Dropdown": { "documentation": "The color of dropdown menus, like those found in the Properties window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Dropdown", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Tooltip": { "documentation": "The background color of tooltips, like those seen when hovering over buttons on the toolbar or properties in the Properties window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Tooltip", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Notification": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Notification", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScrollBar": { "documentation": "The color of scrollbar handles, like those seen in the Explorer window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScrollBar", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScrollBarBackground": { "documentation": "The background color of scrollbars, like those seen in the Explorer window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScrollBarBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.TabBar": { "documentation": "The background color of the tab bar, like the one where the script editor is opened.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#TabBar", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Tab": { "documentation": "The color of tabs on the tab bar, like the ones opened when the script editor is opened.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Tab", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.FilterButtonDefault": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#FilterButtonDefault", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.FilterButtonHover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#FilterButtonHover", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.FilterButtonChecked": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#FilterButtonChecked", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.FilterButtonAccent": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#FilterButtonAccent", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.FilterButtonBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#FilterButtonBorder", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.FilterButtonBorderAlt": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#FilterButtonBorderAlt", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.RibbonTab": { "documentation": "The color of a tab on the toolbar menu.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#RibbonTab", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.RibbonTabTopBar": { "documentation": "The background color of the toolbar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#RibbonTabTopBar", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Button": { "documentation": "The background color of clickable buttons.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Button", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.MainButton": { "documentation": "The background color of clickable buttons that are the primary action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#MainButton", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.RibbonButton": { "documentation": "The background color of buttons on the toolbar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#RibbonButton", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ViewPortBackground": { "documentation": "The background color of the game viewport.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ViewPortBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.InputFieldBackground": { "documentation": "The background color of input fields, like those found in the Explorer window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#InputFieldBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Item": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Item", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.TableItem": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#TableItem", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.CategoryItem": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#CategoryItem", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.GameSettingsTableItem": { "documentation": "The color of items within tables in the settings window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#GameSettingsTableItem", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.GameSettingsTooltip": { "documentation": "The color of tooltips in the settings window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#GameSettingsTooltip", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.EmulatorBar": { "documentation": "The color of the bar shown when the mobile emulator is active.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#EmulatorBar", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.EmulatorDropDown": { "documentation": "The color of the device and physical size dropdowns in the emulator bar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#EmulatorDropDown", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ColorPickerFrame": { "documentation": "The background color of the color picker.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ColorPickerFrame", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.CurrentMarker": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#CurrentMarker", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Border": { "documentation": "The color of borders, like those found in the Properties window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Border", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DropShadow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DropShadow", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Shadow": { "documentation": "The color of shadows rendered under floating items like dropdowns.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Shadow", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Light": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Light", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Dark": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Dark", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Mid": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Mid", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.MainText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#MainText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.SubText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#SubText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.TitlebarText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#TitlebarText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.BrightText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#BrightText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DimmedText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DimmedText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.LinkText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#LinkText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.WarningText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#WarningText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ErrorText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ErrorText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.InfoText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#InfoText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.SensitiveText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#SensitiveText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptSideWidget": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptSideWidget", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptSelectionText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptSelectionText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptSelectionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptSelectionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptFindSelectionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptFindSelectionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptMatchingWordSelectionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptMatchingWordSelectionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptOperator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptOperator", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptNumber": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptNumber", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptString": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptString", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptComment": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptComment", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptKeyword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptKeyword", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptBuiltInFunction": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptBuiltInFunction", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptWarning": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptWarning", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptError", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptInformation": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptInformation", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptHint": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptHint", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptWhitespace": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptWhitespace", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptRuler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptRuler", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DocViewCodeBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DocViewCodeBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DebuggerCurrentLine": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DebuggerCurrentLine", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DebuggerErrorLine": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DebuggerErrorLine", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffFilePathText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffFilePathText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextHunkInfo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextHunkInfo", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextNoChange": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextNoChange", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextAddition": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextAddition", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextDeletion": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextDeletion", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextSeparatorBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextSeparatorBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextNoChangeBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextNoChangeBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextAdditionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextAdditionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffTextDeletionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffTextDeletionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNum": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNum", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNumSeparatorBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNumSeparatorBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNumNoChangeBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNumNoChangeBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNumAdditionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNumAdditionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNumDeletionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNumDeletionBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffFilePathBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffFilePathBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffFilePathBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffFilePathBorder", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ChatIncomingBgColor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ChatIncomingBgColor", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ChatIncomingTextColor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ChatIncomingTextColor", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ChatOutgoingBgColor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ChatOutgoingBgColor", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ChatOutgoingTextColor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ChatOutgoingTextColor", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ChatModeratedMessageColor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ChatModeratedMessageColor", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Separator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Separator", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ButtonBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ButtonBorder", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ButtonText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ButtonText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.InputFieldBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#InputFieldBorder", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.CheckedFieldBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#CheckedFieldBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.CheckedFieldBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#CheckedFieldBorder", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.CheckedFieldIndicator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#CheckedFieldIndicator", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.HeaderSection": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#HeaderSection", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.Midlight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#Midlight", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.StatusBar": { "documentation": "The color of the status bar shown at the bottom of Studio, if it is visible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#StatusBar", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DialogButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DialogButton", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DialogButtonText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DialogButtonText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DialogButtonBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DialogButtonBorder", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DialogMainButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DialogMainButton", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DialogMainButtonText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DialogMainButtonText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.InfoBarWarningBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#InfoBarWarningBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.InfoBarWarningText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#InfoBarWarningText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptEditorCurrentLine": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptEditorCurrentLine", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptMethod": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptMethod", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptProperty": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptProperty", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptNil": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptNil", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptBool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptBool", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptFunction": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptFunction", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptLocal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptLocal", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptSelf": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptSelf", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptLuauKeyword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptLuauKeyword", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptFunctionName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptFunctionName", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptTodo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptTodo", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.ScriptBracket": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#ScriptBracket", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.AttributeCog": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#AttributeCog", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.AICOOverlayText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#AICOOverlayText", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.AICOOverlayButtonBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#AICOOverlayButtonBackground", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.AICOOverlayButtonBackgroundHover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#AICOOverlayButtonBackgroundHover", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.AICOOverlayButtonBackgroundPressed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#AICOOverlayButtonBackgroundPressed", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.OnboardingCover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#OnboardingCover", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.OnboardingHighlight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#OnboardingHighlight", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.OnboardingShadow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#OnboardingShadow", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.BreakpointMarker": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#BreakpointMarker", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNumHover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNumHover", "code_sample": "" }, "@roblox/enum/StudioStyleGuideColor.DiffLineNumSeparatorBackgroundHover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor#DiffLineNumSeparatorBackgroundHover", "code_sample": "" }, "@roblox/global/Enum.StudioStyleGuideColor": { "documentation": "", "keys": { "MainBackground": "@roblox/enum/StudioStyleGuideColor.MainBackground", "Titlebar": "@roblox/enum/StudioStyleGuideColor.Titlebar", "Dropdown": "@roblox/enum/StudioStyleGuideColor.Dropdown", "Tooltip": "@roblox/enum/StudioStyleGuideColor.Tooltip", "Notification": "@roblox/enum/StudioStyleGuideColor.Notification", "ScrollBar": "@roblox/enum/StudioStyleGuideColor.ScrollBar", "ScrollBarBackground": "@roblox/enum/StudioStyleGuideColor.ScrollBarBackground", "TabBar": "@roblox/enum/StudioStyleGuideColor.TabBar", "Tab": "@roblox/enum/StudioStyleGuideColor.Tab", "FilterButtonDefault": "@roblox/enum/StudioStyleGuideColor.FilterButtonDefault", "FilterButtonHover": "@roblox/enum/StudioStyleGuideColor.FilterButtonHover", "FilterButtonChecked": "@roblox/enum/StudioStyleGuideColor.FilterButtonChecked", "FilterButtonAccent": "@roblox/enum/StudioStyleGuideColor.FilterButtonAccent", "FilterButtonBorder": "@roblox/enum/StudioStyleGuideColor.FilterButtonBorder", "FilterButtonBorderAlt": "@roblox/enum/StudioStyleGuideColor.FilterButtonBorderAlt", "RibbonTab": "@roblox/enum/StudioStyleGuideColor.RibbonTab", "RibbonTabTopBar": "@roblox/enum/StudioStyleGuideColor.RibbonTabTopBar", "Button": "@roblox/enum/StudioStyleGuideColor.Button", "MainButton": "@roblox/enum/StudioStyleGuideColor.MainButton", "RibbonButton": "@roblox/enum/StudioStyleGuideColor.RibbonButton", "ViewPortBackground": "@roblox/enum/StudioStyleGuideColor.ViewPortBackground", "InputFieldBackground": "@roblox/enum/StudioStyleGuideColor.InputFieldBackground", "Item": "@roblox/enum/StudioStyleGuideColor.Item", "TableItem": "@roblox/enum/StudioStyleGuideColor.TableItem", "CategoryItem": "@roblox/enum/StudioStyleGuideColor.CategoryItem", "GameSettingsTableItem": "@roblox/enum/StudioStyleGuideColor.GameSettingsTableItem", "GameSettingsTooltip": "@roblox/enum/StudioStyleGuideColor.GameSettingsTooltip", "EmulatorBar": "@roblox/enum/StudioStyleGuideColor.EmulatorBar", "EmulatorDropDown": "@roblox/enum/StudioStyleGuideColor.EmulatorDropDown", "ColorPickerFrame": "@roblox/enum/StudioStyleGuideColor.ColorPickerFrame", "CurrentMarker": "@roblox/enum/StudioStyleGuideColor.CurrentMarker", "Border": "@roblox/enum/StudioStyleGuideColor.Border", "DropShadow": "@roblox/enum/StudioStyleGuideColor.DropShadow", "Shadow": "@roblox/enum/StudioStyleGuideColor.Shadow", "Light": "@roblox/enum/StudioStyleGuideColor.Light", "Dark": "@roblox/enum/StudioStyleGuideColor.Dark", "Mid": "@roblox/enum/StudioStyleGuideColor.Mid", "MainText": "@roblox/enum/StudioStyleGuideColor.MainText", "SubText": "@roblox/enum/StudioStyleGuideColor.SubText", "TitlebarText": "@roblox/enum/StudioStyleGuideColor.TitlebarText", "BrightText": "@roblox/enum/StudioStyleGuideColor.BrightText", "DimmedText": "@roblox/enum/StudioStyleGuideColor.DimmedText", "LinkText": "@roblox/enum/StudioStyleGuideColor.LinkText", "WarningText": "@roblox/enum/StudioStyleGuideColor.WarningText", "ErrorText": "@roblox/enum/StudioStyleGuideColor.ErrorText", "InfoText": "@roblox/enum/StudioStyleGuideColor.InfoText", "SensitiveText": "@roblox/enum/StudioStyleGuideColor.SensitiveText", "ScriptSideWidget": "@roblox/enum/StudioStyleGuideColor.ScriptSideWidget", "ScriptBackground": "@roblox/enum/StudioStyleGuideColor.ScriptBackground", "ScriptText": "@roblox/enum/StudioStyleGuideColor.ScriptText", "ScriptSelectionText": "@roblox/enum/StudioStyleGuideColor.ScriptSelectionText", "ScriptSelectionBackground": "@roblox/enum/StudioStyleGuideColor.ScriptSelectionBackground", "ScriptFindSelectionBackground": "@roblox/enum/StudioStyleGuideColor.ScriptFindSelectionBackground", "ScriptMatchingWordSelectionBackground": "@roblox/enum/StudioStyleGuideColor.ScriptMatchingWordSelectionBackground", "ScriptOperator": "@roblox/enum/StudioStyleGuideColor.ScriptOperator", "ScriptNumber": "@roblox/enum/StudioStyleGuideColor.ScriptNumber", "ScriptString": "@roblox/enum/StudioStyleGuideColor.ScriptString", "ScriptComment": "@roblox/enum/StudioStyleGuideColor.ScriptComment", "ScriptKeyword": "@roblox/enum/StudioStyleGuideColor.ScriptKeyword", "ScriptBuiltInFunction": "@roblox/enum/StudioStyleGuideColor.ScriptBuiltInFunction", "ScriptWarning": "@roblox/enum/StudioStyleGuideColor.ScriptWarning", "ScriptError": "@roblox/enum/StudioStyleGuideColor.ScriptError", "ScriptInformation": "@roblox/enum/StudioStyleGuideColor.ScriptInformation", "ScriptHint": "@roblox/enum/StudioStyleGuideColor.ScriptHint", "ScriptWhitespace": "@roblox/enum/StudioStyleGuideColor.ScriptWhitespace", "ScriptRuler": "@roblox/enum/StudioStyleGuideColor.ScriptRuler", "DocViewCodeBackground": "@roblox/enum/StudioStyleGuideColor.DocViewCodeBackground", "DebuggerCurrentLine": "@roblox/enum/StudioStyleGuideColor.DebuggerCurrentLine", "DebuggerErrorLine": "@roblox/enum/StudioStyleGuideColor.DebuggerErrorLine", "DiffFilePathText": "@roblox/enum/StudioStyleGuideColor.DiffFilePathText", "DiffTextHunkInfo": "@roblox/enum/StudioStyleGuideColor.DiffTextHunkInfo", "DiffTextNoChange": "@roblox/enum/StudioStyleGuideColor.DiffTextNoChange", "DiffTextAddition": "@roblox/enum/StudioStyleGuideColor.DiffTextAddition", "DiffTextDeletion": "@roblox/enum/StudioStyleGuideColor.DiffTextDeletion", "DiffTextSeparatorBackground": "@roblox/enum/StudioStyleGuideColor.DiffTextSeparatorBackground", "DiffTextNoChangeBackground": "@roblox/enum/StudioStyleGuideColor.DiffTextNoChangeBackground", "DiffTextAdditionBackground": "@roblox/enum/StudioStyleGuideColor.DiffTextAdditionBackground", "DiffTextDeletionBackground": "@roblox/enum/StudioStyleGuideColor.DiffTextDeletionBackground", "DiffLineNum": "@roblox/enum/StudioStyleGuideColor.DiffLineNum", "DiffLineNumSeparatorBackground": "@roblox/enum/StudioStyleGuideColor.DiffLineNumSeparatorBackground", "DiffLineNumNoChangeBackground": "@roblox/enum/StudioStyleGuideColor.DiffLineNumNoChangeBackground", "DiffLineNumAdditionBackground": "@roblox/enum/StudioStyleGuideColor.DiffLineNumAdditionBackground", "DiffLineNumDeletionBackground": "@roblox/enum/StudioStyleGuideColor.DiffLineNumDeletionBackground", "DiffFilePathBackground": "@roblox/enum/StudioStyleGuideColor.DiffFilePathBackground", "DiffFilePathBorder": "@roblox/enum/StudioStyleGuideColor.DiffFilePathBorder", "ChatIncomingBgColor": "@roblox/enum/StudioStyleGuideColor.ChatIncomingBgColor", "ChatIncomingTextColor": "@roblox/enum/StudioStyleGuideColor.ChatIncomingTextColor", "ChatOutgoingBgColor": "@roblox/enum/StudioStyleGuideColor.ChatOutgoingBgColor", "ChatOutgoingTextColor": "@roblox/enum/StudioStyleGuideColor.ChatOutgoingTextColor", "ChatModeratedMessageColor": "@roblox/enum/StudioStyleGuideColor.ChatModeratedMessageColor", "Separator": "@roblox/enum/StudioStyleGuideColor.Separator", "ButtonBorder": "@roblox/enum/StudioStyleGuideColor.ButtonBorder", "ButtonText": "@roblox/enum/StudioStyleGuideColor.ButtonText", "InputFieldBorder": "@roblox/enum/StudioStyleGuideColor.InputFieldBorder", "CheckedFieldBackground": "@roblox/enum/StudioStyleGuideColor.CheckedFieldBackground", "CheckedFieldBorder": "@roblox/enum/StudioStyleGuideColor.CheckedFieldBorder", "CheckedFieldIndicator": "@roblox/enum/StudioStyleGuideColor.CheckedFieldIndicator", "HeaderSection": "@roblox/enum/StudioStyleGuideColor.HeaderSection", "Midlight": "@roblox/enum/StudioStyleGuideColor.Midlight", "StatusBar": "@roblox/enum/StudioStyleGuideColor.StatusBar", "DialogButton": "@roblox/enum/StudioStyleGuideColor.DialogButton", "DialogButtonText": "@roblox/enum/StudioStyleGuideColor.DialogButtonText", "DialogButtonBorder": "@roblox/enum/StudioStyleGuideColor.DialogButtonBorder", "DialogMainButton": "@roblox/enum/StudioStyleGuideColor.DialogMainButton", "DialogMainButtonText": "@roblox/enum/StudioStyleGuideColor.DialogMainButtonText", "InfoBarWarningBackground": "@roblox/enum/StudioStyleGuideColor.InfoBarWarningBackground", "InfoBarWarningText": "@roblox/enum/StudioStyleGuideColor.InfoBarWarningText", "ScriptEditorCurrentLine": "@roblox/enum/StudioStyleGuideColor.ScriptEditorCurrentLine", "ScriptMethod": "@roblox/enum/StudioStyleGuideColor.ScriptMethod", "ScriptProperty": "@roblox/enum/StudioStyleGuideColor.ScriptProperty", "ScriptNil": "@roblox/enum/StudioStyleGuideColor.ScriptNil", "ScriptBool": "@roblox/enum/StudioStyleGuideColor.ScriptBool", "ScriptFunction": "@roblox/enum/StudioStyleGuideColor.ScriptFunction", "ScriptLocal": "@roblox/enum/StudioStyleGuideColor.ScriptLocal", "ScriptSelf": "@roblox/enum/StudioStyleGuideColor.ScriptSelf", "ScriptLuauKeyword": "@roblox/enum/StudioStyleGuideColor.ScriptLuauKeyword", "ScriptFunctionName": "@roblox/enum/StudioStyleGuideColor.ScriptFunctionName", "ScriptTodo": "@roblox/enum/StudioStyleGuideColor.ScriptTodo", "ScriptBracket": "@roblox/enum/StudioStyleGuideColor.ScriptBracket", "AttributeCog": "@roblox/enum/StudioStyleGuideColor.AttributeCog", "AICOOverlayText": "@roblox/enum/StudioStyleGuideColor.AICOOverlayText", "AICOOverlayButtonBackground": "@roblox/enum/StudioStyleGuideColor.AICOOverlayButtonBackground", "AICOOverlayButtonBackgroundHover": "@roblox/enum/StudioStyleGuideColor.AICOOverlayButtonBackgroundHover", "AICOOverlayButtonBackgroundPressed": "@roblox/enum/StudioStyleGuideColor.AICOOverlayButtonBackgroundPressed", "OnboardingCover": "@roblox/enum/StudioStyleGuideColor.OnboardingCover", "OnboardingHighlight": "@roblox/enum/StudioStyleGuideColor.OnboardingHighlight", "OnboardingShadow": "@roblox/enum/StudioStyleGuideColor.OnboardingShadow", "BreakpointMarker": "@roblox/enum/StudioStyleGuideColor.BreakpointMarker", "DiffLineNumHover": "@roblox/enum/StudioStyleGuideColor.DiffLineNumHover", "DiffLineNumSeparatorBackgroundHover": "@roblox/enum/StudioStyleGuideColor.DiffLineNumSeparatorBackgroundHover" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideColor", "code_sample": "" }, "@roblox/enum/StepFrequency.Hz60": { "documentation": "The bound function is called at 60 Hz.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz60", "code_sample": "" }, "@roblox/enum/StepFrequency.Hz30": { "documentation": "The bound function is called at 30 Hz.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz30", "code_sample": "" }, "@roblox/enum/StepFrequency.Hz15": { "documentation": "The bound function is called at 15 Hz.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz15", "code_sample": "" }, "@roblox/enum/StepFrequency.Hz10": { "documentation": "The bound function is called at 10 Hz.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz10", "code_sample": "" }, "@roblox/enum/StepFrequency.Hz5": { "documentation": "The bound function is called at 5 Hz.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz5", "code_sample": "" }, "@roblox/enum/StepFrequency.Hz1": { "documentation": "The bound function is called at 1 Hz.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency#Hz1", "code_sample": "" }, "@roblox/global/Enum.StepFrequency": { "documentation": "Enum used with RunService:BindToSimulation() to indicate the frequency at which the bound function is called.", "keys": { "Hz60": "@roblox/enum/StepFrequency.Hz60", "Hz30": "@roblox/enum/StepFrequency.Hz30", "Hz15": "@roblox/enum/StepFrequency.Hz15", "Hz10": "@roblox/enum/StepFrequency.Hz10", "Hz5": "@roblox/enum/StepFrequency.Hz5", "Hz1": "@roblox/enum/StepFrequency.Hz1" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StepFrequency", "code_sample": "" }, "@roblox/enum/AdUnitStatus.Inactive": { "documentation": "The ad unit isn't currently serving an ad and it may be configured incorrectly. An AdGui with this status will display its fallback image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUnitStatus#Inactive", "code_sample": "" }, "@roblox/enum/AdUnitStatus.Active": { "documentation": "The ad unit is currently serving an ad. Players will observe sponsored content in an AdGui and an AdPortal will teleport users that walk through.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUnitStatus#Active", "code_sample": "" }, "@roblox/global/Enum.AdUnitStatus": { "documentation": "Exposes the status of an immersive ad.", "keys": { "Inactive": "@roblox/enum/AdUnitStatus.Inactive", "Active": "@roblox/enum/AdUnitStatus.Active" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUnitStatus", "code_sample": "" }, "@roblox/enum/AdUIType.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIType#None", "code_sample": "" }, "@roblox/enum/AdUIType.Image": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIType#Image", "code_sample": "" }, "@roblox/enum/AdUIType.Video": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIType#Video", "code_sample": "" }, "@roblox/global/Enum.AdUIType": { "documentation": "", "keys": { "None": "@roblox/enum/AdUIType.None", "Image": "@roblox/enum/AdUIType.Image", "Video": "@roblox/enum/AdUIType.Video" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdUIType", "code_sample": "" }, "@roblox/enum/RecommendationImpressionType.View": { "documentation": "A complete view of the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationImpressionType#View", "code_sample": "" }, "@roblox/enum/RecommendationImpressionType.NotViewable": { "documentation": "The item has failed to render.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationImpressionType#NotViewable", "code_sample": "" }, "@roblox/global/Enum.RecommendationImpressionType": { "documentation": "", "keys": { "View": "@roblox/enum/RecommendationImpressionType.View", "NotViewable": "@roblox/enum/RecommendationImpressionType.NotViewable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationImpressionType", "code_sample": "" }, "@roblox/enum/CollisionFidelity.Default": { "documentation": "Collision model uses a voxel-based convex-hull decomposition that is relatively fast but may not be highly accurate, especially for holes, doorways, and cavities in general.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Default", "code_sample": "" }, "@roblox/enum/CollisionFidelity.Hull": { "documentation": "Collision model uses the convex hull of the visual mesh.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Hull", "code_sample": "" }, "@roblox/enum/CollisionFidelity.Box": { "documentation": "Collision model uses a bounding box that encompasses the visual mesh.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#Box", "code_sample": "" }, "@roblox/enum/CollisionFidelity.PreciseConvexDecomposition": { "documentation": "Collison model uses a convex-hull decomposition of the visual mesh which is computed by a variation of an algorithm called HACD. This option is the most accurate representation of collision geometry for complex objects with built-in tolerances to reduce the total number of convex-hulls by compromising on accuracy when justified.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity#PreciseConvexDecomposition", "code_sample": "" }, "@roblox/global/Enum.CollisionFidelity": { "documentation": "Determines behavior of the collision hitbox for MeshPart and PartOperation instances.", "keys": { "Default": "@roblox/enum/CollisionFidelity.Default", "Hull": "@roblox/enum/CollisionFidelity.Hull", "Box": "@roblox/enum/CollisionFidelity.Box", "PreciseConvexDecomposition": "@roblox/enum/CollisionFidelity.PreciseConvexDecomposition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollisionFidelity", "code_sample": "" }, "@roblox/enum/TrackerMode.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerMode#None", "code_sample": "" }, "@roblox/enum/TrackerMode.Audio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerMode#Audio", "code_sample": "" }, "@roblox/enum/TrackerMode.Video": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerMode#Video", "code_sample": "" }, "@roblox/enum/TrackerMode.AudioVideo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerMode#AudioVideo", "code_sample": "" }, "@roblox/global/Enum.TrackerMode": { "documentation": "", "keys": { "None": "@roblox/enum/TrackerMode.None", "Audio": "@roblox/enum/TrackerMode.Audio", "Video": "@roblox/enum/TrackerMode.Video", "AudioVideo": "@roblox/enum/TrackerMode.AudioVideo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerMode", "code_sample": "" }, "@roblox/enum/TickCountSampleMethod.Fast": { "documentation": "Compute time using a faster, but less precise method.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TickCountSampleMethod#Fast", "code_sample": "" }, "@roblox/enum/TickCountSampleMethod.Benchmark": { "documentation": "Dynamically decide between using ''Fast'' and ''Precise'' depending on performance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TickCountSampleMethod#Benchmark", "code_sample": "" }, "@roblox/enum/TickCountSampleMethod.Precise": { "documentation": "Compute time using a precise method.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TickCountSampleMethod#Precise", "code_sample": "" }, "@roblox/global/Enum.TickCountSampleMethod": { "documentation": "Controls the precision of a timer.", "keys": { "Fast": "@roblox/enum/TickCountSampleMethod.Fast", "Benchmark": "@roblox/enum/TickCountSampleMethod.Benchmark", "Precise": "@roblox/enum/TickCountSampleMethod.Precise" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TickCountSampleMethod", "code_sample": "" }, "@roblox/enum/CellBlock.Solid": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellBlock#Solid", "code_sample": "" }, "@roblox/enum/CellBlock.VerticalWedge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellBlock#VerticalWedge", "code_sample": "" }, "@roblox/enum/CellBlock.CornerWedge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellBlock#CornerWedge", "code_sample": "" }, "@roblox/enum/CellBlock.InverseCornerWedge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellBlock#InverseCornerWedge", "code_sample": "" }, "@roblox/enum/CellBlock.HorizontalWedge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellBlock#HorizontalWedge", "code_sample": "" }, "@roblox/global/Enum.CellBlock": { "documentation": "", "keys": { "Solid": "@roblox/enum/CellBlock.Solid", "VerticalWedge": "@roblox/enum/CellBlock.VerticalWedge", "CornerWedge": "@roblox/enum/CellBlock.CornerWedge", "InverseCornerWedge": "@roblox/enum/CellBlock.InverseCornerWedge", "HorizontalWedge": "@roblox/enum/CellBlock.HorizontalWedge" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellBlock", "code_sample": "" }, "@roblox/enum/CaptureType.Screenshot": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CaptureType#Screenshot", "code_sample": "" }, "@roblox/enum/CaptureType.Video": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CaptureType#Video", "code_sample": "" }, "@roblox/global/Enum.CaptureType": { "documentation": "", "keys": { "Screenshot": "@roblox/enum/CaptureType.Screenshot", "Video": "@roblox/enum/CaptureType.Video" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CaptureType", "code_sample": "" }, "@roblox/enum/ViewMode.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ViewMode#None", "code_sample": "" }, "@roblox/enum/ViewMode.GeometryComplexity": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ViewMode#GeometryComplexity", "code_sample": "" }, "@roblox/enum/ViewMode.Transparent": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ViewMode#Transparent", "code_sample": "" }, "@roblox/enum/ViewMode.Decal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ViewMode#Decal", "code_sample": "" }, "@roblox/global/Enum.ViewMode": { "documentation": "", "keys": { "None": "@roblox/enum/ViewMode.None", "GeometryComplexity": "@roblox/enum/ViewMode.GeometryComplexity", "Transparent": "@roblox/enum/ViewMode.Transparent", "Decal": "@roblox/enum/ViewMode.Decal" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ViewMode", "code_sample": "" }, "@roblox/enum/FillDirection.Horizontal": { "documentation": "Fill in the left-to-right direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FillDirection#Horizontal", "code_sample": "" }, "@roblox/enum/FillDirection.Vertical": { "documentation": "Fill in the top-to-bottom direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FillDirection#Vertical", "code_sample": "" }, "@roblox/global/Enum.FillDirection": { "documentation": "Used by UIGridStyleLayout.FillDirection to control which direction elements are placed.", "keys": { "Horizontal": "@roblox/enum/FillDirection.Horizontal", "Vertical": "@roblox/enum/FillDirection.Vertical" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FillDirection", "code_sample": "" }, "@roblox/enum/StreamOutBehavior.Default": { "documentation": "Currently equivalent to LowMemory. This will eventually change to Opportunistic.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior#Default", "code_sample": "" }, "@roblox/enum/StreamOutBehavior.LowMemory": { "documentation": "Only stream out when memory is low.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior#LowMemory", "code_sample": "" }, "@roblox/enum/StreamOutBehavior.Opportunistic": { "documentation": "Stream out content that is significantly outside of the current StreamingRadius.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior#Opportunistic", "code_sample": "" }, "@roblox/global/Enum.StreamOutBehavior": { "documentation": "Determines how content is streamed away from Players.", "keys": { "Default": "@roblox/enum/StreamOutBehavior.Default", "LowMemory": "@roblox/enum/StreamOutBehavior.LowMemory", "Opportunistic": "@roblox/enum/StreamOutBehavior.Opportunistic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior", "code_sample": "" }, "@roblox/enum/JoinSource.CreatedItemAttribution": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/JoinSource#CreatedItemAttribution", "code_sample": "" }, "@roblox/global/Enum.JoinSource": { "documentation": "", "keys": { "CreatedItemAttribution": "@roblox/enum/JoinSource.CreatedItemAttribution" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/JoinSource", "code_sample": "" }, "@roblox/enum/CreatorType.User": { "documentation": "The place is owned by a single user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorType#User", "code_sample": "" }, "@roblox/enum/CreatorType.Group": { "documentation": "The place is owned by a group.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorType#Group", "code_sample": "" }, "@roblox/global/Enum.CreatorType": { "documentation": "", "keys": { "User": "@roblox/enum/CreatorType.User", "Group": "@roblox/enum/CreatorType.Group" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorType", "code_sample": "" }, "@roblox/enum/ActionOnStopSync.AlwaysAsk": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync#AlwaysAsk", "code_sample": "" }, "@roblox/enum/ActionOnStopSync.KeepLocalFiles": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync#KeepLocalFiles", "code_sample": "" }, "@roblox/enum/ActionOnStopSync.DeleteLocalFiles": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync#DeleteLocalFiles", "code_sample": "" }, "@roblox/global/Enum.ActionOnStopSync": { "documentation": "", "keys": { "AlwaysAsk": "@roblox/enum/ActionOnStopSync.AlwaysAsk", "KeepLocalFiles": "@roblox/enum/ActionOnStopSync.KeepLocalFiles", "DeleteLocalFiles": "@roblox/enum/ActionOnStopSync.DeleteLocalFiles" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnStopSync", "code_sample": "" }, "@roblox/enum/ClientAnimatorThrottlingMode.Default": { "documentation": "The default animation throttling mode defined by Roblox.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode#Default", "code_sample": "" }, "@roblox/enum/ClientAnimatorThrottlingMode.Disabled": { "documentation": "Disables animation throttling.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode#Disabled", "code_sample": "" }, "@roblox/enum/ClientAnimatorThrottlingMode.Enabled": { "documentation": "Enables animation throttling.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.ClientAnimatorThrottlingMode": { "documentation": "An Enum describing various animation throttling modes on clients.", "keys": { "Default": "@roblox/enum/ClientAnimatorThrottlingMode.Default", "Disabled": "@roblox/enum/ClientAnimatorThrottlingMode.Disabled", "Enabled": "@roblox/enum/ClientAnimatorThrottlingMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ClientAnimatorThrottlingMode", "code_sample": "" }, "@roblox/enum/ResamplerMode.Default": { "documentation": "Bilinear filtering of the four near pixels in the image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ResamplerMode#Default", "code_sample": "" }, "@roblox/enum/ResamplerMode.Pixelated": { "documentation": "Nearest neighbor filtering of the closest pixel in the image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ResamplerMode#Pixelated", "code_sample": "" }, "@roblox/global/Enum.ResamplerMode": { "documentation": "Determines the image filtering used.", "keys": { "Default": "@roblox/enum/ResamplerMode.Default", "Pixelated": "@roblox/enum/ResamplerMode.Pixelated" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ResamplerMode", "code_sample": "" }, "@roblox/enum/SurfaceConstraint.None": { "documentation": "No surface constraint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceConstraint#None", "code_sample": "" }, "@roblox/enum/SurfaceConstraint.Hinge": { "documentation": "Makes the side appear with a yellow hinge. Any part connected to this hinge will stick to the side and rotate using physics.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceConstraint#Hinge", "code_sample": "" }, "@roblox/enum/SurfaceConstraint.SteppingMotor": { "documentation": "Functions identically to a motor. It may have functioned differently in the past, but that functionality no longer seems to exist.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceConstraint#SteppingMotor", "code_sample": "" }, "@roblox/enum/SurfaceConstraint.Motor": { "documentation": "Acts the same as a Hinge, but has a grey ring around it and automatically rotates any part connected to it.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceConstraint#Motor", "code_sample": "" }, "@roblox/global/Enum.SurfaceConstraint": { "documentation": "This item is deprecated and is replaced by the SurfaceType enum.", "keys": { "None": "@roblox/enum/SurfaceConstraint.None", "Hinge": "@roblox/enum/SurfaceConstraint.Hinge", "SteppingMotor": "@roblox/enum/SurfaceConstraint.SteppingMotor", "Motor": "@roblox/enum/SurfaceConstraint.Motor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceConstraint", "code_sample": "" }, "@roblox/enum/VoiceChatDistanceAttenuationType.Inverse": { "documentation": "Represents a distance attenuation curve that follows the inverse-squared law. This is identical to the default distance attenuation of an AudioEmitter instance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatDistanceAttenuationType#Inverse", "code_sample": "" }, "@roblox/enum/VoiceChatDistanceAttenuationType.Legacy": { "documentation": "Represents a linear-squared distance attenuation curve with a minimum distance of 7 and a maximum distance of 80. This is identical to the distance attenuation used in the internal-only default voice setup that does not use AudioDeviceInput and AudioEmitter objects.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatDistanceAttenuationType#Legacy", "code_sample": "" }, "@roblox/global/Enum.VoiceChatDistanceAttenuationType": { "documentation": "Enum used for preset distance attenuation curve options in the default voice chat setup.", "keys": { "Inverse": "@roblox/enum/VoiceChatDistanceAttenuationType.Inverse", "Legacy": "@roblox/enum/VoiceChatDistanceAttenuationType.Legacy" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceChatDistanceAttenuationType", "code_sample": "" }, "@roblox/enum/SystemThemeValue.error": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SystemThemeValue#error", "code_sample": "" }, "@roblox/enum/SystemThemeValue.light": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SystemThemeValue#light", "code_sample": "" }, "@roblox/enum/SystemThemeValue.dark": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SystemThemeValue#dark", "code_sample": "" }, "@roblox/enum/SystemThemeValue.systemLight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SystemThemeValue#systemLight", "code_sample": "" }, "@roblox/enum/SystemThemeValue.systemDark": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SystemThemeValue#systemDark", "code_sample": "" }, "@roblox/global/Enum.SystemThemeValue": { "documentation": "", "keys": { "error": "@roblox/enum/SystemThemeValue.error", "light": "@roblox/enum/SystemThemeValue.light", "dark": "@roblox/enum/SystemThemeValue.dark", "systemLight": "@roblox/enum/SystemThemeValue.systemLight", "systemDark": "@roblox/enum/SystemThemeValue.systemDark" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SystemThemeValue", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Internal": { "documentation": "General data that doesn't have any categorization. This could be due to either internal reasons, or because it simply isn't being tracked categorically.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Internal", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.HttpCache": { "documentation": "A cache of HTTP responses.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#HttpCache", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Instances": { "documentation": "All the Instances present in memory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Instances", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Signals": { "documentation": "Events, signals, connections, etc.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Signals", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.LuaHeap": { "documentation": "All of the data in Luau, including everything happening in core scripts, built-in data types, etc.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#LuaHeap", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Script": { "documentation": "All memory being manipulated and referenced by scripts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Script", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.PhysicsCollision": { "documentation": "Collision detection in the Workspace.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#PhysicsCollision", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.BaseParts": { "documentation": "3D parts used for simulation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#BaseParts", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsSolidModels": { "documentation": "Rendering solid models (stuff made with Union, Negate, etc.).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsSolidModels", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsMeshParts": { "documentation": "Rendering of mesh parts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsMeshParts", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsParticles": { "documentation": "Rendering of particles from ParticleEmitters.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsParticles", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsParts": { "documentation": "Rendering of regular parts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsParts", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsSpatialHash": { "documentation": "Spatial hash lookup tables of the game world that are used for rendering.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsSpatialHash", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsTerrain": { "documentation": "Rendering of terrain geometry.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsTerrain", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsTexture": { "documentation": "Rendering of textures in the game world.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsTexture", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsTextureCharacter": { "documentation": "Rendering of texture composition maps that are generated for Humanoids.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsTextureCharacter", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Sounds": { "documentation": "Data of sounds in-game.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Sounds", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.StreamingSounds": { "documentation": "Playback of sounds in-game.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#StreamingSounds", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.TerrainVoxels": { "documentation": "Occupancy/Material data of the Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#TerrainVoxels", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Gui": { "documentation": "Gui element data and rendering.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Gui", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Animation": { "documentation": "Playback of Animations on Humanoids and AnimationControllers.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Animation", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.Navigation": { "documentation": "Pathfinding for Humanoids via the PathfindingService.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#Navigation", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GeometryCSG": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GeometryCSG", "code_sample": "" }, "@roblox/enum/DeveloperMemoryTag.GraphicsSlimModels": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag#GraphicsSlimModels", "code_sample": "" }, "@roblox/global/Enum.DeveloperMemoryTag": { "documentation": "A memory tracking category.", "keys": { "Internal": "@roblox/enum/DeveloperMemoryTag.Internal", "HttpCache": "@roblox/enum/DeveloperMemoryTag.HttpCache", "Instances": "@roblox/enum/DeveloperMemoryTag.Instances", "Signals": "@roblox/enum/DeveloperMemoryTag.Signals", "LuaHeap": "@roblox/enum/DeveloperMemoryTag.LuaHeap", "Script": "@roblox/enum/DeveloperMemoryTag.Script", "PhysicsCollision": "@roblox/enum/DeveloperMemoryTag.PhysicsCollision", "BaseParts": "@roblox/enum/DeveloperMemoryTag.BaseParts", "GraphicsSolidModels": "@roblox/enum/DeveloperMemoryTag.GraphicsSolidModels", "GraphicsMeshParts": "@roblox/enum/DeveloperMemoryTag.GraphicsMeshParts", "GraphicsParticles": "@roblox/enum/DeveloperMemoryTag.GraphicsParticles", "GraphicsParts": "@roblox/enum/DeveloperMemoryTag.GraphicsParts", "GraphicsSpatialHash": "@roblox/enum/DeveloperMemoryTag.GraphicsSpatialHash", "GraphicsTerrain": "@roblox/enum/DeveloperMemoryTag.GraphicsTerrain", "GraphicsTexture": "@roblox/enum/DeveloperMemoryTag.GraphicsTexture", "GraphicsTextureCharacter": "@roblox/enum/DeveloperMemoryTag.GraphicsTextureCharacter", "Sounds": "@roblox/enum/DeveloperMemoryTag.Sounds", "StreamingSounds": "@roblox/enum/DeveloperMemoryTag.StreamingSounds", "TerrainVoxels": "@roblox/enum/DeveloperMemoryTag.TerrainVoxels", "Gui": "@roblox/enum/DeveloperMemoryTag.Gui", "Animation": "@roblox/enum/DeveloperMemoryTag.Animation", "Navigation": "@roblox/enum/DeveloperMemoryTag.Navigation", "GeometryCSG": "@roblox/enum/DeveloperMemoryTag.GeometryCSG", "GraphicsSlimModels": "@roblox/enum/DeveloperMemoryTag.GraphicsSlimModels" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeveloperMemoryTag", "code_sample": "" }, "@roblox/enum/PrivilegeType.Banned": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrivilegeType#Banned", "code_sample": "" }, "@roblox/enum/PrivilegeType.Visitor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrivilegeType#Visitor", "code_sample": "" }, "@roblox/enum/PrivilegeType.Member": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrivilegeType#Member", "code_sample": "" }, "@roblox/enum/PrivilegeType.Admin": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrivilegeType#Admin", "code_sample": "" }, "@roblox/enum/PrivilegeType.Owner": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrivilegeType#Owner", "code_sample": "" }, "@roblox/global/Enum.PrivilegeType": { "documentation": "Deprecated: This enum should not be used for new work.", "keys": { "Banned": "@roblox/enum/PrivilegeType.Banned", "Visitor": "@roblox/enum/PrivilegeType.Visitor", "Member": "@roblox/enum/PrivilegeType.Member", "Admin": "@roblox/enum/PrivilegeType.Admin", "Owner": "@roblox/enum/PrivilegeType.Owner" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrivilegeType", "code_sample": "" }, "@roblox/enum/ParticleOrientation.FacingCamera": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleOrientation#FacingCamera", "code_sample": "" }, "@roblox/enum/ParticleOrientation.FacingCameraWorldUp": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleOrientation#FacingCameraWorldUp", "code_sample": "" }, "@roblox/enum/ParticleOrientation.VelocityParallel": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleOrientation#VelocityParallel", "code_sample": "" }, "@roblox/enum/ParticleOrientation.VelocityPerpendicular": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleOrientation#VelocityPerpendicular", "code_sample": "" }, "@roblox/global/Enum.ParticleOrientation": { "documentation": "", "keys": { "FacingCamera": "@roblox/enum/ParticleOrientation.FacingCamera", "FacingCameraWorldUp": "@roblox/enum/ParticleOrientation.FacingCameraWorldUp", "VelocityParallel": "@roblox/enum/ParticleOrientation.VelocityParallel", "VelocityPerpendicular": "@roblox/enum/ParticleOrientation.VelocityPerpendicular" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleOrientation", "code_sample": "" }, "@roblox/enum/WebStreamClientType.SSE": { "documentation": "Traditional Server-Sent Events (SSE) client. Requires text/event-stream to be returned in the Content-Type header. Messages in the stream will follow the event stream format.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#SSE", "code_sample": "" }, "@roblox/enum/WebStreamClientType.RawStream": { "documentation": "General purpose HTTP streaming client. It can connect to any server that provides streaming data transfer (e.g. chunked encoding). It provides no guarantees about the stream format.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#RawStream", "code_sample": "" }, "@roblox/enum/WebStreamClientType.WebSocket": { "documentation": "WebSocket client that provides a bidirectional communication channel over a TCP connection.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType#WebSocket", "code_sample": "" }, "@roblox/global/Enum.WebStreamClientType": { "documentation": "Specifies what type of streaming to use when creating a WebStreamClient.", "keys": { "SSE": "@roblox/enum/WebStreamClientType.SSE", "RawStream": "@roblox/enum/WebStreamClientType.RawStream", "WebSocket": "@roblox/enum/WebStreamClientType.WebSocket" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientType", "code_sample": "" }, "@roblox/enum/HapticEffectType.Custom": { "documentation": "Allows for application of a custom haptic waveform through the HapticEffect:SetWaveformKeys() method.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType#Custom", "code_sample": "" }, "@roblox/enum/HapticEffectType.UIHover": { "documentation": "Useful for when a player browses over an object (often a UI object) without the intention of triggering its action; it can also alert the player that they have browsed over an interactable object. This effect type is subtle and does not disrupt the gameplay experience.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType#UIHover", "code_sample": "" }, "@roblox/enum/HapticEffectType.UIClick": { "documentation": "Useful for when a player has selected an object (often a UI object) with the intention of triggering its action. This effect type is crisp and it provides immediate feedback without being overwhelming.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType#UIClick", "code_sample": "" }, "@roblox/enum/HapticEffectType.UINotification": { "documentation": "Useful for when there is an inbound message that should draw the player's attention away from their current gameplay and prompt them that the notification requires immediate attention or action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType#UINotification", "code_sample": "" }, "@roblox/enum/HapticEffectType.GameplayExplosion": { "documentation": "Useful to signify a large-scale physics event that triggers impact across a large portion of a given scene. This effect is high intensity in order to represent the magnitude of the impact and it lingers for a longer period of time than GameplayCollision.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType#GameplayExplosion", "code_sample": "" }, "@roblox/enum/HapticEffectType.GameplayCollision": { "documentation": "This effect is a large immediate rumble that dies down quickly, useful to signify a clear and purposeful impact between objects.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType#GameplayCollision", "code_sample": "" }, "@roblox/global/Enum.HapticEffectType": { "documentation": "Enum used alongside HapticEffect.Type.", "keys": { "Custom": "@roblox/enum/HapticEffectType.Custom", "UIHover": "@roblox/enum/HapticEffectType.UIHover", "UIClick": "@roblox/enum/HapticEffectType.UIClick", "UINotification": "@roblox/enum/HapticEffectType.UINotification", "GameplayExplosion": "@roblox/enum/HapticEffectType.GameplayExplosion", "GameplayCollision": "@roblox/enum/HapticEffectType.GameplayCollision" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HapticEffectType", "code_sample": "" }, "@roblox/enum/UiMessageType.UiMessageError": { "documentation": "The message error.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UiMessageType#UiMessageError", "code_sample": "" }, "@roblox/enum/UiMessageType.UiMessageInfo": { "documentation": "The message info.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UiMessageType#UiMessageInfo", "code_sample": "" }, "@roblox/global/Enum.UiMessageType": { "documentation": "Controls the UI message under the GuiService.", "keys": { "UiMessageError": "@roblox/enum/UiMessageType.UiMessageError", "UiMessageInfo": "@roblox/enum/UiMessageType.UiMessageInfo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UiMessageType", "code_sample": "" }, "@roblox/enum/PlaybackState.Begin": { "documentation": "The tween has been created, but has yet to be played. After exiting this state, the tween never enters it again.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState#Begin", "code_sample": "" }, "@roblox/enum/PlaybackState.Delayed": { "documentation": "The tween is waiting for the duration specified in its TweenInfo.DelayTime. After the delay elapses, the tween plays.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState#Delayed", "code_sample": "" }, "@roblox/enum/PlaybackState.Playing": { "documentation": "The tween is currently in progress.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState#Playing", "code_sample": "" }, "@roblox/enum/PlaybackState.Paused": { "documentation": "The tween is paused in the middle of playing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState#Paused", "code_sample": "" }, "@roblox/enum/PlaybackState.Completed": { "documentation": "The tween completed successfully.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState#Completed", "code_sample": "" }, "@roblox/enum/PlaybackState.Cancelled": { "documentation": "The tween was cancelled before completion.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState#Cancelled", "code_sample": "" }, "@roblox/global/Enum.PlaybackState": { "documentation": "Describes the current state of a Tween in its Tween.PlaybackState property.", "keys": { "Begin": "@roblox/enum/PlaybackState.Begin", "Delayed": "@roblox/enum/PlaybackState.Delayed", "Playing": "@roblox/enum/PlaybackState.Playing", "Paused": "@roblox/enum/PlaybackState.Paused", "Completed": "@roblox/enum/PlaybackState.Completed", "Cancelled": "@roblox/enum/PlaybackState.Cancelled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlaybackState", "code_sample": "" }, "@roblox/enum/SaveFilter.SaveWorld": { "documentation": "Saves only the world-related data.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveFilter#SaveWorld", "code_sample": "" }, "@roblox/enum/SaveFilter.SaveGame": { "documentation": "Saves only the game-related data.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveFilter#SaveGame", "code_sample": "" }, "@roblox/enum/SaveFilter.SaveAll": { "documentation": "Saves all data, including both world and game-related information.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveFilter#SaveAll", "code_sample": "" }, "@roblox/global/Enum.SaveFilter": { "documentation": "Deprecated: This deprecated enum is used by DataModel.SavePlace which has also been deprecated. Neither should be used in new work.
Used by DataModel.SavePlace to determine the type of save operation This enum determines which aspects of the current place are saved, based on the following options.", "keys": { "SaveWorld": "@roblox/enum/SaveFilter.SaveWorld", "SaveGame": "@roblox/enum/SaveFilter.SaveGame", "SaveAll": "@roblox/enum/SaveFilter.SaveAll" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveFilter", "code_sample": "" }, "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadThumbnailType": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure#BadThumbnailType", "code_sample": "" }, "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadYRotDeg": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure#BadYRotDeg", "code_sample": "" }, "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadFieldOfViewDeg": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure#BadFieldOfViewDeg", "code_sample": "" }, "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadDistanceScale": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure#BadDistanceScale", "code_sample": "" }, "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.Other": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure#Other", "code_sample": "" }, "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.Throttled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure#Throttled", "code_sample": "" }, "@roblox/global/Enum.SaveAvatarThumbnailCustomizationFailure": { "documentation": "", "keys": { "BadThumbnailType": "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadThumbnailType", "BadYRotDeg": "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadYRotDeg", "BadFieldOfViewDeg": "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadFieldOfViewDeg", "BadDistanceScale": "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.BadDistanceScale", "Other": "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.Other", "Throttled": "@roblox/enum/SaveAvatarThumbnailCustomizationFailure.Throttled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SaveAvatarThumbnailCustomizationFailure", "code_sample": "" }, "@roblox/enum/ChatPrivacyMode.AllUsers": { "documentation": "A player can chat with all users in a game.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#AllUsers", "code_sample": "" }, "@roblox/enum/ChatPrivacyMode.NoOne": { "documentation": "A player cannot chat with any other users in a game.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#NoOne", "code_sample": "" }, "@roblox/enum/ChatPrivacyMode.Friends": { "documentation": "A player can only chat with users in a game that are on their connections list.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode#Friends", "code_sample": "" }, "@roblox/global/Enum.ChatPrivacyMode": { "documentation": "", "keys": { "AllUsers": "@roblox/enum/ChatPrivacyMode.AllUsers", "NoOne": "@roblox/enum/ChatPrivacyMode.NoOne", "Friends": "@roblox/enum/ChatPrivacyMode.Friends" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatPrivacyMode", "code_sample": "" }, "@roblox/enum/LightingStyle.Realistic": { "documentation": "The most advanced and realistic lighting and shadows Roblox can deliver.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LightingStyle#Realistic", "code_sample": "" }, "@roblox/enum/LightingStyle.Soft": { "documentation": "A flat, retro-Roblox look with softer lights and shadows.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LightingStyle#Soft", "code_sample": "" }, "@roblox/global/Enum.LightingStyle": { "documentation": "Enum used by Lighting.LightingStyle to indicate the artistic intent behind lighting in the experience.", "keys": { "Realistic": "@roblox/enum/LightingStyle.Realistic", "Soft": "@roblox/enum/LightingStyle.Soft" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LightingStyle", "code_sample": "" }, "@roblox/enum/DraggerMovementMode.Geometric": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggerMovementMode#Geometric", "code_sample": "" }, "@roblox/enum/DraggerMovementMode.Physical": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggerMovementMode#Physical", "code_sample": "" }, "@roblox/global/Enum.DraggerMovementMode": { "documentation": "", "keys": { "Geometric": "@roblox/enum/DraggerMovementMode.Geometric", "Physical": "@roblox/enum/DraggerMovementMode.Physical" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggerMovementMode", "code_sample": "" }, "@roblox/enum/SelfViewPosition.LastPosition": { "documentation": "The position of the self view when it was last closed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelfViewPosition#LastPosition", "code_sample": "" }, "@roblox/enum/SelfViewPosition.TopLeft": { "documentation": "Top-left corner of the screen, with slight padding from the top and left edges.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelfViewPosition#TopLeft", "code_sample": "" }, "@roblox/enum/SelfViewPosition.TopRight": { "documentation": "Top-right corner of the screen, with slight padding from the top and right edges.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelfViewPosition#TopRight", "code_sample": "" }, "@roblox/enum/SelfViewPosition.BottomLeft": { "documentation": "Bottom-left corner of the screen, with slight padding from the bottom and left edges.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelfViewPosition#BottomLeft", "code_sample": "" }, "@roblox/enum/SelfViewPosition.BottomRight": { "documentation": "Bottom-right corner of the screen, with slight padding from the bottom and right edges.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelfViewPosition#BottomRight", "code_sample": "" }, "@roblox/global/Enum.SelfViewPosition": { "documentation": "Defines the screen location of the current player's self view.", "keys": { "LastPosition": "@roblox/enum/SelfViewPosition.LastPosition", "TopLeft": "@roblox/enum/SelfViewPosition.TopLeft", "TopRight": "@roblox/enum/SelfViewPosition.TopRight", "BottomLeft": "@roblox/enum/SelfViewPosition.BottomLeft", "BottomRight": "@roblox/enum/SelfViewPosition.BottomRight" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelfViewPosition", "code_sample": "" }, "@roblox/enum/Axis.X": { "documentation": "The X axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Axis#X", "code_sample": "" }, "@roblox/enum/Axis.Y": { "documentation": "The Y axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Axis#Y", "code_sample": "" }, "@roblox/enum/Axis.Z": { "documentation": "The Z axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Axis#Z", "code_sample": "" }, "@roblox/global/Enum.Axis": { "documentation": "One of the 3D axes.", "keys": { "X": "@roblox/enum/Axis.X", "Y": "@roblox/enum/Axis.Y", "Z": "@roblox/enum/Axis.Z" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Axis", "code_sample": "" }, "@roblox/enum/ActionType.Nothing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionType#Nothing", "code_sample": "" }, "@roblox/enum/ActionType.Pause": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionType#Pause", "code_sample": "" }, "@roblox/enum/ActionType.Lose": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionType#Lose", "code_sample": "" }, "@roblox/enum/ActionType.Draw": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionType#Draw", "code_sample": "" }, "@roblox/enum/ActionType.Win": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionType#Win", "code_sample": "" }, "@roblox/global/Enum.ActionType": { "documentation": "", "keys": { "Nothing": "@roblox/enum/ActionType.Nothing", "Pause": "@roblox/enum/ActionType.Pause", "Lose": "@roblox/enum/ActionType.Lose", "Draw": "@roblox/enum/ActionType.Draw", "Win": "@roblox/enum/ActionType.Win" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionType", "code_sample": "" }, "@roblox/enum/UploadCaptureResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult#Success", "code_sample": "" }, "@roblox/enum/UploadCaptureResult.NeedPermission": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult#NeedPermission", "code_sample": "" }, "@roblox/enum/UploadCaptureResult.CaptureModerated": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult#CaptureModerated", "code_sample": "" }, "@roblox/enum/UploadCaptureResult.CaptureNotInGallery": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult#CaptureNotInGallery", "code_sample": "" }, "@roblox/enum/UploadCaptureResult.IneligibleCapture": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult#IneligibleCapture", "code_sample": "" }, "@roblox/enum/UploadCaptureResult.UploadQuotaReached": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult#UploadQuotaReached", "code_sample": "" }, "@roblox/global/Enum.UploadCaptureResult": { "documentation": "", "keys": { "Success": "@roblox/enum/UploadCaptureResult.Success", "NeedPermission": "@roblox/enum/UploadCaptureResult.NeedPermission", "CaptureModerated": "@roblox/enum/UploadCaptureResult.CaptureModerated", "CaptureNotInGallery": "@roblox/enum/UploadCaptureResult.CaptureNotInGallery", "IneligibleCapture": "@roblox/enum/UploadCaptureResult.IneligibleCapture", "UploadQuotaReached": "@roblox/enum/UploadCaptureResult.UploadQuotaReached" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UploadCaptureResult", "code_sample": "" }, "@roblox/enum/PathfindingUseImprovedSearch.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathfindingUseImprovedSearch#Default", "code_sample": "" }, "@roblox/enum/PathfindingUseImprovedSearch.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathfindingUseImprovedSearch#Disabled", "code_sample": "" }, "@roblox/enum/PathfindingUseImprovedSearch.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathfindingUseImprovedSearch#Enabled", "code_sample": "" }, "@roblox/global/Enum.PathfindingUseImprovedSearch": { "documentation": "", "keys": { "Default": "@roblox/enum/PathfindingUseImprovedSearch.Default", "Disabled": "@roblox/enum/PathfindingUseImprovedSearch.Disabled", "Enabled": "@roblox/enum/PathfindingUseImprovedSearch.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathfindingUseImprovedSearch", "code_sample": "" }, "@roblox/enum/AudioFilterType.Peak": { "documentation": "Filter that boosts or reduces sound near a specified Frequency.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Peak", "code_sample": "" }, "@roblox/enum/AudioFilterType.LowShelf": { "documentation": "Filter that boosts or reduces sound below a specified Frequency.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#LowShelf", "code_sample": "" }, "@roblox/enum/AudioFilterType.HighShelf": { "documentation": "Filter that boosts or reduces sound above a specified Frequency.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#HighShelf", "code_sample": "" }, "@roblox/enum/AudioFilterType.Lowpass12dB": { "documentation": "Filter that cuts sound above a specified Frequency, at a slope of -12dB/octave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass12dB", "code_sample": "" }, "@roblox/enum/AudioFilterType.Lowpass24dB": { "documentation": "Filter that cuts sound above a specified Frequency, at a slope of -24dB/octave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass24dB", "code_sample": "" }, "@roblox/enum/AudioFilterType.Lowpass48dB": { "documentation": "Filter that cuts sound above a specified Frequency, at a slope of -48dB/octave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass48dB", "code_sample": "" }, "@roblox/enum/AudioFilterType.Highpass12dB": { "documentation": "Filter that cuts sound below a specified Frequency, at a slope of -12dB/octave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Highpass12dB", "code_sample": "" }, "@roblox/enum/AudioFilterType.Highpass24dB": { "documentation": "Filter that cuts sound below a specified Frequency, at a slope of -24dB/octave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Highpass24dB", "code_sample": "" }, "@roblox/enum/AudioFilterType.Highpass48dB": { "documentation": "Filter that cuts sound below a specified Frequency, at a slope of -48dB/octave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Highpass48dB", "code_sample": "" }, "@roblox/enum/AudioFilterType.Bandpass": { "documentation": "Filter that only allows sound near a specified Frequency to be heard.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Bandpass", "code_sample": "" }, "@roblox/enum/AudioFilterType.Notch": { "documentation": "Filter that cuts sound near a specified Frequency.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Notch", "code_sample": "" }, "@roblox/enum/AudioFilterType.Lowpass6dB": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType#Lowpass6dB", "code_sample": "" }, "@roblox/global/Enum.AudioFilterType": { "documentation": "Filter types used for AudioFilter instances.", "keys": { "Peak": "@roblox/enum/AudioFilterType.Peak", "LowShelf": "@roblox/enum/AudioFilterType.LowShelf", "HighShelf": "@roblox/enum/AudioFilterType.HighShelf", "Lowpass12dB": "@roblox/enum/AudioFilterType.Lowpass12dB", "Lowpass24dB": "@roblox/enum/AudioFilterType.Lowpass24dB", "Lowpass48dB": "@roblox/enum/AudioFilterType.Lowpass48dB", "Highpass12dB": "@roblox/enum/AudioFilterType.Highpass12dB", "Highpass24dB": "@roblox/enum/AudioFilterType.Highpass24dB", "Highpass48dB": "@roblox/enum/AudioFilterType.Highpass48dB", "Bandpass": "@roblox/enum/AudioFilterType.Bandpass", "Notch": "@roblox/enum/AudioFilterType.Notch", "Lowpass6dB": "@roblox/enum/AudioFilterType.Lowpass6dB" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioFilterType", "code_sample": "" }, "@roblox/enum/RunContext.Legacy": { "documentation": "Runs in legacy script containers dependent on the type of script uses such as LocalScript or Script.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunContext#Legacy", "code_sample": "" }, "@roblox/enum/RunContext.Server": { "documentation": "Runs on the server.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunContext#Server", "code_sample": "" }, "@roblox/enum/RunContext.Client": { "documentation": "Runs on the client.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunContext#Client", "code_sample": "" }, "@roblox/enum/RunContext.Plugin": { "documentation": "Runs as a descendant of Plugin instances.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunContext#Plugin", "code_sample": "" }, "@roblox/global/Enum.RunContext": { "documentation": "", "keys": { "Legacy": "@roblox/enum/RunContext.Legacy", "Server": "@roblox/enum/RunContext.Server", "Client": "@roblox/enum/RunContext.Client", "Plugin": "@roblox/enum/RunContext.Plugin" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RunContext", "code_sample": "" }, "@roblox/enum/VRDeviceType.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRDeviceType#Unknown", "code_sample": "" }, "@roblox/enum/VRDeviceType.OculusRift": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRDeviceType#OculusRift", "code_sample": "" }, "@roblox/enum/VRDeviceType.HTCVive": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRDeviceType#HTCVive", "code_sample": "" }, "@roblox/enum/VRDeviceType.ValveIndex": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRDeviceType#ValveIndex", "code_sample": "" }, "@roblox/enum/VRDeviceType.OculusQuest": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRDeviceType#OculusQuest", "code_sample": "" }, "@roblox/global/Enum.VRDeviceType": { "documentation": "", "keys": { "Unknown": "@roblox/enum/VRDeviceType.Unknown", "OculusRift": "@roblox/enum/VRDeviceType.OculusRift", "HTCVive": "@roblox/enum/VRDeviceType.HTCVive", "ValveIndex": "@roblox/enum/VRDeviceType.ValveIndex", "OculusQuest": "@roblox/enum/VRDeviceType.OculusQuest" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRDeviceType", "code_sample": "" }, "@roblox/enum/InstanceFileSyncStatus.NotSynced": { "documentation": "The Instance is not being synced or errored.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InstanceFileSyncStatus#NotSynced", "code_sample": "" }, "@roblox/enum/InstanceFileSyncStatus.Errored": { "documentation": "The Instance is a sync root that has errored and stopped syncing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InstanceFileSyncStatus#Errored", "code_sample": "" }, "@roblox/enum/InstanceFileSyncStatus.SyncedAsRoot": { "documentation": "The Instance is being synced as the root of a sync tree.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InstanceFileSyncStatus#SyncedAsRoot", "code_sample": "" }, "@roblox/enum/InstanceFileSyncStatus.SyncedAsDescendant": { "documentation": "The Instance is being synced because it is a descendant of a sync root.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InstanceFileSyncStatus#SyncedAsDescendant", "code_sample": "" }, "@roblox/global/Enum.InstanceFileSyncStatus": { "documentation": "Describes the file sync status of an Instance.", "keys": { "NotSynced": "@roblox/enum/InstanceFileSyncStatus.NotSynced", "Errored": "@roblox/enum/InstanceFileSyncStatus.Errored", "SyncedAsRoot": "@roblox/enum/InstanceFileSyncStatus.SyncedAsRoot", "SyncedAsDescendant": "@roblox/enum/InstanceFileSyncStatus.SyncedAsDescendant" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InstanceFileSyncStatus", "code_sample": "" }, "@roblox/enum/PathStatus.Success": { "documentation": "Path found successfully.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus#Success", "code_sample": "" }, "@roblox/enum/PathStatus.ClosestNoPath": { "documentation": "Deprecated:
Path doesn't exist, returns path to closest point.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus#ClosestNoPath", "code_sample": "" }, "@roblox/enum/PathStatus.ClosestOutOfRange": { "documentation": "Deprecated:
Goal is out of MaxDistance range, returns path to closest point you can reach within MaxDistance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus#ClosestOutOfRange", "code_sample": "" }, "@roblox/enum/PathStatus.FailStartNotEmpty": { "documentation": "Deprecated:
Failed to compute path; the starting point is not empty.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus#FailStartNotEmpty", "code_sample": "" }, "@roblox/enum/PathStatus.FailFinishNotEmpty": { "documentation": "Deprecated:
Failed to compute path; the finish point is not empty.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus#FailFinishNotEmpty", "code_sample": "" }, "@roblox/enum/PathStatus.NoPath": { "documentation": "Path doesn't exist.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus#NoPath", "code_sample": "" }, "@roblox/global/Enum.PathStatus": { "documentation": "The success of a Path generated by PathfindingService.", "keys": { "Success": "@roblox/enum/PathStatus.Success", "ClosestNoPath": "@roblox/enum/PathStatus.ClosestNoPath", "ClosestOutOfRange": "@roblox/enum/PathStatus.ClosestOutOfRange", "FailStartNotEmpty": "@roblox/enum/PathStatus.FailStartNotEmpty", "FailFinishNotEmpty": "@roblox/enum/PathStatus.FailFinishNotEmpty", "NoPath": "@roblox/enum/PathStatus.NoPath" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathStatus", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#None", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.Legacy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#Legacy", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.Template": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#Template", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.Generate": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#Generate", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.Import": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#Import", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.Convert": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#Convert", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.EditAddTool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#EditAddTool", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.EditSeaLevelTool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#EditSeaLevelTool", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.EditReplaceTool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#EditReplaceTool", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.RegionFillTool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#RegionFillTool", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.RegionPasteTool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#RegionPasteTool", "code_sample": "" }, "@roblox/enum/TerrainAcquisitionMethod.Other": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod#Other", "code_sample": "" }, "@roblox/global/Enum.TerrainAcquisitionMethod": { "documentation": "", "keys": { "None": "@roblox/enum/TerrainAcquisitionMethod.None", "Legacy": "@roblox/enum/TerrainAcquisitionMethod.Legacy", "Template": "@roblox/enum/TerrainAcquisitionMethod.Template", "Generate": "@roblox/enum/TerrainAcquisitionMethod.Generate", "Import": "@roblox/enum/TerrainAcquisitionMethod.Import", "Convert": "@roblox/enum/TerrainAcquisitionMethod.Convert", "EditAddTool": "@roblox/enum/TerrainAcquisitionMethod.EditAddTool", "EditSeaLevelTool": "@roblox/enum/TerrainAcquisitionMethod.EditSeaLevelTool", "EditReplaceTool": "@roblox/enum/TerrainAcquisitionMethod.EditReplaceTool", "RegionFillTool": "@roblox/enum/TerrainAcquisitionMethod.RegionFillTool", "RegionPasteTool": "@roblox/enum/TerrainAcquisitionMethod.RegionPasteTool", "Other": "@roblox/enum/TerrainAcquisitionMethod.Other" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainAcquisitionMethod", "code_sample": "" }, "@roblox/enum/EasingStyle.Linear": { "documentation": "Moves at a constant speed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Linear", "code_sample": "" }, "@roblox/enum/EasingStyle.Sine": { "documentation": "Speed is determined by a sine wave for a gentle easing motion.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Sine", "code_sample": "" }, "@roblox/enum/EasingStyle.Back": { "documentation": "Slightly overshoots the target, then backs into place.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Back", "code_sample": "" }, "@roblox/enum/EasingStyle.Quad": { "documentation": "Similar to Sine but with a slightly sharper curve based on quadratic interpolation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Quad", "code_sample": "" }, "@roblox/enum/EasingStyle.Quart": { "documentation": "Similar to Cubic but with an even sharper curve based on quartic interpolation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Quart", "code_sample": "" }, "@roblox/enum/EasingStyle.Quint": { "documentation": "Similar to Quart but with an even sharper curve based on quintic interpolation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Quint", "code_sample": "" }, "@roblox/enum/EasingStyle.Bounce": { "documentation": "Bounces backwards multiple times after reaching the target, before eventually settling.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Bounce", "code_sample": "" }, "@roblox/enum/EasingStyle.Elastic": { "documentation": "Moves as if attached to a rubber band, overshooting the target several times.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Elastic", "code_sample": "" }, "@roblox/enum/EasingStyle.Exponential": { "documentation": "The sharpest curve based on exponential interpolation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Exponential", "code_sample": "" }, "@roblox/enum/EasingStyle.Circular": { "documentation": "Follows a circular arc, such that acceleration is more sudden and deceleration more gradual versus Quint or Exponential.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Circular", "code_sample": "" }, "@roblox/enum/EasingStyle.Cubic": { "documentation": "Similar to Quad but with a slightly sharper curve based on cubic interpolation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle#Cubic", "code_sample": "" }, "@roblox/global/Enum.EasingStyle": { "documentation": "Enum used with TweenInfo.new to control the motion of a Tween.", "keys": { "Linear": "@roblox/enum/EasingStyle.Linear", "Sine": "@roblox/enum/EasingStyle.Sine", "Back": "@roblox/enum/EasingStyle.Back", "Quad": "@roblox/enum/EasingStyle.Quad", "Quart": "@roblox/enum/EasingStyle.Quart", "Quint": "@roblox/enum/EasingStyle.Quint", "Bounce": "@roblox/enum/EasingStyle.Bounce", "Elastic": "@roblox/enum/EasingStyle.Elastic", "Exponential": "@roblox/enum/EasingStyle.Exponential", "Circular": "@roblox/enum/EasingStyle.Circular", "Cubic": "@roblox/enum/EasingStyle.Cubic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingStyle", "code_sample": "" }, "@roblox/enum/PathWaypointAction.Walk": { "documentation": "Walk action needed to reach the next waypoint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathWaypointAction#Walk", "code_sample": "" }, "@roblox/enum/PathWaypointAction.Jump": { "documentation": "Jump action needed to reach the next waypoint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathWaypointAction#Jump", "code_sample": "" }, "@roblox/enum/PathWaypointAction.Custom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathWaypointAction#Custom", "code_sample": "" }, "@roblox/global/Enum.PathWaypointAction": { "documentation": "Describes the action to take when a PathWaypoint is reached.", "keys": { "Walk": "@roblox/enum/PathWaypointAction.Walk", "Jump": "@roblox/enum/PathWaypointAction.Jump", "Custom": "@roblox/enum/PathWaypointAction.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PathWaypointAction", "code_sample": "" }, "@roblox/enum/ReservedHighlightId.Standard": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReservedHighlightId#Standard", "code_sample": "" }, "@roblox/enum/ReservedHighlightId.Active": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReservedHighlightId#Active", "code_sample": "" }, "@roblox/enum/ReservedHighlightId.Hover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReservedHighlightId#Hover", "code_sample": "" }, "@roblox/enum/ReservedHighlightId.Selection": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReservedHighlightId#Selection", "code_sample": "" }, "@roblox/global/Enum.ReservedHighlightId": { "documentation": "", "keys": { "Standard": "@roblox/enum/ReservedHighlightId.Standard", "Active": "@roblox/enum/ReservedHighlightId.Active", "Hover": "@roblox/enum/ReservedHighlightId.Hover", "Selection": "@roblox/enum/ReservedHighlightId.Selection" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReservedHighlightId", "code_sample": "" }, "@roblox/enum/CameraPanMode.Classic": { "documentation": "Enables swipe and pan on mobile devices, and disables edge bump camera controls. Default.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraPanMode#Classic", "code_sample": "" }, "@roblox/enum/CameraPanMode.EdgeBump": { "documentation": "Disables swipe to pan on mobile devices, and enables edge bump camera controls. It does not affect Windows or Mac users.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraPanMode#EdgeBump", "code_sample": "" }, "@roblox/global/Enum.CameraPanMode": { "documentation": "The CameraPanMode Enum represents the available pan modes for Camera:SetCameraPanMode().", "keys": { "Classic": "@roblox/enum/CameraPanMode.Classic", "EdgeBump": "@roblox/enum/CameraPanMode.EdgeBump" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CameraPanMode", "code_sample": "" }, "@roblox/enum/AspectType.FitWithinMaxSize": { "documentation": "The object will be the maximum size possible within its own AbsoluteSize.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AspectType#FitWithinMaxSize", "code_sample": "" }, "@roblox/enum/AspectType.ScaleWithParentSize": { "documentation": "The object's maximum size will be the size of the parent while still maintaining the aspect ratio.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AspectType#ScaleWithParentSize", "code_sample": "" }, "@roblox/global/Enum.AspectType": { "documentation": "Used by UIAspectRatioConstraint.AspectType to control sizing behavior.", "keys": { "FitWithinMaxSize": "@roblox/enum/AspectType.FitWithinMaxSize", "ScaleWithParentSize": "@roblox/enum/AspectType.ScaleWithParentSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AspectType", "code_sample": "" }, "@roblox/enum/GameAvatarType.R6": { "documentation": "The R6 character rig.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GameAvatarType#R6", "code_sample": "" }, "@roblox/enum/GameAvatarType.R15": { "documentation": "The R15 character rig.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GameAvatarType#R15", "code_sample": "" }, "@roblox/enum/GameAvatarType.PlayerChoice": { "documentation": "The rig (either R6 or R15) determined by a player's character settings set on the website in the 'Edit Avatar' page.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GameAvatarType#PlayerChoice", "code_sample": "" }, "@roblox/global/Enum.GameAvatarType": { "documentation": "Value indicating which type of avatar an experience uses.", "keys": { "R6": "@roblox/enum/GameAvatarType.R6", "R15": "@roblox/enum/GameAvatarType.R15", "PlayerChoice": "@roblox/enum/GameAvatarType.PlayerChoice" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GameAvatarType", "code_sample": "" }, "@roblox/enum/FontWeight.Thin": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#Thin", "code_sample": "" }, "@roblox/enum/FontWeight.ExtraLight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#ExtraLight", "code_sample": "" }, "@roblox/enum/FontWeight.Light": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#Light", "code_sample": "" }, "@roblox/enum/FontWeight.Regular": { "documentation": "The default thickness for text.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#Regular", "code_sample": "" }, "@roblox/enum/FontWeight.Medium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#Medium", "code_sample": "" }, "@roblox/enum/FontWeight.SemiBold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#SemiBold", "code_sample": "" }, "@roblox/enum/FontWeight.Bold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#Bold", "code_sample": "" }, "@roblox/enum/FontWeight.ExtraBold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#ExtraBold", "code_sample": "" }, "@roblox/enum/FontWeight.Heavy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight#Heavy", "code_sample": "" }, "@roblox/global/Enum.FontWeight": { "documentation": "Describes how thick a Font is.", "keys": { "Thin": "@roblox/enum/FontWeight.Thin", "ExtraLight": "@roblox/enum/FontWeight.ExtraLight", "Light": "@roblox/enum/FontWeight.Light", "Regular": "@roblox/enum/FontWeight.Regular", "Medium": "@roblox/enum/FontWeight.Medium", "SemiBold": "@roblox/enum/FontWeight.SemiBold", "Bold": "@roblox/enum/FontWeight.Bold", "ExtraBold": "@roblox/enum/FontWeight.ExtraBold", "Heavy": "@roblox/enum/FontWeight.Heavy" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontWeight", "code_sample": "" }, "@roblox/enum/AvatarSettingsBuildMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsBuildMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsBuildMode.CustomBuild": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsBuildMode#CustomBuild", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsBuildMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsBuildMode.PlayerChoice", "CustomBuild": "@roblox/enum/AvatarSettingsBuildMode.CustomBuild" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsBuildMode", "code_sample": "" }, "@roblox/enum/TerrainFace.Top": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainFace#Top", "code_sample": "" }, "@roblox/enum/TerrainFace.Side": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainFace#Side", "code_sample": "" }, "@roblox/enum/TerrainFace.Bottom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainFace#Bottom", "code_sample": "" }, "@roblox/global/Enum.TerrainFace": { "documentation": "", "keys": { "Top": "@roblox/enum/TerrainFace.Top", "Side": "@roblox/enum/TerrainFace.Side", "Bottom": "@roblox/enum/TerrainFace.Bottom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TerrainFace", "code_sample": "" }, "@roblox/enum/ProductPurchaseChannel.InExperience": { "documentation": "The purchase was made inside of an experience.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseChannel#InExperience", "code_sample": "" }, "@roblox/enum/ProductPurchaseChannel.ExperienceDetailsPage": { "documentation": "The purchase was made outside of an experience, on the Store tab of the experience details page.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseChannel#ExperienceDetailsPage", "code_sample": "" }, "@roblox/enum/ProductPurchaseChannel.AdReward": { "documentation": "The product was rewarded to the user when they watched a video ad to completion.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseChannel#AdReward", "code_sample": "" }, "@roblox/enum/ProductPurchaseChannel.CommerceProduct": { "documentation": "The user acquired the product as a benefit of purchasing commerce merchandise from the developer of the experience.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseChannel#CommerceProduct", "code_sample": "" }, "@roblox/global/Enum.ProductPurchaseChannel": { "documentation": "Enum which works with MarketplaceService to represent how the
user acquired the developer product.", "keys": { "InExperience": "@roblox/enum/ProductPurchaseChannel.InExperience", "ExperienceDetailsPage": "@roblox/enum/ProductPurchaseChannel.ExperienceDetailsPage", "AdReward": "@roblox/enum/ProductPurchaseChannel.AdReward", "CommerceProduct": "@roblox/enum/ProductPurchaseChannel.CommerceProduct" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseChannel", "code_sample": "" }, "@roblox/enum/TrackerLodFlagMode.ForceFalse": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodFlagMode#ForceFalse", "code_sample": "" }, "@roblox/enum/TrackerLodFlagMode.ForceTrue": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodFlagMode#ForceTrue", "code_sample": "" }, "@roblox/enum/TrackerLodFlagMode.Auto": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodFlagMode#Auto", "code_sample": "" }, "@roblox/global/Enum.TrackerLodFlagMode": { "documentation": "", "keys": { "ForceFalse": "@roblox/enum/TrackerLodFlagMode.ForceFalse", "ForceTrue": "@roblox/enum/TrackerLodFlagMode.ForceTrue", "Auto": "@roblox/enum/TrackerLodFlagMode.Auto" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerLodFlagMode", "code_sample": "" }, "@roblox/enum/BreakReason.Other": { "documentation": "Pausing for a reason not covered by other values, for example if the user hit \"Pause\" button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakReason#Other", "code_sample": "" }, "@roblox/enum/BreakReason.Error": { "documentation": "Pausing on error hit in the code.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakReason#Error", "code_sample": "" }, "@roblox/enum/BreakReason.SpecialBreakpoint": { "documentation": "Pausing on an internal breakpoint set by debugger command: e.g. step over, step into, step out of.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakReason#SpecialBreakpoint", "code_sample": "" }, "@roblox/enum/BreakReason.UserBreakpoint": { "documentation": "Pausing on a user breakpoint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakReason#UserBreakpoint", "code_sample": "" }, "@roblox/global/Enum.BreakReason": { "documentation": "Reason for the breakpoint hit.", "keys": { "Other": "@roblox/enum/BreakReason.Other", "Error": "@roblox/enum/BreakReason.Error", "SpecialBreakpoint": "@roblox/enum/BreakReason.SpecialBreakpoint", "UserBreakpoint": "@roblox/enum/BreakReason.UserBreakpoint" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BreakReason", "code_sample": "" }, "@roblox/enum/VRSessionState.Undefined": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSessionState#Undefined", "code_sample": "" }, "@roblox/enum/VRSessionState.Idle": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSessionState#Idle", "code_sample": "" }, "@roblox/enum/VRSessionState.Visible": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSessionState#Visible", "code_sample": "" }, "@roblox/enum/VRSessionState.Focused": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSessionState#Focused", "code_sample": "" }, "@roblox/enum/VRSessionState.Stopping": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSessionState#Stopping", "code_sample": "" }, "@roblox/global/Enum.VRSessionState": { "documentation": "", "keys": { "Undefined": "@roblox/enum/VRSessionState.Undefined", "Idle": "@roblox/enum/VRSessionState.Idle", "Visible": "@roblox/enum/VRSessionState.Visible", "Focused": "@roblox/enum/VRSessionState.Focused", "Stopping": "@roblox/enum/VRSessionState.Stopping" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRSessionState", "code_sample": "" }, "@roblox/enum/ChatRestrictionStatus.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus#Unknown", "code_sample": "" }, "@roblox/enum/ChatRestrictionStatus.NotRestricted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus#NotRestricted", "code_sample": "" }, "@roblox/enum/ChatRestrictionStatus.Restricted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus#Restricted", "code_sample": "" }, "@roblox/global/Enum.ChatRestrictionStatus": { "documentation": "", "keys": { "Unknown": "@roblox/enum/ChatRestrictionStatus.Unknown", "NotRestricted": "@roblox/enum/ChatRestrictionStatus.NotRestricted", "Restricted": "@roblox/enum/ChatRestrictionStatus.Restricted" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatRestrictionStatus", "code_sample": "" }, "@roblox/enum/PermissionLevelShown.Game": { "documentation": "Member must have no security permissions in order to be shown.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PermissionLevelShown#Game", "code_sample": "" }, "@roblox/enum/PermissionLevelShown.RobloxGame": { "documentation": "Member must have security permissions less than or equal to RobloxPlaceSecurity to be shown.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PermissionLevelShown#RobloxGame", "code_sample": "" }, "@roblox/enum/PermissionLevelShown.RobloxScript": { "documentation": "Member must have security permissions less than or equal to RobloxScriptSecurity to be shown.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PermissionLevelShown#RobloxScript", "code_sample": "" }, "@roblox/enum/PermissionLevelShown.Studio": { "documentation": "Member must have security permissions less than or equal to LocalUserSecurity to be shown.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PermissionLevelShown#Studio", "code_sample": "" }, "@roblox/enum/PermissionLevelShown.Roblox": { "documentation": "Member is shown no matter what security it has.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PermissionLevelShown#Roblox", "code_sample": "" }, "@roblox/global/Enum.PermissionLevelShown": { "documentation": "Used to set the highest permission level that APIs have to have in order to be shown in the Object Browser.", "keys": { "Game": "@roblox/enum/PermissionLevelShown.Game", "RobloxGame": "@roblox/enum/PermissionLevelShown.RobloxGame", "RobloxScript": "@roblox/enum/PermissionLevelShown.RobloxScript", "Studio": "@roblox/enum/PermissionLevelShown.Studio", "Roblox": "@roblox/enum/PermissionLevelShown.Roblox" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PermissionLevelShown", "code_sample": "" }, "@roblox/enum/SubscriptionState.NeverSubscribed": { "documentation": "User has never subscribed to the product.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#NeverSubscribed", "code_sample": "" }, "@roblox/enum/SubscriptionState.SubscribedWillRenew": { "documentation": "Subscription is active and will renew.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#SubscribedWillRenew", "code_sample": "" }, "@roblox/enum/SubscriptionState.SubscribedWillNotRenew": { "documentation": "Subscription is active and will not renew.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#SubscribedWillNotRenew", "code_sample": "" }, "@roblox/enum/SubscriptionState.SubscribedRenewalPaymentPending": { "documentation": "Subscription is active and renewal payment is pending.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#SubscribedRenewalPaymentPending", "code_sample": "" }, "@roblox/enum/SubscriptionState.Expired": { "documentation": "Subscription has expired.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionState#Expired", "code_sample": "" }, "@roblox/global/Enum.SubscriptionState": { "documentation": "", "keys": { "NeverSubscribed": "@roblox/enum/SubscriptionState.NeverSubscribed", "SubscribedWillRenew": "@roblox/enum/SubscriptionState.SubscribedWillRenew", "SubscribedWillNotRenew": "@roblox/enum/SubscriptionState.SubscribedWillNotRenew", "SubscribedRenewalPaymentPending": "@roblox/enum/SubscriptionState.SubscribedRenewalPaymentPending", "Expired": "@roblox/enum/SubscriptionState.Expired" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionState", "code_sample": "" }, "@roblox/enum/AuthorityMode.Server": { "documentation": "Server authority with client side prediction and rollback enabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AuthorityMode#Server", "code_sample": "" }, "@roblox/enum/AuthorityMode.Automatic": { "documentation": "Traditional distributed authority model where, for each instance, the engine decides whether the server or a client should be the authority; BasePart:SetNetworkOwner() can be used to influence the decision.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AuthorityMode#Automatic", "code_sample": "" }, "@roblox/global/Enum.AuthorityMode": { "documentation": "Enum used with Workspace.AuthorityMode.", "keys": { "Server": "@roblox/enum/AuthorityMode.Server", "Automatic": "@roblox/enum/AuthorityMode.Automatic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AuthorityMode", "code_sample": "" }, "@roblox/enum/ChatStyle.Classic": { "documentation": "Displays chats in the chat user interface at the top-left corner of the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatStyle#Classic", "code_sample": "" }, "@roblox/enum/ChatStyle.Bubble": { "documentation": "Displays chats in a bubble above the sender's head.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatStyle#Bubble", "code_sample": "" }, "@roblox/enum/ChatStyle.ClassicAndBubble": { "documentation": "Has the effects of Classic and Bubble combined.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatStyle#ClassicAndBubble", "code_sample": "" }, "@roblox/global/Enum.ChatStyle": { "documentation": "The ChatStyle Enum is used to set the style of Chat used in a game via the Players:SetChatStyle() method.", "keys": { "Classic": "@roblox/enum/ChatStyle.Classic", "Bubble": "@roblox/enum/ChatStyle.Bubble", "ClassicAndBubble": "@roblox/enum/ChatStyle.ClassicAndBubble" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatStyle", "code_sample": "" }, "@roblox/enum/CageType.Inner": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CageType#Inner", "code_sample": "" }, "@roblox/enum/CageType.Outer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CageType#Outer", "code_sample": "" }, "@roblox/global/Enum.CageType": { "documentation": "", "keys": { "Inner": "@roblox/enum/CageType.Inner", "Outer": "@roblox/enum/CageType.Outer" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CageType", "code_sample": "" }, "@roblox/enum/PackagePermission.None": { "documentation": "Permission data is not available for the current user or group roleset.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission#None", "code_sample": "" }, "@roblox/enum/PackagePermission.NoAccess": { "documentation": "The current user or group roleset doesn't have access.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission#NoAccess", "code_sample": "" }, "@roblox/enum/PackagePermission.Revoked": { "documentation": "The current user's or group roleset's permission is revoked.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission#Revoked", "code_sample": "" }, "@roblox/enum/PackagePermission.UseView": { "documentation": "The current user or group roleset can download a copy of the package from Roblox.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission#UseView", "code_sample": "" }, "@roblox/enum/PackagePermission.Edit": { "documentation": "The current user or group roleset can download a copy of the package from Roblox and publish package changes to Roblox.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission#Edit", "code_sample": "" }, "@roblox/enum/PackagePermission.Own": { "documentation": "The current user or group roleset can download a copy of the page from Roblox, publish package changes to Roblox, and manage who has access to the package.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission#Own", "code_sample": "" }, "@roblox/global/Enum.PackagePermission": { "documentation": "Indicates the current user's or group roleset's permission to the package.", "keys": { "None": "@roblox/enum/PackagePermission.None", "NoAccess": "@roblox/enum/PackagePermission.NoAccess", "Revoked": "@roblox/enum/PackagePermission.Revoked", "UseView": "@roblox/enum/PackagePermission.UseView", "Edit": "@roblox/enum/PackagePermission.Edit", "Own": "@roblox/enum/PackagePermission.Own" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PackagePermission", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size48x48": { "documentation": "Thumbnail resolution is 48 pixels x 48 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size48x48", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size180x180": { "documentation": "Thumbnail resolution is 180 pixels x 180 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size180x180", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size420x420": { "documentation": "Thumbnail resolution is 420 pixels x 420 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size420x420", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size60x60": { "documentation": "Thumbnail resolution is 60 pixels x 60 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size60x60", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size100x100": { "documentation": "Thumbnail resolution is 100 pixels x 100 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size100x100", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size150x150": { "documentation": "Thumbnail resolution is 150 pixels x 150 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size150x150", "code_sample": "" }, "@roblox/enum/ThumbnailSize.Size352x352": { "documentation": "Thumbnail resolution is 352 pixels x 352 pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize#Size352x352", "code_sample": "" }, "@roblox/global/Enum.ThumbnailSize": { "documentation": "", "keys": { "Size48x48": "@roblox/enum/ThumbnailSize.Size48x48", "Size180x180": "@roblox/enum/ThumbnailSize.Size180x180", "Size420x420": "@roblox/enum/ThumbnailSize.Size420x420", "Size60x60": "@roblox/enum/ThumbnailSize.Size60x60", "Size100x100": "@roblox/enum/ThumbnailSize.Size100x100", "Size150x150": "@roblox/enum/ThumbnailSize.Size150x150", "Size352x352": "@roblox/enum/ThumbnailSize.Size352x352" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailSize", "code_sample": "" }, "@roblox/enum/PhysicsSteppingMethod.Default": { "documentation": "The current default is Adaptive.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSteppingMethod#Default", "code_sample": "" }, "@roblox/enum/PhysicsSteppingMethod.Fixed": { "documentation": "All simulated assemblies inside the workspace will advance forward at 240 Hz. This option is best for optimal stability and simulation accuracy.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSteppingMethod#Fixed", "code_sample": "" }, "@roblox/enum/PhysicsSteppingMethod.Adaptive": { "documentation": "The engine attempts to assign optimal simulation rates for individual assemblies of either 240 Hz, 120 Hz, or 60 Hz. This setting is optimized for performance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSteppingMethod#Adaptive", "code_sample": "" }, "@roblox/global/Enum.PhysicsSteppingMethod": { "documentation": "", "keys": { "Default": "@roblox/enum/PhysicsSteppingMethod.Default", "Fixed": "@roblox/enum/PhysicsSteppingMethod.Fixed", "Adaptive": "@roblox/enum/PhysicsSteppingMethod.Adaptive" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSteppingMethod", "code_sample": "" }, "@roblox/enum/BorderStrokePosition.Outer": { "documentation": "The stroke renders on the outer border of the parent UI element.

", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition#Outer", "code_sample": "" }, "@roblox/enum/BorderStrokePosition.Center": { "documentation": "The stroke renders on the center border of the parent UI element.

", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition#Center", "code_sample": "" }, "@roblox/enum/BorderStrokePosition.Inner": { "documentation": "The stroke renders on the inner border of the parent UI element.

", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition#Inner", "code_sample": "" }, "@roblox/global/Enum.BorderStrokePosition": { "documentation": "Used by UIStroke.BorderStrokePosition to determine the stroke's position on its parent's border.", "keys": { "Outer": "@roblox/enum/BorderStrokePosition.Outer", "Center": "@roblox/enum/BorderStrokePosition.Center", "Inner": "@roblox/enum/BorderStrokePosition.Inner" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BorderStrokePosition", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingSuccess": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingSuccess", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingNoFaceFound": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingNoFaceFound", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingUnknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingUnknown", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingLost": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingLost", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingHasTrackingError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingHasTrackingError", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingIsOccluded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingIsOccluded", "code_sample": "" }, "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingUninitialized": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus#FaceTrackingUninitialized", "code_sample": "" }, "@roblox/global/Enum.TrackerFaceTrackingStatus": { "documentation": "", "keys": { "FaceTrackingSuccess": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingSuccess", "FaceTrackingNoFaceFound": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingNoFaceFound", "FaceTrackingUnknown": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingUnknown", "FaceTrackingLost": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingLost", "FaceTrackingHasTrackingError": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingHasTrackingError", "FaceTrackingIsOccluded": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingIsOccluded", "FaceTrackingUninitialized": "@roblox/enum/TrackerFaceTrackingStatus.FaceTrackingUninitialized" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerFaceTrackingStatus", "code_sample": "" }, "@roblox/enum/UICaptureMode.All": { "documentation": "Capture all UI elements.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#All", "code_sample": "" }, "@roblox/enum/UICaptureMode.None": { "documentation": "Capture no UI elements.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UICaptureMode#None", "code_sample": "" }, "@roblox/global/Enum.UICaptureMode": { "documentation": "Used to determine what UI elements should be captured with CaptureService.", "keys": { "All": "@roblox/enum/UICaptureMode.All", "None": "@roblox/enum/UICaptureMode.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UICaptureMode", "code_sample": "" }, "@roblox/enum/IKControlType.Transform": { "documentation": "It is a full 6-DoF constraint. Aligns the EndEffector CFrame to that of the Target. It is the default value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlType#Transform", "code_sample": "" }, "@roblox/enum/IKControlType.Position": { "documentation": "Aligns the EndEffector position to that of the Target .", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlType#Position", "code_sample": "" }, "@roblox/enum/IKControlType.Rotation": { "documentation": "Aligns the EndEffector rotation to that of the Target.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlType#Rotation", "code_sample": "" }, "@roblox/enum/IKControlType.LookAt": { "documentation": "Moves and orients the whole chain to make the forward axis on the EndEffector point at a position in the world specified by Target.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlType#LookAt", "code_sample": "" }, "@roblox/global/Enum.IKControlType": { "documentation": "Used on IKControl to specify their Type, to change their behavior.", "keys": { "Transform": "@roblox/enum/IKControlType.Transform", "Position": "@roblox/enum/IKControlType.Position", "Rotation": "@roblox/enum/IKControlType.Rotation", "LookAt": "@roblox/enum/IKControlType.LookAt" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKControlType", "code_sample": "" }, "@roblox/enum/ReverbType.NoReverb": { "documentation": "No sound reverb. Audio is not changed from default.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#NoReverb", "code_sample": "" }, "@roblox/enum/ReverbType.GenericReverb": { "documentation": "Sound reverb is changed to a generic reverb effect.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#GenericReverb", "code_sample": "" }, "@roblox/enum/ReverbType.PaddedCell": { "documentation": "Sound reverb is changed to sound like the player is in a padded cell.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#PaddedCell", "code_sample": "" }, "@roblox/enum/ReverbType.Room": { "documentation": "Sound reverb is changed to sound like the player is in a room.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Room", "code_sample": "" }, "@roblox/enum/ReverbType.Bathroom": { "documentation": "Sound reverb is changed to sound like the player is in a bathroom.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Bathroom", "code_sample": "" }, "@roblox/enum/ReverbType.LivingRoom": { "documentation": "Sound reverb is changed to sound like the player is in a living room.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#LivingRoom", "code_sample": "" }, "@roblox/enum/ReverbType.StoneRoom": { "documentation": "Sound reverb is changed to sound like the player is in a stone room.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#StoneRoom", "code_sample": "" }, "@roblox/enum/ReverbType.Auditorium": { "documentation": "Sound reverb is changed to sound like the player is in an auditorium.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Auditorium", "code_sample": "" }, "@roblox/enum/ReverbType.ConcertHall": { "documentation": "Sound reverb is changed to sound like the player is in a concert hall.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#ConcertHall", "code_sample": "" }, "@roblox/enum/ReverbType.Cave": { "documentation": "Sound reverb is changed to sound like the player is in a cave.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Cave", "code_sample": "" }, "@roblox/enum/ReverbType.Arena": { "documentation": "Sound reverb is changed to sound like the player is in an arena.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Arena", "code_sample": "" }, "@roblox/enum/ReverbType.Hangar": { "documentation": "Sound reverb is changed to sound like the player is in a hangar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Hangar", "code_sample": "" }, "@roblox/enum/ReverbType.CarpettedHallway": { "documentation": "Sound reverb is changed to sound like the player is in a carpeted hallway.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#CarpettedHallway", "code_sample": "" }, "@roblox/enum/ReverbType.Hallway": { "documentation": "Sound reverb is changed to sound like the player is in a hallway.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Hallway", "code_sample": "" }, "@roblox/enum/ReverbType.StoneCorridor": { "documentation": "Sound reverb is changed to sound like the player is in a stone corridor.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#StoneCorridor", "code_sample": "" }, "@roblox/enum/ReverbType.Alley": { "documentation": "Sound reverb is changed to sound like the player is in an alley.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Alley", "code_sample": "" }, "@roblox/enum/ReverbType.Forest": { "documentation": "Sound reverb is changed to sound like the player is in a forest.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Forest", "code_sample": "" }, "@roblox/enum/ReverbType.City": { "documentation": "Sound reverb is changed to sound like the player is in a city.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#City", "code_sample": "" }, "@roblox/enum/ReverbType.Mountains": { "documentation": "Sound reverb is changed to sound like the player is in the mountains.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Mountains", "code_sample": "" }, "@roblox/enum/ReverbType.Quarry": { "documentation": "Sound reverb is changed to sound like the player is in a quarry.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Quarry", "code_sample": "" }, "@roblox/enum/ReverbType.Plain": { "documentation": "Sound reverb is changed to sound like the player is an open plain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#Plain", "code_sample": "" }, "@roblox/enum/ReverbType.ParkingLot": { "documentation": "Sound reverb is changed to sound like the player is in a parking lot.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#ParkingLot", "code_sample": "" }, "@roblox/enum/ReverbType.SewerPipe": { "documentation": "Sound reverb is changed to sound like the player is in a sewer pipe.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#SewerPipe", "code_sample": "" }, "@roblox/enum/ReverbType.UnderWater": { "documentation": "Sound reverb is changed to sound like the player is underwater.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType#UnderWater", "code_sample": "" }, "@roblox/global/Enum.ReverbType": { "documentation": "The ReverbType Enum allows you to make audio in your game sound different, depending on what \"area\" the sounds are in.", "keys": { "NoReverb": "@roblox/enum/ReverbType.NoReverb", "GenericReverb": "@roblox/enum/ReverbType.GenericReverb", "PaddedCell": "@roblox/enum/ReverbType.PaddedCell", "Room": "@roblox/enum/ReverbType.Room", "Bathroom": "@roblox/enum/ReverbType.Bathroom", "LivingRoom": "@roblox/enum/ReverbType.LivingRoom", "StoneRoom": "@roblox/enum/ReverbType.StoneRoom", "Auditorium": "@roblox/enum/ReverbType.Auditorium", "ConcertHall": "@roblox/enum/ReverbType.ConcertHall", "Cave": "@roblox/enum/ReverbType.Cave", "Arena": "@roblox/enum/ReverbType.Arena", "Hangar": "@roblox/enum/ReverbType.Hangar", "CarpettedHallway": "@roblox/enum/ReverbType.CarpettedHallway", "Hallway": "@roblox/enum/ReverbType.Hallway", "StoneCorridor": "@roblox/enum/ReverbType.StoneCorridor", "Alley": "@roblox/enum/ReverbType.Alley", "Forest": "@roblox/enum/ReverbType.Forest", "City": "@roblox/enum/ReverbType.City", "Mountains": "@roblox/enum/ReverbType.Mountains", "Quarry": "@roblox/enum/ReverbType.Quarry", "Plain": "@roblox/enum/ReverbType.Plain", "ParkingLot": "@roblox/enum/ReverbType.ParkingLot", "SewerPipe": "@roblox/enum/ReverbType.SewerPipe", "UnderWater": "@roblox/enum/ReverbType.UnderWater" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReverbType", "code_sample": "" }, "@roblox/enum/TextYAlignment.Top": { "documentation": "Alignment starts at the top of the GUI object.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextYAlignment#Top", "code_sample": "" }, "@roblox/enum/TextYAlignment.Center": { "documentation": "Aligned starts at the center of the GUI object and spreads equally toward the top and bottom.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextYAlignment#Center", "code_sample": "" }, "@roblox/enum/TextYAlignment.Bottom": { "documentation": "Alignment starts at the bottom of the GUI object.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextYAlignment#Bottom", "code_sample": "" }, "@roblox/global/Enum.TextYAlignment": { "documentation": "Determines vertical alignment of text.", "keys": { "Top": "@roblox/enum/TextYAlignment.Top", "Center": "@roblox/enum/TextYAlignment.Center", "Bottom": "@roblox/enum/TextYAlignment.Bottom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextYAlignment", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.Initializing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Initializing", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.Pending": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Pending", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.Processing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Processing", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.ErrorGeneric": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorGeneric", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Success", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.ErrorVideoTooLong": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorVideoTooLong", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.ErrorNoPersonDetected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorNoPersonDetected", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.ErrorVideoUnstable": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorVideoUnstable", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.Timeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Timeout", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.Cancelled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#Cancelled", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.ErrorMultiplePeople": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorMultiplePeople", "code_sample": "" }, "@roblox/enum/AnimationClipFromVideoStatus.ErrorUploadingVideo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus#ErrorUploadingVideo", "code_sample": "" }, "@roblox/global/Enum.AnimationClipFromVideoStatus": { "documentation": "", "keys": { "Initializing": "@roblox/enum/AnimationClipFromVideoStatus.Initializing", "Pending": "@roblox/enum/AnimationClipFromVideoStatus.Pending", "Processing": "@roblox/enum/AnimationClipFromVideoStatus.Processing", "ErrorGeneric": "@roblox/enum/AnimationClipFromVideoStatus.ErrorGeneric", "Success": "@roblox/enum/AnimationClipFromVideoStatus.Success", "ErrorVideoTooLong": "@roblox/enum/AnimationClipFromVideoStatus.ErrorVideoTooLong", "ErrorNoPersonDetected": "@roblox/enum/AnimationClipFromVideoStatus.ErrorNoPersonDetected", "ErrorVideoUnstable": "@roblox/enum/AnimationClipFromVideoStatus.ErrorVideoUnstable", "Timeout": "@roblox/enum/AnimationClipFromVideoStatus.Timeout", "Cancelled": "@roblox/enum/AnimationClipFromVideoStatus.Cancelled", "ErrorMultiplePeople": "@roblox/enum/AnimationClipFromVideoStatus.ErrorMultiplePeople", "ErrorUploadingVideo": "@roblox/enum/AnimationClipFromVideoStatus.ErrorUploadingVideo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnimationClipFromVideoStatus", "code_sample": "" }, "@roblox/enum/UserInputState.Begin": { "documentation": "Occurs when an InputObject starts to interact with the experience. For example, a mouse button down, a key down, or when the player begins touching the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputState#Begin", "code_sample": "" }, "@roblox/enum/UserInputState.Change": { "documentation": "Occurs each frame an InputObject has already begun interacting with the experience and part of its state is changing. For example, movement of the mouse position, a gamepad thumbstick movement, an analog gamepad trigger button change, or screen touch point change.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputState#Change", "code_sample": "" }, "@roblox/enum/UserInputState.End": { "documentation": "Occurs when an InputObject finishes interacting with the experience. For example, a mouse button up, a key up, or when the player stops touching the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputState#End", "code_sample": "" }, "@roblox/enum/UserInputState.Cancel": { "documentation": "A special circumstance state that indicates this input is no longer relevant, particularly with ContextActionService. For example, binding two action-handling functions will cause the first to Cancel if an input was already in-progress when the second was bound.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputState#Cancel", "code_sample": "" }, "@roblox/enum/UserInputState.None": { "documentation": "A state that should never be seen in an experience; essentially just marks the end of the enum.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputState#None", "code_sample": "" }, "@roblox/global/Enum.UserInputState": { "documentation": "This enum describes the state of an input that is currently or was recently performed.", "keys": { "Begin": "@roblox/enum/UserInputState.Begin", "Change": "@roblox/enum/UserInputState.Change", "End": "@roblox/enum/UserInputState.End", "Cancel": "@roblox/enum/UserInputState.Cancel", "None": "@roblox/enum/UserInputState.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputState", "code_sample": "" }, "@roblox/enum/KeyCode.Unknown": { "documentation": "Blank value that represents no key being pressed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Unknown", "code_sample": "" }, "@roblox/enum/KeyCode.Backspace": { "documentation": "The Backspace key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Backspace", "code_sample": "" }, "@roblox/enum/KeyCode.Tab": { "documentation": "The Tab key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Tab", "code_sample": "" }, "@roblox/enum/KeyCode.Clear": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Clear", "code_sample": "" }, "@roblox/enum/KeyCode.Return": { "documentation": "Frequently known as Enter.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Return", "code_sample": "" }, "@roblox/enum/KeyCode.Pause": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Pause", "code_sample": "" }, "@roblox/enum/KeyCode.Escape": { "documentation": "The Escape key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Escape", "code_sample": "" }, "@roblox/enum/KeyCode.Space": { "documentation": "The Space key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Space", "code_sample": "" }, "@roblox/enum/KeyCode.QuotedDouble": { "documentation": "The \" key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#QuotedDouble", "code_sample": "" }, "@roblox/enum/KeyCode.Hash": { "documentation": "The # key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Hash", "code_sample": "" }, "@roblox/enum/KeyCode.Dollar": { "documentation": "The $ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Dollar", "code_sample": "" }, "@roblox/enum/KeyCode.Percent": { "documentation": "The % key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Percent", "code_sample": "" }, "@roblox/enum/KeyCode.Ampersand": { "documentation": "The & key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Ampersand", "code_sample": "" }, "@roblox/enum/KeyCode.Quote": { "documentation": "The ' key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Quote", "code_sample": "" }, "@roblox/enum/KeyCode.LeftParenthesis": { "documentation": "The ( key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftParenthesis", "code_sample": "" }, "@roblox/enum/KeyCode.RightParenthesis": { "documentation": "The ) key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightParenthesis", "code_sample": "" }, "@roblox/enum/KeyCode.Asterisk": { "documentation": "The * key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Asterisk", "code_sample": "" }, "@roblox/enum/KeyCode.Plus": { "documentation": "The + key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Plus", "code_sample": "" }, "@roblox/enum/KeyCode.Comma": { "documentation": "The , key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Comma", "code_sample": "" }, "@roblox/enum/KeyCode.Minus": { "documentation": "The - key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Minus", "code_sample": "" }, "@roblox/enum/KeyCode.Period": { "documentation": "The . key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Period", "code_sample": "" }, "@roblox/enum/KeyCode.Slash": { "documentation": "The / key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Slash", "code_sample": "" }, "@roblox/enum/KeyCode.Zero": { "documentation": "The 0 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Zero", "code_sample": "" }, "@roblox/enum/KeyCode.One": { "documentation": "The 1 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#One", "code_sample": "" }, "@roblox/enum/KeyCode.Two": { "documentation": "The 2 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Two", "code_sample": "" }, "@roblox/enum/KeyCode.Three": { "documentation": "The 3 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Three", "code_sample": "" }, "@roblox/enum/KeyCode.Four": { "documentation": "The 4 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Four", "code_sample": "" }, "@roblox/enum/KeyCode.Five": { "documentation": "The 5 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Five", "code_sample": "" }, "@roblox/enum/KeyCode.Six": { "documentation": "The 6 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Six", "code_sample": "" }, "@roblox/enum/KeyCode.Seven": { "documentation": "The 7 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Seven", "code_sample": "" }, "@roblox/enum/KeyCode.Eight": { "documentation": "The 8 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Eight", "code_sample": "" }, "@roblox/enum/KeyCode.Nine": { "documentation": "The 9 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Nine", "code_sample": "" }, "@roblox/enum/KeyCode.Colon": { "documentation": "The : key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Colon", "code_sample": "" }, "@roblox/enum/KeyCode.Semicolon": { "documentation": "The ; key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Semicolon", "code_sample": "" }, "@roblox/enum/KeyCode.LessThan": { "documentation": "The < key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LessThan", "code_sample": "" }, "@roblox/enum/KeyCode.Equals": { "documentation": "The = key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Equals", "code_sample": "" }, "@roblox/enum/KeyCode.GreaterThan": { "documentation": "The > key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#GreaterThan", "code_sample": "" }, "@roblox/enum/KeyCode.Question": { "documentation": "The ? key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Question", "code_sample": "" }, "@roblox/enum/KeyCode.At": { "documentation": "The @ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#At", "code_sample": "" }, "@roblox/enum/KeyCode.LeftBracket": { "documentation": "The [ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftBracket", "code_sample": "" }, "@roblox/enum/KeyCode.BackSlash": { "documentation": "The \\ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#BackSlash", "code_sample": "" }, "@roblox/enum/KeyCode.RightBracket": { "documentation": "The ] key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightBracket", "code_sample": "" }, "@roblox/enum/KeyCode.Caret": { "documentation": "The ^ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Caret", "code_sample": "" }, "@roblox/enum/KeyCode.Underscore": { "documentation": "The _ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Underscore", "code_sample": "" }, "@roblox/enum/KeyCode.Backquote": { "documentation": "The ` key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Backquote", "code_sample": "" }, "@roblox/enum/KeyCode.A": { "documentation": "The A key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#A", "code_sample": "" }, "@roblox/enum/KeyCode.B": { "documentation": "The B key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#B", "code_sample": "" }, "@roblox/enum/KeyCode.C": { "documentation": "The C key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#C", "code_sample": "" }, "@roblox/enum/KeyCode.D": { "documentation": "The D key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#D", "code_sample": "" }, "@roblox/enum/KeyCode.E": { "documentation": "The E key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#E", "code_sample": "" }, "@roblox/enum/KeyCode.F": { "documentation": "The F key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F", "code_sample": "" }, "@roblox/enum/KeyCode.G": { "documentation": "The G key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#G", "code_sample": "" }, "@roblox/enum/KeyCode.H": { "documentation": "The H key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#H", "code_sample": "" }, "@roblox/enum/KeyCode.I": { "documentation": "The I key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#I", "code_sample": "" }, "@roblox/enum/KeyCode.J": { "documentation": "The J key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#J", "code_sample": "" }, "@roblox/enum/KeyCode.K": { "documentation": "The K key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#K", "code_sample": "" }, "@roblox/enum/KeyCode.L": { "documentation": "The L key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#L", "code_sample": "" }, "@roblox/enum/KeyCode.M": { "documentation": "The M key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#M", "code_sample": "" }, "@roblox/enum/KeyCode.N": { "documentation": "The N key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#N", "code_sample": "" }, "@roblox/enum/KeyCode.O": { "documentation": "The O key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#O", "code_sample": "" }, "@roblox/enum/KeyCode.P": { "documentation": "The P key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#P", "code_sample": "" }, "@roblox/enum/KeyCode.Q": { "documentation": "The Q key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Q", "code_sample": "" }, "@roblox/enum/KeyCode.R": { "documentation": "The R key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#R", "code_sample": "" }, "@roblox/enum/KeyCode.S": { "documentation": "The S key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#S", "code_sample": "" }, "@roblox/enum/KeyCode.T": { "documentation": "The T key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#T", "code_sample": "" }, "@roblox/enum/KeyCode.U": { "documentation": "The U key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#U", "code_sample": "" }, "@roblox/enum/KeyCode.V": { "documentation": "The V key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#V", "code_sample": "" }, "@roblox/enum/KeyCode.W": { "documentation": "The W key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#W", "code_sample": "" }, "@roblox/enum/KeyCode.X": { "documentation": "The X key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#X", "code_sample": "" }, "@roblox/enum/KeyCode.Y": { "documentation": "The Y key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Y", "code_sample": "" }, "@roblox/enum/KeyCode.Z": { "documentation": "The Z key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Z", "code_sample": "" }, "@roblox/enum/KeyCode.LeftCurly": { "documentation": "The { key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftCurly", "code_sample": "" }, "@roblox/enum/KeyCode.Pipe": { "documentation": "The | key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Pipe", "code_sample": "" }, "@roblox/enum/KeyCode.RightCurly": { "documentation": "The } key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightCurly", "code_sample": "" }, "@roblox/enum/KeyCode.Tilde": { "documentation": "The ~ key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Tilde", "code_sample": "" }, "@roblox/enum/KeyCode.Delete": { "documentation": "The Del key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Delete", "code_sample": "" }, "@roblox/enum/KeyCode.World0": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World0", "code_sample": "" }, "@roblox/enum/KeyCode.World1": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World1", "code_sample": "" }, "@roblox/enum/KeyCode.World2": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World2", "code_sample": "" }, "@roblox/enum/KeyCode.World3": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World3", "code_sample": "" }, "@roblox/enum/KeyCode.World4": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World4", "code_sample": "" }, "@roblox/enum/KeyCode.World5": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World5", "code_sample": "" }, "@roblox/enum/KeyCode.World6": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World6", "code_sample": "" }, "@roblox/enum/KeyCode.World7": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World7", "code_sample": "" }, "@roblox/enum/KeyCode.World8": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World8", "code_sample": "" }, "@roblox/enum/KeyCode.World9": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World9", "code_sample": "" }, "@roblox/enum/KeyCode.World10": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World10", "code_sample": "" }, "@roblox/enum/KeyCode.World11": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World11", "code_sample": "" }, "@roblox/enum/KeyCode.World12": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World12", "code_sample": "" }, "@roblox/enum/KeyCode.World13": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World13", "code_sample": "" }, "@roblox/enum/KeyCode.World14": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World14", "code_sample": "" }, "@roblox/enum/KeyCode.World15": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World15", "code_sample": "" }, "@roblox/enum/KeyCode.World16": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World16", "code_sample": "" }, "@roblox/enum/KeyCode.World17": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World17", "code_sample": "" }, "@roblox/enum/KeyCode.World18": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World18", "code_sample": "" }, "@roblox/enum/KeyCode.World19": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World19", "code_sample": "" }, "@roblox/enum/KeyCode.World20": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World20", "code_sample": "" }, "@roblox/enum/KeyCode.World21": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World21", "code_sample": "" }, "@roblox/enum/KeyCode.World22": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World22", "code_sample": "" }, "@roblox/enum/KeyCode.World23": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World23", "code_sample": "" }, "@roblox/enum/KeyCode.World24": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World24", "code_sample": "" }, "@roblox/enum/KeyCode.World25": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World25", "code_sample": "" }, "@roblox/enum/KeyCode.World26": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World26", "code_sample": "" }, "@roblox/enum/KeyCode.World27": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World27", "code_sample": "" }, "@roblox/enum/KeyCode.World28": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World28", "code_sample": "" }, "@roblox/enum/KeyCode.World29": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World29", "code_sample": "" }, "@roblox/enum/KeyCode.World30": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World30", "code_sample": "" }, "@roblox/enum/KeyCode.World31": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World31", "code_sample": "" }, "@roblox/enum/KeyCode.World32": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World32", "code_sample": "" }, "@roblox/enum/KeyCode.World33": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World33", "code_sample": "" }, "@roblox/enum/KeyCode.World34": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World34", "code_sample": "" }, "@roblox/enum/KeyCode.World35": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World35", "code_sample": "" }, "@roblox/enum/KeyCode.World36": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World36", "code_sample": "" }, "@roblox/enum/KeyCode.World37": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World37", "code_sample": "" }, "@roblox/enum/KeyCode.World38": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World38", "code_sample": "" }, "@roblox/enum/KeyCode.World39": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World39", "code_sample": "" }, "@roblox/enum/KeyCode.World40": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World40", "code_sample": "" }, "@roblox/enum/KeyCode.World41": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World41", "code_sample": "" }, "@roblox/enum/KeyCode.World42": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World42", "code_sample": "" }, "@roblox/enum/KeyCode.World43": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World43", "code_sample": "" }, "@roblox/enum/KeyCode.World44": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World44", "code_sample": "" }, "@roblox/enum/KeyCode.World45": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World45", "code_sample": "" }, "@roblox/enum/KeyCode.World46": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World46", "code_sample": "" }, "@roblox/enum/KeyCode.World47": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World47", "code_sample": "" }, "@roblox/enum/KeyCode.World48": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World48", "code_sample": "" }, "@roblox/enum/KeyCode.World49": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World49", "code_sample": "" }, "@roblox/enum/KeyCode.World50": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World50", "code_sample": "" }, "@roblox/enum/KeyCode.World51": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World51", "code_sample": "" }, "@roblox/enum/KeyCode.World52": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World52", "code_sample": "" }, "@roblox/enum/KeyCode.World53": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World53", "code_sample": "" }, "@roblox/enum/KeyCode.World54": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World54", "code_sample": "" }, "@roblox/enum/KeyCode.World55": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World55", "code_sample": "" }, "@roblox/enum/KeyCode.World56": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World56", "code_sample": "" }, "@roblox/enum/KeyCode.World57": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World57", "code_sample": "" }, "@roblox/enum/KeyCode.World58": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World58", "code_sample": "" }, "@roblox/enum/KeyCode.World59": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World59", "code_sample": "" }, "@roblox/enum/KeyCode.World60": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World60", "code_sample": "" }, "@roblox/enum/KeyCode.World61": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World61", "code_sample": "" }, "@roblox/enum/KeyCode.World62": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World62", "code_sample": "" }, "@roblox/enum/KeyCode.World63": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World63", "code_sample": "" }, "@roblox/enum/KeyCode.World64": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World64", "code_sample": "" }, "@roblox/enum/KeyCode.World65": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World65", "code_sample": "" }, "@roblox/enum/KeyCode.World66": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World66", "code_sample": "" }, "@roblox/enum/KeyCode.World67": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World67", "code_sample": "" }, "@roblox/enum/KeyCode.World68": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World68", "code_sample": "" }, "@roblox/enum/KeyCode.World69": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World69", "code_sample": "" }, "@roblox/enum/KeyCode.World70": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World70", "code_sample": "" }, "@roblox/enum/KeyCode.World71": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World71", "code_sample": "" }, "@roblox/enum/KeyCode.World72": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World72", "code_sample": "" }, "@roblox/enum/KeyCode.World73": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World73", "code_sample": "" }, "@roblox/enum/KeyCode.World74": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World74", "code_sample": "" }, "@roblox/enum/KeyCode.World75": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World75", "code_sample": "" }, "@roblox/enum/KeyCode.World76": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World76", "code_sample": "" }, "@roblox/enum/KeyCode.World77": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World77", "code_sample": "" }, "@roblox/enum/KeyCode.World78": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World78", "code_sample": "" }, "@roblox/enum/KeyCode.World79": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World79", "code_sample": "" }, "@roblox/enum/KeyCode.World80": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World80", "code_sample": "" }, "@roblox/enum/KeyCode.World81": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World81", "code_sample": "" }, "@roblox/enum/KeyCode.World82": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World82", "code_sample": "" }, "@roblox/enum/KeyCode.World83": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World83", "code_sample": "" }, "@roblox/enum/KeyCode.World84": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World84", "code_sample": "" }, "@roblox/enum/KeyCode.World85": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World85", "code_sample": "" }, "@roblox/enum/KeyCode.World86": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World86", "code_sample": "" }, "@roblox/enum/KeyCode.World87": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World87", "code_sample": "" }, "@roblox/enum/KeyCode.World88": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World88", "code_sample": "" }, "@roblox/enum/KeyCode.World89": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World89", "code_sample": "" }, "@roblox/enum/KeyCode.World90": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World90", "code_sample": "" }, "@roblox/enum/KeyCode.World91": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World91", "code_sample": "" }, "@roblox/enum/KeyCode.World92": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World92", "code_sample": "" }, "@roblox/enum/KeyCode.World93": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World93", "code_sample": "" }, "@roblox/enum/KeyCode.World94": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World94", "code_sample": "" }, "@roblox/enum/KeyCode.World95": { "documentation": "Deprecated: ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#World95", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadZero": { "documentation": "The 0 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadZero", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadOne": { "documentation": "The 1 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadOne", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadTwo": { "documentation": "The 2 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadTwo", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadThree": { "documentation": "The 3 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadThree", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadFour": { "documentation": "The 4 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadFour", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadFive": { "documentation": "The 5 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadFive", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadSix": { "documentation": "The 6 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadSix", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadSeven": { "documentation": "The 7 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadSeven", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadEight": { "documentation": "The 8 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadEight", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadNine": { "documentation": "The 9 key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadNine", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadPeriod": { "documentation": "The . key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadPeriod", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadDivide": { "documentation": "The / key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadDivide", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadMultiply": { "documentation": "The * key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadMultiply", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadMinus": { "documentation": "The - key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadMinus", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadPlus": { "documentation": "The + key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadPlus", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadEnter": { "documentation": "The Enter key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadEnter", "code_sample": "" }, "@roblox/enum/KeyCode.KeypadEquals": { "documentation": "The = key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#KeypadEquals", "code_sample": "" }, "@roblox/enum/KeyCode.Up": { "documentation": "The ↑ arrow key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Up", "code_sample": "" }, "@roblox/enum/KeyCode.Down": { "documentation": "The ↓ arrow key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Down", "code_sample": "" }, "@roblox/enum/KeyCode.Right": { "documentation": "The → arrow key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Right", "code_sample": "" }, "@roblox/enum/KeyCode.Left": { "documentation": "The ← arrow key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Left", "code_sample": "" }, "@roblox/enum/KeyCode.Insert": { "documentation": "The Insert key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Insert", "code_sample": "" }, "@roblox/enum/KeyCode.Home": { "documentation": "The Home key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Home", "code_sample": "" }, "@roblox/enum/KeyCode.End": { "documentation": "The End key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#End", "code_sample": "" }, "@roblox/enum/KeyCode.PageUp": { "documentation": "The PgUp key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#PageUp", "code_sample": "" }, "@roblox/enum/KeyCode.PageDown": { "documentation": "The PgDown key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#PageDown", "code_sample": "" }, "@roblox/enum/KeyCode.F1": { "documentation": "The F1 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F1", "code_sample": "" }, "@roblox/enum/KeyCode.F2": { "documentation": "The F2 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F2", "code_sample": "" }, "@roblox/enum/KeyCode.F3": { "documentation": "The F3 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F3", "code_sample": "" }, "@roblox/enum/KeyCode.F4": { "documentation": "The F4 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F4", "code_sample": "" }, "@roblox/enum/KeyCode.F5": { "documentation": "The F5 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F5", "code_sample": "" }, "@roblox/enum/KeyCode.F6": { "documentation": "The F6 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F6", "code_sample": "" }, "@roblox/enum/KeyCode.F7": { "documentation": "The F7 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F7", "code_sample": "" }, "@roblox/enum/KeyCode.F8": { "documentation": "The F8 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F8", "code_sample": "" }, "@roblox/enum/KeyCode.F9": { "documentation": "The F9 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F9", "code_sample": "" }, "@roblox/enum/KeyCode.F10": { "documentation": "The F10 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F10", "code_sample": "" }, "@roblox/enum/KeyCode.F11": { "documentation": "The F11 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F11", "code_sample": "" }, "@roblox/enum/KeyCode.F12": { "documentation": "The F12 key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F12", "code_sample": "" }, "@roblox/enum/KeyCode.F13": { "documentation": "The F13 key. Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F13", "code_sample": "" }, "@roblox/enum/KeyCode.F14": { "documentation": "The F14 key. Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F14", "code_sample": "" }, "@roblox/enum/KeyCode.F15": { "documentation": "The F15 key. Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#F15", "code_sample": "" }, "@roblox/enum/KeyCode.NumLock": { "documentation": "The Num Lock key on the keypad cluster.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#NumLock", "code_sample": "" }, "@roblox/enum/KeyCode.CapsLock": { "documentation": "The Caps Lock key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#CapsLock", "code_sample": "" }, "@roblox/enum/KeyCode.ScrollLock": { "documentation": "The Scr Lock key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ScrollLock", "code_sample": "" }, "@roblox/enum/KeyCode.RightShift": { "documentation": "The right side Shift key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightShift", "code_sample": "" }, "@roblox/enum/KeyCode.LeftShift": { "documentation": "The left side Shift key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftShift", "code_sample": "" }, "@roblox/enum/KeyCode.RightControl": { "documentation": "The right side Ctrl key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightControl", "code_sample": "" }, "@roblox/enum/KeyCode.LeftControl": { "documentation": "The left side Ctrl key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftControl", "code_sample": "" }, "@roblox/enum/KeyCode.RightAlt": { "documentation": "The right side Alt key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightAlt", "code_sample": "" }, "@roblox/enum/KeyCode.LeftAlt": { "documentation": "The left side Alt key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftAlt", "code_sample": "" }, "@roblox/enum/KeyCode.RightMeta": { "documentation": "The right side Meta key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightMeta", "code_sample": "" }, "@roblox/enum/KeyCode.LeftMeta": { "documentation": "The left side Meta key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftMeta", "code_sample": "" }, "@roblox/enum/KeyCode.LeftSuper": { "documentation": "The left side Super key. Better known as the Windows key or Cmd key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#LeftSuper", "code_sample": "" }, "@roblox/enum/KeyCode.RightSuper": { "documentation": "The right side Super key. Better known as the Windows key or Cmd key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#RightSuper", "code_sample": "" }, "@roblox/enum/KeyCode.Mode": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Mode", "code_sample": "" }, "@roblox/enum/KeyCode.Compose": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Compose", "code_sample": "" }, "@roblox/enum/KeyCode.Help": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Help", "code_sample": "" }, "@roblox/enum/KeyCode.Print": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Print", "code_sample": "" }, "@roblox/enum/KeyCode.SysReq": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#SysReq", "code_sample": "" }, "@roblox/enum/KeyCode.Break": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Break", "code_sample": "" }, "@roblox/enum/KeyCode.Menu": { "documentation": "The Menu key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Menu", "code_sample": "" }, "@roblox/enum/KeyCode.Power": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Power", "code_sample": "" }, "@roblox/enum/KeyCode.Euro": { "documentation": "The € key. Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Euro", "code_sample": "" }, "@roblox/enum/KeyCode.Undo": { "documentation": "Only present on certain keyboards.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Undo", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonX": { "documentation": "Gamepad X button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonX", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonY": { "documentation": "Gamepad Y button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonY", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonA": { "documentation": "Gamepad A button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonA", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonB": { "documentation": "Gamepad B button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonB", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonR1": { "documentation": "Gamepad R1 button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonR1", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonL1": { "documentation": "Gamepad L1 button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonL1", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonR2": { "documentation": "Gamepad R2 button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonR2", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonL2": { "documentation": "Gamepad L2 button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonL2", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonR3": { "documentation": "Gamepad R3 button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonR3", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonL3": { "documentation": "Gamepad L3 button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonL3", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonStart": { "documentation": "Gamepad Start button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonStart", "code_sample": "" }, "@roblox/enum/KeyCode.ButtonSelect": { "documentation": "Gamepad Select button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#ButtonSelect", "code_sample": "" }, "@roblox/enum/KeyCode.DPadLeft": { "documentation": "Left arrow on a gamepad D-pad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#DPadLeft", "code_sample": "" }, "@roblox/enum/KeyCode.DPadRight": { "documentation": "Right arrow on a gamepad D-pad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#DPadRight", "code_sample": "" }, "@roblox/enum/KeyCode.DPadUp": { "documentation": "Up arrow on a gamepad D-pad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#DPadUp", "code_sample": "" }, "@roblox/enum/KeyCode.DPadDown": { "documentation": "Down arrow on a gamepad D-pad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#DPadDown", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick1": { "documentation": "Gamepad primary thumbstick.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick2": { "documentation": "Gamepad secondary thumbstick.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick1Up": { "documentation": "Up vector on the gamepad primary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Up", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick1Down": { "documentation": "Down vector on the gamepad primary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Down", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick1Left": { "documentation": "Left vector on the gamepad primary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Left", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick1Right": { "documentation": "Right vector on the gamepad primary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick1Right", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick2Up": { "documentation": "Up vector on the gamepad secondary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Up", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick2Down": { "documentation": "Down vector on the gamepad secondary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Down", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick2Left": { "documentation": "Left vector on the gamepad secondary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Left", "code_sample": "" }, "@roblox/enum/KeyCode.Thumbstick2Right": { "documentation": "Right vector on the gamepad secondary thumbstick. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Thumbstick2Right", "code_sample": "" }, "@roblox/enum/KeyCode.MouseLeftButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseLeftButton", "code_sample": "" }, "@roblox/enum/KeyCode.MouseRightButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseRightButton", "code_sample": "" }, "@roblox/enum/KeyCode.MouseMiddleButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseMiddleButton", "code_sample": "" }, "@roblox/enum/KeyCode.MouseBackButton": { "documentation": "Deprecated: This enum is deprecated and flagged for removal.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseBackButton", "code_sample": "" }, "@roblox/enum/KeyCode.MouseNoButton": { "documentation": "Deprecated: This enum is deprecated and flagged for removal.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseNoButton", "code_sample": "" }, "@roblox/enum/KeyCode.MouseX": { "documentation": "Deprecated: This enum is deprecated and flagged for removal.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseX", "code_sample": "" }, "@roblox/enum/KeyCode.MouseY": { "documentation": "Deprecated: This enum is deprecated and flagged for removal.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MouseY", "code_sample": "" }, "@roblox/enum/KeyCode.MousePosition": { "documentation": "The position of a mouse in the viewport. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#MousePosition", "code_sample": "" }, "@roblox/enum/KeyCode.Touch": { "documentation": "The position of a touch in the viewport. Primarily used in the Input Action System.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode#Touch", "code_sample": "" }, "@roblox/global/Enum.KeyCode": { "documentation": "Byte keycodes that represent the key or button involved in user input.", "keys": { "Unknown": "@roblox/enum/KeyCode.Unknown", "Backspace": "@roblox/enum/KeyCode.Backspace", "Tab": "@roblox/enum/KeyCode.Tab", "Clear": "@roblox/enum/KeyCode.Clear", "Return": "@roblox/enum/KeyCode.Return", "Pause": "@roblox/enum/KeyCode.Pause", "Escape": "@roblox/enum/KeyCode.Escape", "Space": "@roblox/enum/KeyCode.Space", "QuotedDouble": "@roblox/enum/KeyCode.QuotedDouble", "Hash": "@roblox/enum/KeyCode.Hash", "Dollar": "@roblox/enum/KeyCode.Dollar", "Percent": "@roblox/enum/KeyCode.Percent", "Ampersand": "@roblox/enum/KeyCode.Ampersand", "Quote": "@roblox/enum/KeyCode.Quote", "LeftParenthesis": "@roblox/enum/KeyCode.LeftParenthesis", "RightParenthesis": "@roblox/enum/KeyCode.RightParenthesis", "Asterisk": "@roblox/enum/KeyCode.Asterisk", "Plus": "@roblox/enum/KeyCode.Plus", "Comma": "@roblox/enum/KeyCode.Comma", "Minus": "@roblox/enum/KeyCode.Minus", "Period": "@roblox/enum/KeyCode.Period", "Slash": "@roblox/enum/KeyCode.Slash", "Zero": "@roblox/enum/KeyCode.Zero", "One": "@roblox/enum/KeyCode.One", "Two": "@roblox/enum/KeyCode.Two", "Three": "@roblox/enum/KeyCode.Three", "Four": "@roblox/enum/KeyCode.Four", "Five": "@roblox/enum/KeyCode.Five", "Six": "@roblox/enum/KeyCode.Six", "Seven": "@roblox/enum/KeyCode.Seven", "Eight": "@roblox/enum/KeyCode.Eight", "Nine": "@roblox/enum/KeyCode.Nine", "Colon": "@roblox/enum/KeyCode.Colon", "Semicolon": "@roblox/enum/KeyCode.Semicolon", "LessThan": "@roblox/enum/KeyCode.LessThan", "Equals": "@roblox/enum/KeyCode.Equals", "GreaterThan": "@roblox/enum/KeyCode.GreaterThan", "Question": "@roblox/enum/KeyCode.Question", "At": "@roblox/enum/KeyCode.At", "LeftBracket": "@roblox/enum/KeyCode.LeftBracket", "BackSlash": "@roblox/enum/KeyCode.BackSlash", "RightBracket": "@roblox/enum/KeyCode.RightBracket", "Caret": "@roblox/enum/KeyCode.Caret", "Underscore": "@roblox/enum/KeyCode.Underscore", "Backquote": "@roblox/enum/KeyCode.Backquote", "A": "@roblox/enum/KeyCode.A", "B": "@roblox/enum/KeyCode.B", "C": "@roblox/enum/KeyCode.C", "D": "@roblox/enum/KeyCode.D", "E": "@roblox/enum/KeyCode.E", "F": "@roblox/enum/KeyCode.F", "G": "@roblox/enum/KeyCode.G", "H": "@roblox/enum/KeyCode.H", "I": "@roblox/enum/KeyCode.I", "J": "@roblox/enum/KeyCode.J", "K": "@roblox/enum/KeyCode.K", "L": "@roblox/enum/KeyCode.L", "M": "@roblox/enum/KeyCode.M", "N": "@roblox/enum/KeyCode.N", "O": "@roblox/enum/KeyCode.O", "P": "@roblox/enum/KeyCode.P", "Q": "@roblox/enum/KeyCode.Q", "R": "@roblox/enum/KeyCode.R", "S": "@roblox/enum/KeyCode.S", "T": "@roblox/enum/KeyCode.T", "U": "@roblox/enum/KeyCode.U", "V": "@roblox/enum/KeyCode.V", "W": "@roblox/enum/KeyCode.W", "X": "@roblox/enum/KeyCode.X", "Y": "@roblox/enum/KeyCode.Y", "Z": "@roblox/enum/KeyCode.Z", "LeftCurly": "@roblox/enum/KeyCode.LeftCurly", "Pipe": "@roblox/enum/KeyCode.Pipe", "RightCurly": "@roblox/enum/KeyCode.RightCurly", "Tilde": "@roblox/enum/KeyCode.Tilde", "Delete": "@roblox/enum/KeyCode.Delete", "World0": "@roblox/enum/KeyCode.World0", "World1": "@roblox/enum/KeyCode.World1", "World2": "@roblox/enum/KeyCode.World2", "World3": "@roblox/enum/KeyCode.World3", "World4": "@roblox/enum/KeyCode.World4", "World5": "@roblox/enum/KeyCode.World5", "World6": "@roblox/enum/KeyCode.World6", "World7": "@roblox/enum/KeyCode.World7", "World8": "@roblox/enum/KeyCode.World8", "World9": "@roblox/enum/KeyCode.World9", "World10": "@roblox/enum/KeyCode.World10", "World11": "@roblox/enum/KeyCode.World11", "World12": "@roblox/enum/KeyCode.World12", "World13": "@roblox/enum/KeyCode.World13", "World14": "@roblox/enum/KeyCode.World14", "World15": "@roblox/enum/KeyCode.World15", "World16": "@roblox/enum/KeyCode.World16", "World17": "@roblox/enum/KeyCode.World17", "World18": "@roblox/enum/KeyCode.World18", "World19": "@roblox/enum/KeyCode.World19", "World20": "@roblox/enum/KeyCode.World20", "World21": "@roblox/enum/KeyCode.World21", "World22": "@roblox/enum/KeyCode.World22", "World23": "@roblox/enum/KeyCode.World23", "World24": "@roblox/enum/KeyCode.World24", "World25": "@roblox/enum/KeyCode.World25", "World26": "@roblox/enum/KeyCode.World26", "World27": "@roblox/enum/KeyCode.World27", "World28": "@roblox/enum/KeyCode.World28", "World29": "@roblox/enum/KeyCode.World29", "World30": "@roblox/enum/KeyCode.World30", "World31": "@roblox/enum/KeyCode.World31", "World32": "@roblox/enum/KeyCode.World32", "World33": "@roblox/enum/KeyCode.World33", "World34": "@roblox/enum/KeyCode.World34", "World35": "@roblox/enum/KeyCode.World35", "World36": "@roblox/enum/KeyCode.World36", "World37": "@roblox/enum/KeyCode.World37", "World38": "@roblox/enum/KeyCode.World38", "World39": "@roblox/enum/KeyCode.World39", "World40": "@roblox/enum/KeyCode.World40", "World41": "@roblox/enum/KeyCode.World41", "World42": "@roblox/enum/KeyCode.World42", "World43": "@roblox/enum/KeyCode.World43", "World44": "@roblox/enum/KeyCode.World44", "World45": "@roblox/enum/KeyCode.World45", "World46": "@roblox/enum/KeyCode.World46", "World47": "@roblox/enum/KeyCode.World47", "World48": "@roblox/enum/KeyCode.World48", "World49": "@roblox/enum/KeyCode.World49", "World50": "@roblox/enum/KeyCode.World50", "World51": "@roblox/enum/KeyCode.World51", "World52": "@roblox/enum/KeyCode.World52", "World53": "@roblox/enum/KeyCode.World53", "World54": "@roblox/enum/KeyCode.World54", "World55": "@roblox/enum/KeyCode.World55", "World56": "@roblox/enum/KeyCode.World56", "World57": "@roblox/enum/KeyCode.World57", "World58": "@roblox/enum/KeyCode.World58", "World59": "@roblox/enum/KeyCode.World59", "World60": "@roblox/enum/KeyCode.World60", "World61": "@roblox/enum/KeyCode.World61", "World62": "@roblox/enum/KeyCode.World62", "World63": "@roblox/enum/KeyCode.World63", "World64": "@roblox/enum/KeyCode.World64", "World65": "@roblox/enum/KeyCode.World65", "World66": "@roblox/enum/KeyCode.World66", "World67": "@roblox/enum/KeyCode.World67", "World68": "@roblox/enum/KeyCode.World68", "World69": "@roblox/enum/KeyCode.World69", "World70": "@roblox/enum/KeyCode.World70", "World71": "@roblox/enum/KeyCode.World71", "World72": "@roblox/enum/KeyCode.World72", "World73": "@roblox/enum/KeyCode.World73", "World74": "@roblox/enum/KeyCode.World74", "World75": "@roblox/enum/KeyCode.World75", "World76": "@roblox/enum/KeyCode.World76", "World77": "@roblox/enum/KeyCode.World77", "World78": "@roblox/enum/KeyCode.World78", "World79": "@roblox/enum/KeyCode.World79", "World80": "@roblox/enum/KeyCode.World80", "World81": "@roblox/enum/KeyCode.World81", "World82": "@roblox/enum/KeyCode.World82", "World83": "@roblox/enum/KeyCode.World83", "World84": "@roblox/enum/KeyCode.World84", "World85": "@roblox/enum/KeyCode.World85", "World86": "@roblox/enum/KeyCode.World86", "World87": "@roblox/enum/KeyCode.World87", "World88": "@roblox/enum/KeyCode.World88", "World89": "@roblox/enum/KeyCode.World89", "World90": "@roblox/enum/KeyCode.World90", "World91": "@roblox/enum/KeyCode.World91", "World92": "@roblox/enum/KeyCode.World92", "World93": "@roblox/enum/KeyCode.World93", "World94": "@roblox/enum/KeyCode.World94", "World95": "@roblox/enum/KeyCode.World95", "KeypadZero": "@roblox/enum/KeyCode.KeypadZero", "KeypadOne": "@roblox/enum/KeyCode.KeypadOne", "KeypadTwo": "@roblox/enum/KeyCode.KeypadTwo", "KeypadThree": "@roblox/enum/KeyCode.KeypadThree", "KeypadFour": "@roblox/enum/KeyCode.KeypadFour", "KeypadFive": "@roblox/enum/KeyCode.KeypadFive", "KeypadSix": "@roblox/enum/KeyCode.KeypadSix", "KeypadSeven": "@roblox/enum/KeyCode.KeypadSeven", "KeypadEight": "@roblox/enum/KeyCode.KeypadEight", "KeypadNine": "@roblox/enum/KeyCode.KeypadNine", "KeypadPeriod": "@roblox/enum/KeyCode.KeypadPeriod", "KeypadDivide": "@roblox/enum/KeyCode.KeypadDivide", "KeypadMultiply": "@roblox/enum/KeyCode.KeypadMultiply", "KeypadMinus": "@roblox/enum/KeyCode.KeypadMinus", "KeypadPlus": "@roblox/enum/KeyCode.KeypadPlus", "KeypadEnter": "@roblox/enum/KeyCode.KeypadEnter", "KeypadEquals": "@roblox/enum/KeyCode.KeypadEquals", "Up": "@roblox/enum/KeyCode.Up", "Down": "@roblox/enum/KeyCode.Down", "Right": "@roblox/enum/KeyCode.Right", "Left": "@roblox/enum/KeyCode.Left", "Insert": "@roblox/enum/KeyCode.Insert", "Home": "@roblox/enum/KeyCode.Home", "End": "@roblox/enum/KeyCode.End", "PageUp": "@roblox/enum/KeyCode.PageUp", "PageDown": "@roblox/enum/KeyCode.PageDown", "F1": "@roblox/enum/KeyCode.F1", "F2": "@roblox/enum/KeyCode.F2", "F3": "@roblox/enum/KeyCode.F3", "F4": "@roblox/enum/KeyCode.F4", "F5": "@roblox/enum/KeyCode.F5", "F6": "@roblox/enum/KeyCode.F6", "F7": "@roblox/enum/KeyCode.F7", "F8": "@roblox/enum/KeyCode.F8", "F9": "@roblox/enum/KeyCode.F9", "F10": "@roblox/enum/KeyCode.F10", "F11": "@roblox/enum/KeyCode.F11", "F12": "@roblox/enum/KeyCode.F12", "F13": "@roblox/enum/KeyCode.F13", "F14": "@roblox/enum/KeyCode.F14", "F15": "@roblox/enum/KeyCode.F15", "NumLock": "@roblox/enum/KeyCode.NumLock", "CapsLock": "@roblox/enum/KeyCode.CapsLock", "ScrollLock": "@roblox/enum/KeyCode.ScrollLock", "RightShift": "@roblox/enum/KeyCode.RightShift", "LeftShift": "@roblox/enum/KeyCode.LeftShift", "RightControl": "@roblox/enum/KeyCode.RightControl", "LeftControl": "@roblox/enum/KeyCode.LeftControl", "RightAlt": "@roblox/enum/KeyCode.RightAlt", "LeftAlt": "@roblox/enum/KeyCode.LeftAlt", "RightMeta": "@roblox/enum/KeyCode.RightMeta", "LeftMeta": "@roblox/enum/KeyCode.LeftMeta", "LeftSuper": "@roblox/enum/KeyCode.LeftSuper", "RightSuper": "@roblox/enum/KeyCode.RightSuper", "Mode": "@roblox/enum/KeyCode.Mode", "Compose": "@roblox/enum/KeyCode.Compose", "Help": "@roblox/enum/KeyCode.Help", "Print": "@roblox/enum/KeyCode.Print", "SysReq": "@roblox/enum/KeyCode.SysReq", "Break": "@roblox/enum/KeyCode.Break", "Menu": "@roblox/enum/KeyCode.Menu", "Power": "@roblox/enum/KeyCode.Power", "Euro": "@roblox/enum/KeyCode.Euro", "Undo": "@roblox/enum/KeyCode.Undo", "ButtonX": "@roblox/enum/KeyCode.ButtonX", "ButtonY": "@roblox/enum/KeyCode.ButtonY", "ButtonA": "@roblox/enum/KeyCode.ButtonA", "ButtonB": "@roblox/enum/KeyCode.ButtonB", "ButtonR1": "@roblox/enum/KeyCode.ButtonR1", "ButtonL1": "@roblox/enum/KeyCode.ButtonL1", "ButtonR2": "@roblox/enum/KeyCode.ButtonR2", "ButtonL2": "@roblox/enum/KeyCode.ButtonL2", "ButtonR3": "@roblox/enum/KeyCode.ButtonR3", "ButtonL3": "@roblox/enum/KeyCode.ButtonL3", "ButtonStart": "@roblox/enum/KeyCode.ButtonStart", "ButtonSelect": "@roblox/enum/KeyCode.ButtonSelect", "DPadLeft": "@roblox/enum/KeyCode.DPadLeft", "DPadRight": "@roblox/enum/KeyCode.DPadRight", "DPadUp": "@roblox/enum/KeyCode.DPadUp", "DPadDown": "@roblox/enum/KeyCode.DPadDown", "Thumbstick1": "@roblox/enum/KeyCode.Thumbstick1", "Thumbstick2": "@roblox/enum/KeyCode.Thumbstick2", "Thumbstick1Up": "@roblox/enum/KeyCode.Thumbstick1Up", "Thumbstick1Down": "@roblox/enum/KeyCode.Thumbstick1Down", "Thumbstick1Left": "@roblox/enum/KeyCode.Thumbstick1Left", "Thumbstick1Right": "@roblox/enum/KeyCode.Thumbstick1Right", "Thumbstick2Up": "@roblox/enum/KeyCode.Thumbstick2Up", "Thumbstick2Down": "@roblox/enum/KeyCode.Thumbstick2Down", "Thumbstick2Left": "@roblox/enum/KeyCode.Thumbstick2Left", "Thumbstick2Right": "@roblox/enum/KeyCode.Thumbstick2Right", "MouseLeftButton": "@roblox/enum/KeyCode.MouseLeftButton", "MouseRightButton": "@roblox/enum/KeyCode.MouseRightButton", "MouseMiddleButton": "@roblox/enum/KeyCode.MouseMiddleButton", "MouseBackButton": "@roblox/enum/KeyCode.MouseBackButton", "MouseNoButton": "@roblox/enum/KeyCode.MouseNoButton", "MouseX": "@roblox/enum/KeyCode.MouseX", "MouseY": "@roblox/enum/KeyCode.MouseY", "MousePosition": "@roblox/enum/KeyCode.MousePosition", "Touch": "@roblox/enum/KeyCode.Touch" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyCode", "code_sample": "" }, "@roblox/enum/TeleportType.ToPlace": { "documentation": "The teleport destination is a place (no specific instance).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportType#ToPlace", "code_sample": "" }, "@roblox/enum/TeleportType.ToInstance": { "documentation": "The teleport destination is an instance of a place.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportType#ToInstance", "code_sample": "" }, "@roblox/enum/TeleportType.ToReservedServer": { "documentation": "The destination of the teleport is a reserved server (a place instance that is reserved for a select group of players).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportType#ToReservedServer", "code_sample": "" }, "@roblox/enum/TeleportType.ToVIPServer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportType#ToVIPServer", "code_sample": "" }, "@roblox/enum/TeleportType.ToInstanceBack": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportType#ToInstanceBack", "code_sample": "" }, "@roblox/global/Enum.TeleportType": { "documentation": "Determines the type of teleport destination for a TeleportService teleport call.", "keys": { "ToPlace": "@roblox/enum/TeleportType.ToPlace", "ToInstance": "@roblox/enum/TeleportType.ToInstance", "ToReservedServer": "@roblox/enum/TeleportType.ToReservedServer", "ToVIPServer": "@roblox/enum/TeleportType.ToVIPServer", "ToInstanceBack": "@roblox/enum/TeleportType.ToInstanceBack" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportType", "code_sample": "" }, "@roblox/enum/SurfaceType.Smooth": { "documentation": "Adds no details on the surface.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Smooth", "code_sample": "" }, "@roblox/enum/SurfaceType.Glue": { "documentation": "Adds an \"X\" pattern across the surface.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Glue", "code_sample": "" }, "@roblox/enum/SurfaceType.Weld": { "documentation": "Adds an \"X\" pattern across the surface.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Weld", "code_sample": "" }, "@roblox/enum/SurfaceType.Studs": { "documentation": "Adds square studs across the surface.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Studs", "code_sample": "" }, "@roblox/enum/SurfaceType.Inlet": { "documentation": "Adds square holes across the surface where studs would be.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Inlet", "code_sample": "" }, "@roblox/enum/SurfaceType.Universal": { "documentation": "Adds a checker pattern to the surface using studs and inlets.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Universal", "code_sample": "" }, "@roblox/enum/SurfaceType.Hinge": { "documentation": "Adds a yellow hinge to the surface. Parts touching it stick to the surface, allowing for rotations using physics. This should not be used for future work and existing instances should be replaced with a HingeConstraint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Hinge", "code_sample": "" }, "@roblox/enum/SurfaceType.Motor": { "documentation": "Functioned identically to a hinge with the addition of a grey ring.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#Motor", "code_sample": "" }, "@roblox/enum/SurfaceType.SteppingMotor": { "documentation": "Functioned identically to a motor. It may have functioned differently in the past, but that functionality is non-existent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#SteppingMotor", "code_sample": "" }, "@roblox/enum/SurfaceType.SmoothNoOutlines": { "documentation": "Previously similar to Smooth with outlines but no longer relevant since outlines have been removed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType#SmoothNoOutlines", "code_sample": "" }, "@roblox/global/Enum.SurfaceType": { "documentation": "Used to determine how a surface should be displayed on a part and how automatic surface joints should behave.", "keys": { "Smooth": "@roblox/enum/SurfaceType.Smooth", "Glue": "@roblox/enum/SurfaceType.Glue", "Weld": "@roblox/enum/SurfaceType.Weld", "Studs": "@roblox/enum/SurfaceType.Studs", "Inlet": "@roblox/enum/SurfaceType.Inlet", "Universal": "@roblox/enum/SurfaceType.Universal", "Hinge": "@roblox/enum/SurfaceType.Hinge", "Motor": "@roblox/enum/SurfaceType.Motor", "SteppingMotor": "@roblox/enum/SurfaceType.SteppingMotor", "SmoothNoOutlines": "@roblox/enum/SurfaceType.SmoothNoOutlines" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceType", "code_sample": "" }, "@roblox/enum/WebSocketState.Connecting": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Connecting", "code_sample": "" }, "@roblox/enum/WebSocketState.Open": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Open", "code_sample": "" }, "@roblox/enum/WebSocketState.Closing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Closing", "code_sample": "" }, "@roblox/enum/WebSocketState.Closed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebSocketState#Closed", "code_sample": "" }, "@roblox/global/Enum.WebSocketState": { "documentation": "", "keys": { "Connecting": "@roblox/enum/WebSocketState.Connecting", "Open": "@roblox/enum/WebSocketState.Open", "Closing": "@roblox/enum/WebSocketState.Closing", "Closed": "@roblox/enum/WebSocketState.Closed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebSocketState", "code_sample": "" }, "@roblox/enum/RecommendationActionType.AddReaction": { "documentation": "The user added a reaction to the item, such as a \"like\".", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#AddReaction", "code_sample": "" }, "@roblox/enum/RecommendationActionType.RemoveReaction": { "documentation": "The user removed a reaction from the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#RemoveReaction", "code_sample": "" }, "@roblox/enum/RecommendationActionType.Share": { "documentation": "The user shared the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#Share", "code_sample": "" }, "@roblox/enum/RecommendationActionType.Report": { "documentation": "The user created an abuse report of the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#Report", "code_sample": "" }, "@roblox/enum/RecommendationActionType.Comment": { "documentation": "The user commented on the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#Comment", "code_sample": "" }, "@roblox/enum/RecommendationActionType.Play": { "documentation": "The user joined an experience through the item, or played a mini-game associated with the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#Play", "code_sample": "" }, "@roblox/enum/RecommendationActionType.Purchase": { "documentation": "The user made a purchase from the item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType#Purchase", "code_sample": "" }, "@roblox/global/Enum.RecommendationActionType": { "documentation": "", "keys": { "AddReaction": "@roblox/enum/RecommendationActionType.AddReaction", "RemoveReaction": "@roblox/enum/RecommendationActionType.RemoveReaction", "Share": "@roblox/enum/RecommendationActionType.Share", "Report": "@roblox/enum/RecommendationActionType.Report", "Comment": "@roblox/enum/RecommendationActionType.Comment", "Play": "@roblox/enum/RecommendationActionType.Play", "Purchase": "@roblox/enum/RecommendationActionType.Purchase" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RecommendationActionType", "code_sample": "" }, "@roblox/enum/Font.Legacy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Legacy", "code_sample": "" }, "@roblox/enum/Font.Arial": { "documentation": "Arial has been removed. Using it will map to the Arimo font family of the Font data type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Arial", "code_sample": "" }, "@roblox/enum/Font.ArialBold": { "documentation": "ArialBold has been removed. Using it will map to the Arimo font family of the Font data type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#ArialBold", "code_sample": "" }, "@roblox/enum/Font.SourceSans": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SourceSans", "code_sample": "" }, "@roblox/enum/Font.SourceSansBold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansBold", "code_sample": "" }, "@roblox/enum/Font.SourceSansLight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansLight", "code_sample": "" }, "@roblox/enum/Font.SourceSansItalic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansItalic", "code_sample": "" }, "@roblox/enum/Font.Bodoni": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Bodoni", "code_sample": "" }, "@roblox/enum/Font.Garamond": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Garamond", "code_sample": "" }, "@roblox/enum/Font.Cartoon": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Cartoon", "code_sample": "" }, "@roblox/enum/Font.Code": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Code", "code_sample": "" }, "@roblox/enum/Font.Highway": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Highway", "code_sample": "" }, "@roblox/enum/Font.SciFi": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SciFi", "code_sample": "" }, "@roblox/enum/Font.Arcade": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Arcade", "code_sample": "" }, "@roblox/enum/Font.Fantasy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Fantasy", "code_sample": "" }, "@roblox/enum/Font.Antique": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Antique", "code_sample": "" }, "@roblox/enum/Font.SourceSansSemibold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SourceSansSemibold", "code_sample": "" }, "@roblox/enum/Font.Gotham": { "documentation": "Gotham has been removed. Using it will map to the Montserrat font family of the Font data type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Gotham", "code_sample": "" }, "@roblox/enum/Font.GothamMedium": { "documentation": "GothamMedium has been removed. Using it will map to the Montserrat font family of the Font data type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#GothamMedium", "code_sample": "" }, "@roblox/enum/Font.GothamBold": { "documentation": "GothamBold has been removed. Using it will map to the Montserrat font family of the Font data type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#GothamBold", "code_sample": "" }, "@roblox/enum/Font.GothamBlack": { "documentation": "GothamBlack has been removed. Using it will map to the Montserrat font family of the Font data type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#GothamBlack", "code_sample": "" }, "@roblox/enum/Font.AmaticSC": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#AmaticSC", "code_sample": "" }, "@roblox/enum/Font.Bangers": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Bangers", "code_sample": "" }, "@roblox/enum/Font.Creepster": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Creepster", "code_sample": "" }, "@roblox/enum/Font.DenkOne": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#DenkOne", "code_sample": "" }, "@roblox/enum/Font.Fondamento": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Fondamento", "code_sample": "" }, "@roblox/enum/Font.FredokaOne": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#FredokaOne", "code_sample": "" }, "@roblox/enum/Font.GrenzeGotisch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#GrenzeGotisch", "code_sample": "" }, "@roblox/enum/Font.IndieFlower": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#IndieFlower", "code_sample": "" }, "@roblox/enum/Font.JosefinSans": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#JosefinSans", "code_sample": "" }, "@roblox/enum/Font.Jura": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Jura", "code_sample": "" }, "@roblox/enum/Font.Kalam": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Kalam", "code_sample": "" }, "@roblox/enum/Font.LuckiestGuy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#LuckiestGuy", "code_sample": "" }, "@roblox/enum/Font.Merriweather": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Merriweather", "code_sample": "" }, "@roblox/enum/Font.Michroma": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Michroma", "code_sample": "" }, "@roblox/enum/Font.Nunito": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Nunito", "code_sample": "" }, "@roblox/enum/Font.Oswald": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Oswald", "code_sample": "" }, "@roblox/enum/Font.PatrickHand": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#PatrickHand", "code_sample": "" }, "@roblox/enum/Font.PermanentMarker": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#PermanentMarker", "code_sample": "" }, "@roblox/enum/Font.Roboto": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Roboto", "code_sample": "" }, "@roblox/enum/Font.RobotoCondensed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#RobotoCondensed", "code_sample": "" }, "@roblox/enum/Font.RobotoMono": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#RobotoMono", "code_sample": "" }, "@roblox/enum/Font.Sarpanch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Sarpanch", "code_sample": "" }, "@roblox/enum/Font.SpecialElite": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#SpecialElite", "code_sample": "" }, "@roblox/enum/Font.TitilliumWeb": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#TitilliumWeb", "code_sample": "" }, "@roblox/enum/Font.Ubuntu": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Ubuntu", "code_sample": "" }, "@roblox/enum/Font.BuilderSans": { "documentation": " See Builder Font License.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSans", "code_sample": "" }, "@roblox/enum/Font.BuilderSansMedium": { "documentation": " See Builder Font License.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSansMedium", "code_sample": "" }, "@roblox/enum/Font.BuilderSansBold": { "documentation": " See Builder Font License.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSansBold", "code_sample": "" }, "@roblox/enum/Font.BuilderSansExtraBold": { "documentation": " See Builder Font License.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#BuilderSansExtraBold", "code_sample": "" }, "@roblox/enum/Font.Arimo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Arimo", "code_sample": "" }, "@roblox/enum/Font.ArimoBold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#ArimoBold", "code_sample": "" }, "@roblox/enum/Font.Unknown": { "documentation": "Set when the GUI object's font face is set to a Font that has no corresponding enum value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font#Unknown", "code_sample": "" }, "@roblox/global/Enum.Font": { "documentation": "", "keys": { "Legacy": "@roblox/enum/Font.Legacy", "Arial": "@roblox/enum/Font.Arial", "ArialBold": "@roblox/enum/Font.ArialBold", "SourceSans": "@roblox/enum/Font.SourceSans", "SourceSansBold": "@roblox/enum/Font.SourceSansBold", "SourceSansLight": "@roblox/enum/Font.SourceSansLight", "SourceSansItalic": "@roblox/enum/Font.SourceSansItalic", "Bodoni": "@roblox/enum/Font.Bodoni", "Garamond": "@roblox/enum/Font.Garamond", "Cartoon": "@roblox/enum/Font.Cartoon", "Code": "@roblox/enum/Font.Code", "Highway": "@roblox/enum/Font.Highway", "SciFi": "@roblox/enum/Font.SciFi", "Arcade": "@roblox/enum/Font.Arcade", "Fantasy": "@roblox/enum/Font.Fantasy", "Antique": "@roblox/enum/Font.Antique", "SourceSansSemibold": "@roblox/enum/Font.SourceSansSemibold", "Gotham": "@roblox/enum/Font.Gotham", "GothamMedium": "@roblox/enum/Font.GothamMedium", "GothamBold": "@roblox/enum/Font.GothamBold", "GothamBlack": "@roblox/enum/Font.GothamBlack", "AmaticSC": "@roblox/enum/Font.AmaticSC", "Bangers": "@roblox/enum/Font.Bangers", "Creepster": "@roblox/enum/Font.Creepster", "DenkOne": "@roblox/enum/Font.DenkOne", "Fondamento": "@roblox/enum/Font.Fondamento", "FredokaOne": "@roblox/enum/Font.FredokaOne", "GrenzeGotisch": "@roblox/enum/Font.GrenzeGotisch", "IndieFlower": "@roblox/enum/Font.IndieFlower", "JosefinSans": "@roblox/enum/Font.JosefinSans", "Jura": "@roblox/enum/Font.Jura", "Kalam": "@roblox/enum/Font.Kalam", "LuckiestGuy": "@roblox/enum/Font.LuckiestGuy", "Merriweather": "@roblox/enum/Font.Merriweather", "Michroma": "@roblox/enum/Font.Michroma", "Nunito": "@roblox/enum/Font.Nunito", "Oswald": "@roblox/enum/Font.Oswald", "PatrickHand": "@roblox/enum/Font.PatrickHand", "PermanentMarker": "@roblox/enum/Font.PermanentMarker", "Roboto": "@roblox/enum/Font.Roboto", "RobotoCondensed": "@roblox/enum/Font.RobotoCondensed", "RobotoMono": "@roblox/enum/Font.RobotoMono", "Sarpanch": "@roblox/enum/Font.Sarpanch", "SpecialElite": "@roblox/enum/Font.SpecialElite", "TitilliumWeb": "@roblox/enum/Font.TitilliumWeb", "Ubuntu": "@roblox/enum/Font.Ubuntu", "BuilderSans": "@roblox/enum/Font.BuilderSans", "BuilderSansMedium": "@roblox/enum/Font.BuilderSansMedium", "BuilderSansBold": "@roblox/enum/Font.BuilderSansBold", "BuilderSansExtraBold": "@roblox/enum/Font.BuilderSansExtraBold", "Arimo": "@roblox/enum/Font.Arimo", "ArimoBold": "@roblox/enum/Font.ArimoBold", "Unknown": "@roblox/enum/Font.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Font", "code_sample": "" }, "@roblox/enum/CoreGuiType.PlayerList": { "documentation": "Dynamically updated Players list, commonly used as a leaderboard.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#PlayerList", "code_sample": "" }, "@roblox/enum/CoreGuiType.Health": { "documentation": "The character's Health bar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Health", "code_sample": "" }, "@roblox/enum/CoreGuiType.Backpack": { "documentation": "The character's Backpack which contains in‑experience tools.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Backpack", "code_sample": "" }, "@roblox/enum/CoreGuiType.Chat": { "documentation": "The text chat window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Chat", "code_sample": "" }, "@roblox/enum/CoreGuiType.All": { "documentation": "Refers to all available core UI.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#All", "code_sample": "" }, "@roblox/enum/CoreGuiType.EmotesMenu": { "documentation": "Popup menu of character emotes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#EmotesMenu", "code_sample": "" }, "@roblox/enum/CoreGuiType.SelfView": { "documentation": "A player's perspective or view of their own character.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#SelfView", "code_sample": "" }, "@roblox/enum/CoreGuiType.Captures": { "documentation": "A \"capture\" button along the right side of the screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#Captures", "code_sample": "" }, "@roblox/enum/CoreGuiType.AvatarSwitcher": { "documentation": "The Avatar Switcher allows users to change their platform avatar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType#AvatarSwitcher", "code_sample": "" }, "@roblox/global/Enum.CoreGuiType": { "documentation": "Represents all available CoreGui \"types\" such as the Backpack and text chat window.", "keys": { "PlayerList": "@roblox/enum/CoreGuiType.PlayerList", "Health": "@roblox/enum/CoreGuiType.Health", "Backpack": "@roblox/enum/CoreGuiType.Backpack", "Chat": "@roblox/enum/CoreGuiType.Chat", "All": "@roblox/enum/CoreGuiType.All", "EmotesMenu": "@roblox/enum/CoreGuiType.EmotesMenu", "SelfView": "@roblox/enum/CoreGuiType.SelfView", "Captures": "@roblox/enum/CoreGuiType.Captures", "AvatarSwitcher": "@roblox/enum/CoreGuiType.AvatarSwitcher" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CoreGuiType", "code_sample": "" }, "@roblox/enum/DialogBehaviorType.SinglePlayer": { "documentation": "Only one player can interact with this dialog at a time. The conversation between the player and dialog can be seen by all players.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogBehaviorType#SinglePlayer", "code_sample": "" }, "@roblox/enum/DialogBehaviorType.MultiplePlayers": { "documentation": "Multiple players can simultaneously interact with this dialog. The conversation between the player and the dialog cannot be seen by other players.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogBehaviorType#MultiplePlayers", "code_sample": "" }, "@roblox/global/Enum.DialogBehaviorType": { "documentation": "Controls whether multiple people can use this dialog, or only one person at a time can use it.", "keys": { "SinglePlayer": "@roblox/enum/DialogBehaviorType.SinglePlayer", "MultiplePlayers": "@roblox/enum/DialogBehaviorType.MultiplePlayers" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogBehaviorType", "code_sample": "" }, "@roblox/enum/ApplyStrokeMode.Contextual": { "documentation": "The stroke is applied to the parent UI element's text.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ApplyStrokeMode#Contextual", "code_sample": "" }, "@roblox/enum/ApplyStrokeMode.Border": { "documentation": "The stroke is applied to the parent UI element's border.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ApplyStrokeMode#Border", "code_sample": "" }, "@roblox/global/Enum.ApplyStrokeMode": { "documentation": "Used by UIStroke.ApplyStrokeMode to determine where to apply the stroke.", "keys": { "Contextual": "@roblox/enum/ApplyStrokeMode.Contextual", "Border": "@roblox/enum/ApplyStrokeMode.Border" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ApplyStrokeMode", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragSpace.Parent": { "documentation": "Designates the input and return values' space as the local space of the detector's parent GuiObject.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragSpace#Parent", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragSpace.LayerCollector": { "documentation": "Designates the input and return values' space as that of the LayerCollector.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragSpace#LayerCollector", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragSpace.Reference": { "documentation": "Designates the input and return values' space as that of the ReferenceUIInstance. For DragRelativity and DragUDim2 purposes, the (0, 0) origin is the absolute center position of the ReferenceUIInstance. If ReferenceUIInstance is not nil, this will behave the same as Parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragSpace#Reference", "code_sample": "" }, "@roblox/global/Enum.UIDragDetectorDragSpace": { "documentation": "Used with DragDetector to set the paradigm which defines the space of inputs/outputs from a custom drag function.", "keys": { "Parent": "@roblox/enum/UIDragDetectorDragSpace.Parent", "LayerCollector": "@roblox/enum/UIDragDetectorDragSpace.LayerCollector", "Reference": "@roblox/enum/UIDragDetectorDragSpace.Reference" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragSpace", "code_sample": "" }, "@roblox/enum/SelectionRenderMode.Outlines": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionRenderMode#Outlines", "code_sample": "" }, "@roblox/enum/SelectionRenderMode.BoundingBoxes": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionRenderMode#BoundingBoxes", "code_sample": "" }, "@roblox/enum/SelectionRenderMode.Both": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionRenderMode#Both", "code_sample": "" }, "@roblox/global/Enum.SelectionRenderMode": { "documentation": "", "keys": { "Outlines": "@roblox/enum/SelectionRenderMode.Outlines", "BoundingBoxes": "@roblox/enum/SelectionRenderMode.BoundingBoxes", "Both": "@roblox/enum/SelectionRenderMode.Both" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionRenderMode", "code_sample": "" }, "@roblox/enum/PhysicsSimulationRate.Fixed240Hz": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSimulationRate#Fixed240Hz", "code_sample": "" }, "@roblox/enum/PhysicsSimulationRate.Fixed120Hz": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSimulationRate#Fixed120Hz", "code_sample": "" }, "@roblox/enum/PhysicsSimulationRate.Fixed60Hz": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSimulationRate#Fixed60Hz", "code_sample": "" }, "@roblox/global/Enum.PhysicsSimulationRate": { "documentation": "", "keys": { "Fixed240Hz": "@roblox/enum/PhysicsSimulationRate.Fixed240Hz", "Fixed120Hz": "@roblox/enum/PhysicsSimulationRate.Fixed120Hz", "Fixed60Hz": "@roblox/enum/PhysicsSimulationRate.Fixed60Hz" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PhysicsSimulationRate", "code_sample": "" }, "@roblox/enum/HttpError.OK": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#OK", "code_sample": "" }, "@roblox/enum/HttpError.InvalidUrl": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#InvalidUrl", "code_sample": "" }, "@roblox/enum/HttpError.DnsResolve": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#DnsResolve", "code_sample": "" }, "@roblox/enum/HttpError.ConnectFail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#ConnectFail", "code_sample": "" }, "@roblox/enum/HttpError.OutOfMemory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#OutOfMemory", "code_sample": "" }, "@roblox/enum/HttpError.TimedOut": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#TimedOut", "code_sample": "" }, "@roblox/enum/HttpError.TooManyRedirects": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#TooManyRedirects", "code_sample": "" }, "@roblox/enum/HttpError.InvalidRedirect": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#InvalidRedirect", "code_sample": "" }, "@roblox/enum/HttpError.NetFail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#NetFail", "code_sample": "" }, "@roblox/enum/HttpError.Aborted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#Aborted", "code_sample": "" }, "@roblox/enum/HttpError.SslConnectFail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#SslConnectFail", "code_sample": "" }, "@roblox/enum/HttpError.SslVerificationFail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#SslVerificationFail", "code_sample": "" }, "@roblox/enum/HttpError.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#Unknown", "code_sample": "" }, "@roblox/enum/HttpError.ConnectionClosed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#ConnectionClosed", "code_sample": "" }, "@roblox/enum/HttpError.ServerProtocolError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#ServerProtocolError", "code_sample": "" }, "@roblox/enum/HttpError.CreatorEnvironmentsNotSupportedByService": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError#CreatorEnvironmentsNotSupportedByService", "code_sample": "" }, "@roblox/global/Enum.HttpError": { "documentation": "", "keys": { "OK": "@roblox/enum/HttpError.OK", "InvalidUrl": "@roblox/enum/HttpError.InvalidUrl", "DnsResolve": "@roblox/enum/HttpError.DnsResolve", "ConnectFail": "@roblox/enum/HttpError.ConnectFail", "OutOfMemory": "@roblox/enum/HttpError.OutOfMemory", "TimedOut": "@roblox/enum/HttpError.TimedOut", "TooManyRedirects": "@roblox/enum/HttpError.TooManyRedirects", "InvalidRedirect": "@roblox/enum/HttpError.InvalidRedirect", "NetFail": "@roblox/enum/HttpError.NetFail", "Aborted": "@roblox/enum/HttpError.Aborted", "SslConnectFail": "@roblox/enum/HttpError.SslConnectFail", "SslVerificationFail": "@roblox/enum/HttpError.SslVerificationFail", "Unknown": "@roblox/enum/HttpError.Unknown", "ConnectionClosed": "@roblox/enum/HttpError.ConnectionClosed", "ServerProtocolError": "@roblox/enum/HttpError.ServerProtocolError", "CreatorEnvironmentsNotSupportedByService": "@roblox/enum/HttpError.CreatorEnvironmentsNotSupportedByService" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpError", "code_sample": "" }, "@roblox/enum/UIDragDetectorResponseStyle.Offset": { "documentation": "Move by the Offset values of the detector's parent's GuiObject.Position value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorResponseStyle#Offset", "code_sample": "" }, "@roblox/enum/UIDragDetectorResponseStyle.Scale": { "documentation": "Move by the Scale values of the detector's parent's GuiObject.Position value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorResponseStyle#Scale", "code_sample": "" }, "@roblox/enum/UIDragDetectorResponseStyle.CustomOffset": { "documentation": "The UI element will not move at all, but the Offset values of the detector's DragUDim2 will still be updated and the detector's events will still fire, allowing you to respond to drag manipulation however you'd like.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorResponseStyle#CustomOffset", "code_sample": "" }, "@roblox/enum/UIDragDetectorResponseStyle.CustomScale": { "documentation": "The UI element will not move at all, but the Scale values of the detector's DragUDim2 will still be updated and the detector's events will still fire, allowing you to respond to drag manipulation however you'd like.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorResponseStyle#CustomScale", "code_sample": "" }, "@roblox/global/Enum.UIDragDetectorResponseStyle": { "documentation": "Describes how the clicked GuiObject will be treated once the desired motion has been calculated.", "keys": { "Offset": "@roblox/enum/UIDragDetectorResponseStyle.Offset", "Scale": "@roblox/enum/UIDragDetectorResponseStyle.Scale", "CustomOffset": "@roblox/enum/UIDragDetectorResponseStyle.CustomOffset", "CustomScale": "@roblox/enum/UIDragDetectorResponseStyle.CustomScale" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorResponseStyle", "code_sample": "" }, "@roblox/enum/SignalBehavior.Default": { "documentation": "The default behavior; currently equivalent to Immediate but this will eventually change to Deferred.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SignalBehavior#Default", "code_sample": "" }, "@roblox/enum/SignalBehavior.Immediate": { "documentation": "Event handlers are resumed immediately when the event occurs.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SignalBehavior#Immediate", "code_sample": "" }, "@roblox/enum/SignalBehavior.Deferred": { "documentation": "All events are deferred and their handlers resumed at specific resumptions points each frame.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SignalBehavior#Deferred", "code_sample": "" }, "@roblox/enum/SignalBehavior.AncestryDeferred": { "documentation": "Equivalent to Deferred but only for events triggered by changes in ancestry.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SignalBehavior#AncestryDeferred", "code_sample": "" }, "@roblox/global/Enum.SignalBehavior": { "documentation": "Determines when the engine resumes event handlers.", "keys": { "Default": "@roblox/enum/SignalBehavior.Default", "Immediate": "@roblox/enum/SignalBehavior.Immediate", "Deferred": "@roblox/enum/SignalBehavior.Deferred", "AncestryDeferred": "@roblox/enum/SignalBehavior.AncestryDeferred" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SignalBehavior", "code_sample": "" }, "@roblox/enum/CreatorTypeFilter.User": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter#User", "code_sample": "" }, "@roblox/enum/CreatorTypeFilter.Group": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter#Group", "code_sample": "" }, "@roblox/enum/CreatorTypeFilter.All": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter#All", "code_sample": "" }, "@roblox/global/Enum.CreatorTypeFilter": { "documentation": "", "keys": { "User": "@roblox/enum/CreatorTypeFilter.User", "Group": "@roblox/enum/CreatorTypeFilter.Group", "All": "@roblox/enum/CreatorTypeFilter.All" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreatorTypeFilter", "code_sample": "" }, "@roblox/enum/TopBottom.Top": { "documentation": "The object is above its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TopBottom#Top", "code_sample": "" }, "@roblox/enum/TopBottom.Center": { "documentation": "The object is centered around the center of its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TopBottom#Center", "code_sample": "" }, "@roblox/enum/TopBottom.Bottom": { "documentation": "The object is below its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TopBottom#Bottom", "code_sample": "" }, "@roblox/global/Enum.TopBottom": { "documentation": "Sets where the object is on the side of its parent.", "keys": { "Top": "@roblox/enum/TopBottom.Top", "Center": "@roblox/enum/TopBottom.Center", "Bottom": "@roblox/enum/TopBottom.Bottom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TopBottom", "code_sample": "" }, "@roblox/enum/AnalyticsCustomFieldKeys.CustomField01": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys#CustomField01", "code_sample": "" }, "@roblox/enum/AnalyticsCustomFieldKeys.CustomField02": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys#CustomField02", "code_sample": "" }, "@roblox/enum/AnalyticsCustomFieldKeys.CustomField03": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys#CustomField03", "code_sample": "" }, "@roblox/global/Enum.AnalyticsCustomFieldKeys": { "documentation": "Used to form a dictionary of custom fields to provide breakdowns in Roblox-provided charts.", "keys": { "CustomField01": "@roblox/enum/AnalyticsCustomFieldKeys.CustomField01", "CustomField02": "@roblox/enum/AnalyticsCustomFieldKeys.CustomField02", "CustomField03": "@roblox/enum/AnalyticsCustomFieldKeys.CustomField03" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsCustomFieldKeys", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.None": { "documentation": "This debug rendering mode does nothing, and this is the default value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#None", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.TargetCageOriginal": { "documentation": "This debug mode shows the original cage mesh as it was created.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#TargetCageOriginal", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.TargetCageCompressed": { "documentation": "This debug mode shows corresponding cage mesh compressed by clothing layers above it. This debug mode is intended to validate that the compression algorithm and corresponding cages work as intended.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#TargetCageCompressed", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.TargetCageInterface": { "documentation": "This debug mode shows the resulting cage mesh for the corresponding Wrap Instance. This debug mode is intended to validate that the final deformed cage looks as intended.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#TargetCageInterface", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.TargetLayerCageOriginal": { "documentation": "The same as TargetCageOriginal but affects all WrapTargets that belong to the Wrap Deformer simultaneously. It doesn't matter which particular WrapTarget you enable this debug visualization option.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#TargetLayerCageOriginal", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.TargetLayerCageCompressed": { "documentation": "The same as TargetCageCompressed but affects all WrapTargets that belong to the Wrap Deformer simultaneously. It doesn't matter which particular WrapTarget you enable this debug visualization option.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#TargetLayerCageCompressed", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.TargetLayerInterface": { "documentation": "The same as TargetCageInterface but affects all WrapTargets that belong to the Wrap Deformer simultaneously. It doesn't matter which particular WrapTarget you enable this debug visualization option.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#TargetLayerInterface", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.Rbf": { "documentation": "This debug mode visualizes the internal RBF solver state. You can estimate the wrap deformer expected behavior by looking at this state. All renderable mesh vertices move from a \"big sphere\" to a \"small sphere\" along a corresponding line connecting two spheres.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#Rbf", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.OuterCageDetail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#OuterCageDetail", "code_sample": "" }, "@roblox/enum/WrapTargetDebugMode.PreWrapDeformerCage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode#PreWrapDeformerCage", "code_sample": "" }, "@roblox/global/Enum.WrapTargetDebugMode": { "documentation": "The Studio-only property for quickly visualizing and debugging meshes with only outer cages.", "keys": { "None": "@roblox/enum/WrapTargetDebugMode.None", "TargetCageOriginal": "@roblox/enum/WrapTargetDebugMode.TargetCageOriginal", "TargetCageCompressed": "@roblox/enum/WrapTargetDebugMode.TargetCageCompressed", "TargetCageInterface": "@roblox/enum/WrapTargetDebugMode.TargetCageInterface", "TargetLayerCageOriginal": "@roblox/enum/WrapTargetDebugMode.TargetLayerCageOriginal", "TargetLayerCageCompressed": "@roblox/enum/WrapTargetDebugMode.TargetLayerCageCompressed", "TargetLayerInterface": "@roblox/enum/WrapTargetDebugMode.TargetLayerInterface", "Rbf": "@roblox/enum/WrapTargetDebugMode.Rbf", "OuterCageDetail": "@roblox/enum/WrapTargetDebugMode.OuterCageDetail", "PreWrapDeformerCage": "@roblox/enum/WrapTargetDebugMode.PreWrapDeformerCage" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapTargetDebugMode", "code_sample": "" }, "@roblox/enum/CharacterControlMode.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#Default", "code_sample": "" }, "@roblox/enum/CharacterControlMode.Legacy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#Legacy", "code_sample": "" }, "@roblox/enum/CharacterControlMode.NoCharacterController": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#NoCharacterController", "code_sample": "" }, "@roblox/enum/CharacterControlMode.LuaCharacterController": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode#LuaCharacterController", "code_sample": "" }, "@roblox/global/Enum.CharacterControlMode": { "documentation": "", "keys": { "Default": "@roblox/enum/CharacterControlMode.Default", "Legacy": "@roblox/enum/CharacterControlMode.Legacy", "NoCharacterController": "@roblox/enum/CharacterControlMode.NoCharacterController", "LuaCharacterController": "@roblox/enum/CharacterControlMode.LuaCharacterController" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CharacterControlMode", "code_sample": "" }, "@roblox/enum/DeviceFeatureType.DeviceCapture": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceFeatureType#DeviceCapture", "code_sample": "" }, "@roblox/global/Enum.DeviceFeatureType": { "documentation": "", "keys": { "DeviceCapture": "@roblox/enum/DeviceFeatureType.DeviceCapture" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceFeatureType", "code_sample": "" }, "@roblox/enum/InOut.Edge": { "documentation": "The object is located along an edge of its parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InOut#Edge", "code_sample": "" }, "@roblox/enum/InOut.Inset": { "documentation": "The object's located is inset from its parent's location.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InOut#Inset", "code_sample": "" }, "@roblox/enum/InOut.Center": { "documentation": "The object's location is centered on it's parent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InOut#Center", "code_sample": "" }, "@roblox/global/Enum.InOut": { "documentation": "The InOut Enum is used to set where the object is on the side of its parent.", "keys": { "Edge": "@roblox/enum/InOut.Edge", "Inset": "@roblox/enum/InOut.Inset", "Center": "@roblox/enum/InOut.Center" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InOut", "code_sample": "" }, "@roblox/enum/PlayerChatType.All": { "documentation": "A global message that everyone can receive.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerChatType#All", "code_sample": "" }, "@roblox/enum/PlayerChatType.Team": { "documentation": "A team message only players in the same team can receive.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerChatType#Team", "code_sample": "" }, "@roblox/enum/PlayerChatType.Whisper": { "documentation": "A whispered message only the person it's whispered to can receive.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerChatType#Whisper", "code_sample": "" }, "@roblox/global/Enum.PlayerChatType": { "documentation": "Determines the style of a chat message.", "keys": { "All": "@roblox/enum/PlayerChatType.All", "Team": "@roblox/enum/PlayerChatType.Team", "Whisper": "@roblox/enum/PlayerChatType.Whisper" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerChatType", "code_sample": "" }, "@roblox/enum/UserInputType.MouseButton1": { "documentation": "The left mouse button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#MouseButton1", "code_sample": "" }, "@roblox/enum/UserInputType.MouseButton2": { "documentation": "The right mouse button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#MouseButton2", "code_sample": "" }, "@roblox/enum/UserInputType.MouseButton3": { "documentation": "The middle mouse button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#MouseButton3", "code_sample": "" }, "@roblox/enum/UserInputType.MouseWheel": { "documentation": "The mouse wheel.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#MouseWheel", "code_sample": "" }, "@roblox/enum/UserInputType.MouseMovement": { "documentation": "Movement of the mouse. Fires changed events each time the player's cursor position changes and when the move enters/leaves the game window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#MouseMovement", "code_sample": "" }, "@roblox/enum/UserInputType.Touch": { "documentation": "A tap on the screen from a mobile device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Touch", "code_sample": "" }, "@roblox/enum/UserInputType.Keyboard": { "documentation": "Key press on a keyboard.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Keyboard", "code_sample": "" }, "@roblox/enum/UserInputType.Focus": { "documentation": "The client regaining focus of the Roblox window.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Focus", "code_sample": "" }, "@roblox/enum/UserInputType.Accelerometer": { "documentation": "The accelerometer of a mobile device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Accelerometer", "code_sample": "" }, "@roblox/enum/UserInputType.Gyro": { "documentation": "The Gyroscope of a mobile device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gyro", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad1": { "documentation": "Input from the 1st plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad1", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad2": { "documentation": "Input from the 2nd plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad2", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad3": { "documentation": "Input from the 3rd plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad3", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad4": { "documentation": "Input from the 4th plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad4", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad5": { "documentation": "Input from the 5th plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad5", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad6": { "documentation": "Input from the 6th plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad6", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad7": { "documentation": "Input from the 7th plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad7", "code_sample": "" }, "@roblox/enum/UserInputType.Gamepad8": { "documentation": "Input from the 8th plugged in Gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#Gamepad8", "code_sample": "" }, "@roblox/enum/UserInputType.TextInput": { "documentation": "Input of Text into a text-based GuiObject. Normally this is only a TextBox.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#TextInput", "code_sample": "" }, "@roblox/enum/UserInputType.InputMethod": { "documentation": "Text input from an input method editor (IME). InputObjects with this type aren't currently fired.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#InputMethod", "code_sample": "" }, "@roblox/enum/UserInputType.None": { "documentation": "Unknown UserInputType.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType#None", "code_sample": "" }, "@roblox/global/Enum.UserInputType": { "documentation": "Describes the type of a user input event.", "keys": { "MouseButton1": "@roblox/enum/UserInputType.MouseButton1", "MouseButton2": "@roblox/enum/UserInputType.MouseButton2", "MouseButton3": "@roblox/enum/UserInputType.MouseButton3", "MouseWheel": "@roblox/enum/UserInputType.MouseWheel", "MouseMovement": "@roblox/enum/UserInputType.MouseMovement", "Touch": "@roblox/enum/UserInputType.Touch", "Keyboard": "@roblox/enum/UserInputType.Keyboard", "Focus": "@roblox/enum/UserInputType.Focus", "Accelerometer": "@roblox/enum/UserInputType.Accelerometer", "Gyro": "@roblox/enum/UserInputType.Gyro", "Gamepad1": "@roblox/enum/UserInputType.Gamepad1", "Gamepad2": "@roblox/enum/UserInputType.Gamepad2", "Gamepad3": "@roblox/enum/UserInputType.Gamepad3", "Gamepad4": "@roblox/enum/UserInputType.Gamepad4", "Gamepad5": "@roblox/enum/UserInputType.Gamepad5", "Gamepad6": "@roblox/enum/UserInputType.Gamepad6", "Gamepad7": "@roblox/enum/UserInputType.Gamepad7", "Gamepad8": "@roblox/enum/UserInputType.Gamepad8", "TextInput": "@roblox/enum/UserInputType.TextInput", "InputMethod": "@roblox/enum/UserInputType.InputMethod", "None": "@roblox/enum/UserInputType.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UserInputType", "code_sample": "" }, "@roblox/enum/AppShellFeature.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#None", "code_sample": "" }, "@roblox/enum/AppShellFeature.Chat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#Chat", "code_sample": "" }, "@roblox/enum/AppShellFeature.AvatarEditor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#AvatarEditor", "code_sample": "" }, "@roblox/enum/AppShellFeature.GamePage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#GamePage", "code_sample": "" }, "@roblox/enum/AppShellFeature.HomePage": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#HomePage", "code_sample": "" }, "@roblox/enum/AppShellFeature.More": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#More", "code_sample": "" }, "@roblox/enum/AppShellFeature.Landing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature#Landing", "code_sample": "" }, "@roblox/global/Enum.AppShellFeature": { "documentation": "", "keys": { "None": "@roblox/enum/AppShellFeature.None", "Chat": "@roblox/enum/AppShellFeature.Chat", "AvatarEditor": "@roblox/enum/AppShellFeature.AvatarEditor", "GamePage": "@roblox/enum/AppShellFeature.GamePage", "HomePage": "@roblox/enum/AppShellFeature.HomePage", "More": "@roblox/enum/AppShellFeature.More", "Landing": "@roblox/enum/AppShellFeature.Landing" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellFeature", "code_sample": "" }, "@roblox/enum/ChatMode.Menu": { "documentation": "The player is restricted to chatting via a menu of chat messages.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatMode#Menu", "code_sample": "" }, "@roblox/enum/ChatMode.TextAndMenu": { "documentation": "A player can chat via custom text messages and a menu of chat messages.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatMode#TextAndMenu", "code_sample": "" }, "@roblox/global/Enum.ChatMode": { "documentation": "", "keys": { "Menu": "@roblox/enum/ChatMode.Menu", "TextAndMenu": "@roblox/enum/ChatMode.TextAndMenu" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatMode", "code_sample": "" }, "@roblox/enum/TouchMovementMode.Default": { "documentation": "The default movement controller.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode#Default", "code_sample": "" }, "@roblox/enum/TouchMovementMode.Thumbstick": { "documentation": "Change the movement controller to the classic thumbstick.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode#Thumbstick", "code_sample": "" }, "@roblox/enum/TouchMovementMode.DPad": { "documentation": "Change the movement controller to the DPad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode#DPad", "code_sample": "" }, "@roblox/enum/TouchMovementMode.Thumbpad": { "documentation": "Change the movement controller to the thumbpad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode#Thumbpad", "code_sample": "" }, "@roblox/enum/TouchMovementMode.ClickToMove": { "documentation": "Change the movement controller to click to move.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode#ClickToMove", "code_sample": "" }, "@roblox/enum/TouchMovementMode.DynamicThumbstick": { "documentation": "Change the movement controller to the dynamic thumbstick.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode#DynamicThumbstick", "code_sample": "" }, "@roblox/global/Enum.TouchMovementMode": { "documentation": "The movement mode used by a client with a TouchEnabled device.", "keys": { "Default": "@roblox/enum/TouchMovementMode.Default", "Thumbstick": "@roblox/enum/TouchMovementMode.Thumbstick", "DPad": "@roblox/enum/TouchMovementMode.DPad", "Thumbpad": "@roblox/enum/TouchMovementMode.Thumbpad", "ClickToMove": "@roblox/enum/TouchMovementMode.ClickToMove", "DynamicThumbstick": "@roblox/enum/TouchMovementMode.DynamicThumbstick" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchMovementMode", "code_sample": "" }, "@roblox/enum/LineJoinMode.Round": { "documentation": "The corners are rounded. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LineJoinMode#Round", "code_sample": "" }, "@roblox/enum/LineJoinMode.Bevel": { "documentation": "The corners are beveled. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LineJoinMode#Bevel", "code_sample": "" }, "@roblox/enum/LineJoinMode.Miter": { "documentation": "The corners are mitered. ", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LineJoinMode#Miter", "code_sample": "" }, "@roblox/global/Enum.LineJoinMode": { "documentation": "This enum is used by UIStroke.LineJoinMode to determine how corners are interpreted.", "keys": { "Round": "@roblox/enum/LineJoinMode.Round", "Bevel": "@roblox/enum/LineJoinMode.Bevel", "Miter": "@roblox/enum/LineJoinMode.Miter" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LineJoinMode", "code_sample": "" }, "@roblox/enum/CellMaterial.Empty": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Empty", "code_sample": "" }, "@roblox/enum/CellMaterial.Grass": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Grass", "code_sample": "" }, "@roblox/enum/CellMaterial.Sand": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Sand", "code_sample": "" }, "@roblox/enum/CellMaterial.Brick": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Brick", "code_sample": "" }, "@roblox/enum/CellMaterial.Granite": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Granite", "code_sample": "" }, "@roblox/enum/CellMaterial.Asphalt": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Asphalt", "code_sample": "" }, "@roblox/enum/CellMaterial.Iron": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Iron", "code_sample": "" }, "@roblox/enum/CellMaterial.Aluminum": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Aluminum", "code_sample": "" }, "@roblox/enum/CellMaterial.Gold": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Gold", "code_sample": "" }, "@roblox/enum/CellMaterial.WoodPlank": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#WoodPlank", "code_sample": "" }, "@roblox/enum/CellMaterial.WoodLog": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#WoodLog", "code_sample": "" }, "@roblox/enum/CellMaterial.Gravel": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Gravel", "code_sample": "" }, "@roblox/enum/CellMaterial.CinderBlock": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#CinderBlock", "code_sample": "" }, "@roblox/enum/CellMaterial.MossyStone": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#MossyStone", "code_sample": "" }, "@roblox/enum/CellMaterial.Cement": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Cement", "code_sample": "" }, "@roblox/enum/CellMaterial.RedPlastic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#RedPlastic", "code_sample": "" }, "@roblox/enum/CellMaterial.BluePlastic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#BluePlastic", "code_sample": "" }, "@roblox/enum/CellMaterial.Water": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial#Water", "code_sample": "" }, "@roblox/global/Enum.CellMaterial": { "documentation": "", "keys": { "Empty": "@roblox/enum/CellMaterial.Empty", "Grass": "@roblox/enum/CellMaterial.Grass", "Sand": "@roblox/enum/CellMaterial.Sand", "Brick": "@roblox/enum/CellMaterial.Brick", "Granite": "@roblox/enum/CellMaterial.Granite", "Asphalt": "@roblox/enum/CellMaterial.Asphalt", "Iron": "@roblox/enum/CellMaterial.Iron", "Aluminum": "@roblox/enum/CellMaterial.Aluminum", "Gold": "@roblox/enum/CellMaterial.Gold", "WoodPlank": "@roblox/enum/CellMaterial.WoodPlank", "WoodLog": "@roblox/enum/CellMaterial.WoodLog", "Gravel": "@roblox/enum/CellMaterial.Gravel", "CinderBlock": "@roblox/enum/CellMaterial.CinderBlock", "MossyStone": "@roblox/enum/CellMaterial.MossyStone", "Cement": "@roblox/enum/CellMaterial.Cement", "RedPlastic": "@roblox/enum/CellMaterial.RedPlastic", "BluePlastic": "@roblox/enum/CellMaterial.BluePlastic", "Water": "@roblox/enum/CellMaterial.Water" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CellMaterial", "code_sample": "" }, "@roblox/enum/SelectionBehavior.Escape": { "documentation": "Prioritizes GuiObjects within the same SelectionGroup but allows the selection to move to other outside GuiObjects if no suitable button is found.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionBehavior#Escape", "code_sample": "" }, "@roblox/enum/SelectionBehavior.Stop": { "documentation": "Constrains gamepad selection to the SelectionGroup.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionBehavior#Stop", "code_sample": "" }, "@roblox/global/Enum.SelectionBehavior": { "documentation": "Customization options for gamepad selection when GuiBase2d.SelectionGroup is true.", "keys": { "Escape": "@roblox/enum/SelectionBehavior.Escape", "Stop": "@roblox/enum/SelectionBehavior.Stop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SelectionBehavior", "code_sample": "" }, "@roblox/enum/AnnotationEditingMode.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode#None", "code_sample": "" }, "@roblox/enum/AnnotationEditingMode.PlacingNew": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode#PlacingNew", "code_sample": "" }, "@roblox/enum/AnnotationEditingMode.WritingNew": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode#WritingNew", "code_sample": "" }, "@roblox/global/Enum.AnnotationEditingMode": { "documentation": "", "keys": { "None": "@roblox/enum/AnnotationEditingMode.None", "PlacingNew": "@roblox/enum/AnnotationEditingMode.PlacingNew", "WritingNew": "@roblox/enum/AnnotationEditingMode.WritingNew" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnnotationEditingMode", "code_sample": "" }, "@roblox/enum/ComputerMovementMode.Default": { "documentation": "The default is KeyboardMouse.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode#Default", "code_sample": "" }, "@roblox/enum/ComputerMovementMode.KeyboardMouse": { "documentation": "The player's character is controlled using the keyboard and mouse.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode#KeyboardMouse", "code_sample": "" }, "@roblox/enum/ComputerMovementMode.ClickToMove": { "documentation": "The player can right-click in the game world and their character will move there. In addition, the player can also control their character with their mouse and keyboard.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode#ClickToMove", "code_sample": "" }, "@roblox/global/Enum.ComputerMovementMode": { "documentation": "The computer movement type in-use by the client.", "keys": { "Default": "@roblox/enum/ComputerMovementMode.Default", "KeyboardMouse": "@roblox/enum/ComputerMovementMode.KeyboardMouse", "ClickToMove": "@roblox/enum/ComputerMovementMode.ClickToMove" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ComputerMovementMode", "code_sample": "" }, "@roblox/enum/InputType.NoInput": { "documentation": "Behaves like a weld and does nothing.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputType#NoInput", "code_sample": "" }, "@roblox/enum/InputType.Constant": { "documentation": "Rotate at a constant velocity of BasePart ParamB.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputType#Constant", "code_sample": "" }, "@roblox/enum/InputType.Sin": { "documentation": "Rotate at a velocity of: ParamA * math.sin(workspace.DistributedGameTime * ParamB), where BasePart ParamA determines the maximum speed at which the part spins, and BasePart ParamB determines how frequently it changes direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputType#Sin", "code_sample": "" }, "@roblox/global/Enum.InputType": { "documentation": "The InputType Enum controls the SurfaceInputs of Part.", "keys": { "NoInput": "@roblox/enum/InputType.NoInput", "Constant": "@roblox/enum/InputType.Constant", "Sin": "@roblox/enum/InputType.Sin" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputType", "code_sample": "" }, "@roblox/enum/BenefitType.DeveloperProduct": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BenefitType#DeveloperProduct", "code_sample": "" }, "@roblox/enum/BenefitType.AvatarAsset": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BenefitType#AvatarAsset", "code_sample": "" }, "@roblox/enum/BenefitType.AvatarBundle": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BenefitType#AvatarBundle", "code_sample": "" }, "@roblox/global/Enum.BenefitType": { "documentation": "", "keys": { "DeveloperProduct": "@roblox/enum/BenefitType.DeveloperProduct", "AvatarAsset": "@roblox/enum/BenefitType.AvatarAsset", "AvatarBundle": "@roblox/enum/BenefitType.AvatarBundle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BenefitType", "code_sample": "" }, "@roblox/enum/LiveEditingAtomicUpdateResponse.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingAtomicUpdateResponse#Success", "code_sample": "" }, "@roblox/enum/LiveEditingAtomicUpdateResponse.FailureGuidNotFound": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingAtomicUpdateResponse#FailureGuidNotFound", "code_sample": "" }, "@roblox/enum/LiveEditingAtomicUpdateResponse.FailureHashMismatch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingAtomicUpdateResponse#FailureHashMismatch", "code_sample": "" }, "@roblox/enum/LiveEditingAtomicUpdateResponse.FailureOperationIllegal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingAtomicUpdateResponse#FailureOperationIllegal", "code_sample": "" }, "@roblox/global/Enum.LiveEditingAtomicUpdateResponse": { "documentation": "", "keys": { "Success": "@roblox/enum/LiveEditingAtomicUpdateResponse.Success", "FailureGuidNotFound": "@roblox/enum/LiveEditingAtomicUpdateResponse.FailureGuidNotFound", "FailureHashMismatch": "@roblox/enum/LiveEditingAtomicUpdateResponse.FailureHashMismatch", "FailureOperationIllegal": "@roblox/enum/LiveEditingAtomicUpdateResponse.FailureOperationIllegal" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LiveEditingAtomicUpdateResponse", "code_sample": "" }, "@roblox/enum/FinishRecordingOperation.Cancel": { "documentation": "Cancels the recording, automatically undoing any work in progress.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation#Cancel", "code_sample": "" }, "@roblox/enum/FinishRecordingOperation.Commit": { "documentation": "Commits the recorded work.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation#Commit", "code_sample": "" }, "@roblox/enum/FinishRecordingOperation.Append": { "documentation": "Commits the recorded work and merges with the previous recording if possible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation#Append", "code_sample": "" }, "@roblox/global/Enum.FinishRecordingOperation": { "documentation": "", "keys": { "Cancel": "@roblox/enum/FinishRecordingOperation.Cancel", "Commit": "@roblox/enum/FinishRecordingOperation.Commit", "Append": "@roblox/enum/FinishRecordingOperation.Append" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FinishRecordingOperation", "code_sample": "" }, "@roblox/enum/RtlTextSupport.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RtlTextSupport#Default", "code_sample": "" }, "@roblox/enum/RtlTextSupport.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RtlTextSupport#Disabled", "code_sample": "" }, "@roblox/enum/RtlTextSupport.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RtlTextSupport#Enabled", "code_sample": "" }, "@roblox/global/Enum.RtlTextSupport": { "documentation": "", "keys": { "Default": "@roblox/enum/RtlTextSupport.Default", "Disabled": "@roblox/enum/RtlTextSupport.Disabled", "Enabled": "@roblox/enum/RtlTextSupport.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RtlTextSupport", "code_sample": "" }, "@roblox/enum/FluidFidelity.Automatic": { "documentation": "Let the physics engine select the geometric representation for aerodynamic force and torque calculations.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidFidelity#Automatic", "code_sample": "" }, "@roblox/enum/FluidFidelity.UseCollisionGeometry": { "documentation": "Use the current collision geometry specified by TriangleMeshPart.CollisionFidelity for aerodynamic force and torque calculations .", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidFidelity#UseCollisionGeometry", "code_sample": "" }, "@roblox/enum/FluidFidelity.UsePreciseGeometry": { "documentation": "Force the engine to compute aerodynamic forces and torques using a more precise geometry representation based on the original mesh. This option may increase join and replication time if used on a large scale.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidFidelity#UsePreciseGeometry", "code_sample": "" }, "@roblox/global/Enum.FluidFidelity": { "documentation": "Determines the geometric representation used to compute aerodynamic forces.", "keys": { "Automatic": "@roblox/enum/FluidFidelity.Automatic", "UseCollisionGeometry": "@roblox/enum/FluidFidelity.UseCollisionGeometry", "UsePreciseGeometry": "@roblox/enum/FluidFidelity.UsePreciseGeometry" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidFidelity", "code_sample": "" }, "@roblox/enum/BodyPartR15.Head": { "documentation": "Reference to a Humanoid's Head.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#Head", "code_sample": "" }, "@roblox/enum/BodyPartR15.UpperTorso": { "documentation": "Reference to a Humanoid's UpperTorso.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#UpperTorso", "code_sample": "" }, "@roblox/enum/BodyPartR15.LowerTorso": { "documentation": "Reference to a Humanoid's LowerTorso.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LowerTorso", "code_sample": "" }, "@roblox/enum/BodyPartR15.LeftFoot": { "documentation": "Reference to a Humanoid's LeftFoot.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftFoot", "code_sample": "" }, "@roblox/enum/BodyPartR15.LeftLowerLeg": { "documentation": "Reference to a Humanoid's LeftLowerLeg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftLowerLeg", "code_sample": "" }, "@roblox/enum/BodyPartR15.LeftUpperLeg": { "documentation": "Reference to a Humanoid's LeftUpperLeg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftUpperLeg", "code_sample": "" }, "@roblox/enum/BodyPartR15.RightFoot": { "documentation": "Reference to a Humanoid's RightFoot.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightFoot", "code_sample": "" }, "@roblox/enum/BodyPartR15.RightLowerLeg": { "documentation": "Reference to a Humanoid's RightLowerLeg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightLowerLeg", "code_sample": "" }, "@roblox/enum/BodyPartR15.RightUpperLeg": { "documentation": "Reference to a Humanoid's RightUpperLeg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightUpperLeg", "code_sample": "" }, "@roblox/enum/BodyPartR15.LeftHand": { "documentation": "Reference to a Humanoid's LeftHand.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftHand", "code_sample": "" }, "@roblox/enum/BodyPartR15.LeftLowerArm": { "documentation": "Reference to a Humanoid's LeftLowerArm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftLowerArm", "code_sample": "" }, "@roblox/enum/BodyPartR15.LeftUpperArm": { "documentation": "Reference to a Humanoid's LeftUpperArm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#LeftUpperArm", "code_sample": "" }, "@roblox/enum/BodyPartR15.RightHand": { "documentation": "Reference to a Humanoid's RightHand.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightHand", "code_sample": "" }, "@roblox/enum/BodyPartR15.RightLowerArm": { "documentation": "Reference to a Humanoid's RightLowerArm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightLowerArm", "code_sample": "" }, "@roblox/enum/BodyPartR15.RightUpperArm": { "documentation": "Reference to a Humanoid's RightUpperArm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RightUpperArm", "code_sample": "" }, "@roblox/enum/BodyPartR15.RootPart": { "documentation": "Reference to a Humanoid's HumanoidRootPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#RootPart", "code_sample": "" }, "@roblox/enum/BodyPartR15.Unknown": { "documentation": "Unknown R15 Humanoid body part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15#Unknown", "code_sample": "" }, "@roblox/global/Enum.BodyPartR15": { "documentation": "BodyPartR15 is an enum with entries for each of the 15 body parts of an R15 character (plus an entry for the HumanoidRootPart).", "keys": { "Head": "@roblox/enum/BodyPartR15.Head", "UpperTorso": "@roblox/enum/BodyPartR15.UpperTorso", "LowerTorso": "@roblox/enum/BodyPartR15.LowerTorso", "LeftFoot": "@roblox/enum/BodyPartR15.LeftFoot", "LeftLowerLeg": "@roblox/enum/BodyPartR15.LeftLowerLeg", "LeftUpperLeg": "@roblox/enum/BodyPartR15.LeftUpperLeg", "RightFoot": "@roblox/enum/BodyPartR15.RightFoot", "RightLowerLeg": "@roblox/enum/BodyPartR15.RightLowerLeg", "RightUpperLeg": "@roblox/enum/BodyPartR15.RightUpperLeg", "LeftHand": "@roblox/enum/BodyPartR15.LeftHand", "LeftLowerArm": "@roblox/enum/BodyPartR15.LeftLowerArm", "LeftUpperArm": "@roblox/enum/BodyPartR15.LeftUpperArm", "RightHand": "@roblox/enum/BodyPartR15.RightHand", "RightLowerArm": "@roblox/enum/BodyPartR15.RightLowerArm", "RightUpperArm": "@roblox/enum/BodyPartR15.RightUpperArm", "RootPart": "@roblox/enum/BodyPartR15.RootPart", "Unknown": "@roblox/enum/BodyPartR15.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPartR15", "code_sample": "" }, "@roblox/enum/Button.Dismount": { "documentation": "The Dismount button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Button#Dismount", "code_sample": "" }, "@roblox/enum/Button.Jump": { "documentation": "The Jump button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Button#Jump", "code_sample": "" }, "@roblox/global/Enum.Button": { "documentation": "One of the buttons used by Controller.", "keys": { "Dismount": "@roblox/enum/Button.Dismount", "Jump": "@roblox/enum/Button.Jump" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Button", "code_sample": "" }, "@roblox/enum/ParticleEmitterShapeInOut.Outward": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeInOut#Outward", "code_sample": "" }, "@roblox/enum/ParticleEmitterShapeInOut.Inward": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeInOut#Inward", "code_sample": "" }, "@roblox/enum/ParticleEmitterShapeInOut.InAndOut": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeInOut#InAndOut", "code_sample": "" }, "@roblox/global/Enum.ParticleEmitterShapeInOut": { "documentation": "", "keys": { "Outward": "@roblox/enum/ParticleEmitterShapeInOut.Outward", "Inward": "@roblox/enum/ParticleEmitterShapeInOut.Inward", "InAndOut": "@roblox/enum/ParticleEmitterShapeInOut.InAndOut" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleEmitterShapeInOut", "code_sample": "" }, "@roblox/enum/NoiseType.SimplexGabor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NoiseType#SimplexGabor", "code_sample": "" }, "@roblox/global/Enum.NoiseType": { "documentation": "", "keys": { "SimplexGabor": "@roblox/enum/NoiseType.SimplexGabor" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NoiseType", "code_sample": "" }, "@roblox/enum/ScrollingDirection.X": { "documentation": "The canvas can only be scrolled along the X axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection#X", "code_sample": "" }, "@roblox/enum/ScrollingDirection.Y": { "documentation": "The canvas can only be scrolled along the Y axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection#Y", "code_sample": "" }, "@roblox/enum/ScrollingDirection.XY": { "documentation": "The canvas can be scrolled along both the X and Y axes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection#XY", "code_sample": "" }, "@roblox/global/Enum.ScrollingDirection": { "documentation": "This enum is used by ScrollingFrame.ScrollingDirection to specify the direction(s) in which scrolling is allowed.", "keys": { "X": "@roblox/enum/ScrollingDirection.X", "Y": "@roblox/enum/ScrollingDirection.Y", "XY": "@roblox/enum/ScrollingDirection.XY" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScrollingDirection", "code_sample": "" }, "@roblox/enum/ButtonStyle.Custom": { "documentation": "The button will respect the GuiObject.BorderColor3 and GuiObject.BackgroundColor3 properties.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#Custom", "code_sample": "" }, "@roblox/enum/ButtonStyle.RobloxButtonDefault": { "documentation": "A black background with a red border, and rounded corners.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxButtonDefault", "code_sample": "" }, "@roblox/enum/ButtonStyle.RobloxButton": { "documentation": "A black background with a grey border, and rounded corners.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxButton", "code_sample": "" }, "@roblox/enum/ButtonStyle.RobloxRoundButton": { "documentation": "A grey background with rounded corners, and a slight drop shadow.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxRoundButton", "code_sample": "" }, "@roblox/enum/ButtonStyle.RobloxRoundDefaultButton": { "documentation": "A blue background with rounded corners, and a slight drop shadow.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxRoundDefaultButton", "code_sample": "" }, "@roblox/enum/ButtonStyle.RobloxRoundDropdownButton": { "documentation": "A white background with a thin grey border, rounded corners, and a slight drop shadow.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle#RobloxRoundDropdownButton", "code_sample": "" }, "@roblox/global/Enum.ButtonStyle": { "documentation": "Used by GuiButton.Style to set a special hardcoded appearance.", "keys": { "Custom": "@roblox/enum/ButtonStyle.Custom", "RobloxButtonDefault": "@roblox/enum/ButtonStyle.RobloxButtonDefault", "RobloxButton": "@roblox/enum/ButtonStyle.RobloxButton", "RobloxRoundButton": "@roblox/enum/ButtonStyle.RobloxRoundButton", "RobloxRoundDefaultButton": "@roblox/enum/ButtonStyle.RobloxRoundDefaultButton", "RobloxRoundDropdownButton": "@roblox/enum/ButtonStyle.RobloxRoundDropdownButton" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ButtonStyle", "code_sample": "" }, "@roblox/enum/ModelStreamingBehavior.Default": { "documentation": "Engine determines best behavior. Currently equivalent to Legacy.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingBehavior#Default", "code_sample": "" }, "@roblox/enum/ModelStreamingBehavior.Legacy": { "documentation": "Models are sent when their parent is sent, typically during player join. Models are never streamed out unless an ancestor of the model is streamed out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingBehavior#Legacy", "code_sample": "" }, "@roblox/enum/ModelStreamingBehavior.Improved": { "documentation": "Models are never sent during player join. Models that are \"non-spatial\" (containing no BasePart descendants) are sent soon after join, but before the Workspace.PersistentLoaded event fires. Models that are \"spatial\" (containing BasePart descendants) are sent when any BasePart descendant needs to be streamed to a client, and may stream out when all BasePart descendants are eligible to stream out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingBehavior#Improved", "code_sample": "" }, "@roblox/global/Enum.ModelStreamingBehavior": { "documentation": "Controls how Models are sent to clients in experiences with instance streaming enabled.", "keys": { "Default": "@roblox/enum/ModelStreamingBehavior.Default", "Legacy": "@roblox/enum/ModelStreamingBehavior.Legacy", "Improved": "@roblox/enum/ModelStreamingBehavior.Improved" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingBehavior", "code_sample": "" }, "@roblox/enum/CompressionAlgorithm.Zstd": { "documentation": "Used to perform compression using Zstandard compression, also known as zstd.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompressionAlgorithm#Zstd", "code_sample": "" }, "@roblox/global/Enum.CompressionAlgorithm": { "documentation": "A compression algorithm to use in EncodingService methods.", "keys": { "Zstd": "@roblox/enum/CompressionAlgorithm.Zstd" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompressionAlgorithm", "code_sample": "" }, "@roblox/enum/RotationOrder.XYZ": { "documentation": "X, Y, Z order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder#XYZ", "code_sample": "" }, "@roblox/enum/RotationOrder.XZY": { "documentation": "X, Z, Y order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder#XZY", "code_sample": "" }, "@roblox/enum/RotationOrder.YZX": { "documentation": "Y, Z, X order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder#YZX", "code_sample": "" }, "@roblox/enum/RotationOrder.YXZ": { "documentation": "Y, X, Z order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder#YXZ", "code_sample": "" }, "@roblox/enum/RotationOrder.ZXY": { "documentation": "Z, X, Y order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder#ZXY", "code_sample": "" }, "@roblox/enum/RotationOrder.ZYX": { "documentation": "Z, Y, X order.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder#ZYX", "code_sample": "" }, "@roblox/global/Enum.RotationOrder": { "documentation": "The order of rotation axes used for Euler angles encoding of rotations.", "keys": { "XYZ": "@roblox/enum/RotationOrder.XYZ", "XZY": "@roblox/enum/RotationOrder.XZY", "YZX": "@roblox/enum/RotationOrder.YZX", "YXZ": "@roblox/enum/RotationOrder.YXZ", "ZXY": "@roblox/enum/RotationOrder.ZXY", "ZYX": "@roblox/enum/RotationOrder.ZYX" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RotationOrder", "code_sample": "" }, "@roblox/enum/InitialDockState.Top": { "documentation": "The widget will appear docked above the game screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InitialDockState#Top", "code_sample": "" }, "@roblox/enum/InitialDockState.Bottom": { "documentation": "The widget will appear docked below the game screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InitialDockState#Bottom", "code_sample": "" }, "@roblox/enum/InitialDockState.Left": { "documentation": "The widget will appear docked to the left of the game screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InitialDockState#Left", "code_sample": "" }, "@roblox/enum/InitialDockState.Right": { "documentation": "The widget will appear docked to the right of the game screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InitialDockState#Right", "code_sample": "" }, "@roblox/enum/InitialDockState.Float": { "documentation": "The widget will not be docked to any side of the game screen, and instead can be freely dragged around.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InitialDockState#Float", "code_sample": "" }, "@roblox/global/Enum.InitialDockState": { "documentation": "Describes the initial docking state of a DockWidgetPluginGui.", "keys": { "Top": "@roblox/enum/InitialDockState.Top", "Bottom": "@roblox/enum/InitialDockState.Bottom", "Left": "@roblox/enum/InitialDockState.Left", "Right": "@roblox/enum/InitialDockState.Right", "Float": "@roblox/enum/InitialDockState.Float" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InitialDockState", "code_sample": "" }, "@roblox/enum/FACSDataLod.LOD0": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FACSDataLod#LOD0", "code_sample": "" }, "@roblox/enum/FACSDataLod.LOD1": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FACSDataLod#LOD1", "code_sample": "" }, "@roblox/enum/FACSDataLod.LODCount": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FACSDataLod#LODCount", "code_sample": "" }, "@roblox/global/Enum.FACSDataLod": { "documentation": "", "keys": { "LOD0": "@roblox/enum/FACSDataLod.LOD0", "LOD1": "@roblox/enum/FACSDataLod.LOD1", "LODCount": "@roblox/enum/FACSDataLod.LODCount" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FACSDataLod", "code_sample": "" }, "@roblox/enum/ExplosionType.NoCraters": { "documentation": "Explosion does not generate craters.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExplosionType#NoCraters", "code_sample": "" }, "@roblox/enum/ExplosionType.Craters": { "documentation": "Explosion generates craters.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExplosionType#Craters", "code_sample": "" }, "@roblox/global/Enum.ExplosionType": { "documentation": "", "keys": { "NoCraters": "@roblox/enum/ExplosionType.NoCraters", "Craters": "@roblox/enum/ExplosionType.Craters" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExplosionType", "code_sample": "" }, "@roblox/enum/PreferredTextSize.Medium": { "documentation": "The player prefers default text size.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Medium", "code_sample": "" }, "@roblox/enum/PreferredTextSize.Large": { "documentation": "The player prefers text size slightly increased beyond default.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Large", "code_sample": "" }, "@roblox/enum/PreferredTextSize.Larger": { "documentation": "The player prefers text size moderately increased beyond default.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Larger", "code_sample": "" }, "@roblox/enum/PreferredTextSize.Largest": { "documentation": "The player prefers text size considerably increased beyond default.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize#Largest", "code_sample": "" }, "@roblox/global/Enum.PreferredTextSize": { "documentation": "This enum is used with GuiService.PreferredTextSize to indicate the player's preferred text size.", "keys": { "Medium": "@roblox/enum/PreferredTextSize.Medium", "Large": "@roblox/enum/PreferredTextSize.Large", "Larger": "@roblox/enum/PreferredTextSize.Larger", "Largest": "@roblox/enum/PreferredTextSize.Largest" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredTextSize", "code_sample": "" }, "@roblox/enum/CatalogSortType.Relevance": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#Relevance", "code_sample": "" }, "@roblox/enum/CatalogSortType.PriceHighToLow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#PriceHighToLow", "code_sample": "" }, "@roblox/enum/CatalogSortType.PriceLowToHigh": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#PriceLowToHigh", "code_sample": "" }, "@roblox/enum/CatalogSortType.MostFavorited": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#MostFavorited", "code_sample": "" }, "@roblox/enum/CatalogSortType.RecentlyCreated": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#RecentlyCreated", "code_sample": "" }, "@roblox/enum/CatalogSortType.Bestselling": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType#Bestselling", "code_sample": "" }, "@roblox/global/Enum.CatalogSortType": { "documentation": "", "keys": { "Relevance": "@roblox/enum/CatalogSortType.Relevance", "PriceHighToLow": "@roblox/enum/CatalogSortType.PriceHighToLow", "PriceLowToHigh": "@roblox/enum/CatalogSortType.PriceLowToHigh", "MostFavorited": "@roblox/enum/CatalogSortType.MostFavorited", "RecentlyCreated": "@roblox/enum/CatalogSortType.RecentlyCreated", "Bestselling": "@roblox/enum/CatalogSortType.Bestselling" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortType", "code_sample": "" }, "@roblox/enum/PlayerExitReason.Unknown": { "documentation": "Catch-all for all other disconnect reasons.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerExitReason#Unknown", "code_sample": "" }, "@roblox/enum/PlayerExitReason.PlatformKick": { "documentation": "User was kicked by Roblox systems, such as being blocked while in a Private Server.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerExitReason#PlatformKick", "code_sample": "" }, "@roblox/enum/PlayerExitReason.CreatorKick": { "documentation": "Creator called Player:Kick()", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerExitReason#CreatorKick", "code_sample": "" }, "@roblox/global/Enum.PlayerExitReason": { "documentation": "An enum that specifies the reason for Players.PlayerRemoving signal.", "keys": { "Unknown": "@roblox/enum/PlayerExitReason.Unknown", "PlatformKick": "@roblox/enum/PlayerExitReason.PlatformKick", "CreatorKick": "@roblox/enum/PlayerExitReason.CreatorKick" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerExitReason", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.Unknown": { "documentation": "Generic failed status for any other TextChannel:SendAsync() failures.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#Unknown", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.Success": { "documentation": "Message has no issues.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#Success", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.Sending": { "documentation": "Message is sending.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#Sending", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.TextFilterFailed": { "documentation": "Text filter failed to process the message.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#TextFilterFailed", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.Floodchecked": { "documentation": "Message is from a user sending messages too frequently.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#Floodchecked", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.InvalidPrivacySettings": { "documentation": "Message can't be sent because of the user's chat privacy settings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#InvalidPrivacySettings", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.InvalidTextChannelPermissions": { "documentation": "Message's TextSource is either not in the intended TextChannel or TextSource.CanSend is false.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#InvalidTextChannelPermissions", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.MessageTooLong": { "documentation": "Message is too long.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#MessageTooLong", "code_sample": "" }, "@roblox/enum/TextChatMessageStatus.ModerationTimeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus#ModerationTimeout", "code_sample": "" }, "@roblox/global/Enum.TextChatMessageStatus": { "documentation": "Indicates the status of a TextChatMessage.", "keys": { "Unknown": "@roblox/enum/TextChatMessageStatus.Unknown", "Success": "@roblox/enum/TextChatMessageStatus.Success", "Sending": "@roblox/enum/TextChatMessageStatus.Sending", "TextFilterFailed": "@roblox/enum/TextChatMessageStatus.TextFilterFailed", "Floodchecked": "@roblox/enum/TextChatMessageStatus.Floodchecked", "InvalidPrivacySettings": "@roblox/enum/TextChatMessageStatus.InvalidPrivacySettings", "InvalidTextChannelPermissions": "@roblox/enum/TextChatMessageStatus.InvalidTextChannelPermissions", "MessageTooLong": "@roblox/enum/TextChatMessageStatus.MessageTooLong", "ModerationTimeout": "@roblox/enum/TextChatMessageStatus.ModerationTimeout" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextChatMessageStatus", "code_sample": "" }, "@roblox/enum/SortDirection.Ascending": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortDirection#Ascending", "code_sample": "" }, "@roblox/enum/SortDirection.Descending": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortDirection#Descending", "code_sample": "" }, "@roblox/global/Enum.SortDirection": { "documentation": "", "keys": { "Ascending": "@roblox/enum/SortDirection.Ascending", "Descending": "@roblox/enum/SortDirection.Descending" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SortDirection", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.IsAvailable": { "documentation": "An ad is available to show the user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#IsAvailable", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.DeviceIneligible": { "documentation": "The device is ineligible to receive ads.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#DeviceIneligible", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.ExperienceIneligible": { "documentation": "The experience is ineligible to receive ads. Check if its eligibility has been revoked.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#ExperienceIneligible", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.InternalError": { "documentation": "An unspecified internal error occurred. Try fetching the ad again.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#InternalError", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.NoFill": { "documentation": "There are no ads available to fill your ad request. You might have hit the ad frequency limit.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#NoFill", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.PlayerIneligible": { "documentation": "The user is ineligible to receive ads during this session. The user might be under 13 or located in a blocked region.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#PlayerIneligible", "code_sample": "" }, "@roblox/enum/AdAvailabilityResult.PublisherIneligible": { "documentation": "The publisher is ineligible to receive ads because they have not met the publisher eligibility requirements.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult#PublisherIneligible", "code_sample": "" }, "@roblox/global/Enum.AdAvailabilityResult": { "documentation": "", "keys": { "IsAvailable": "@roblox/enum/AdAvailabilityResult.IsAvailable", "DeviceIneligible": "@roblox/enum/AdAvailabilityResult.DeviceIneligible", "ExperienceIneligible": "@roblox/enum/AdAvailabilityResult.ExperienceIneligible", "InternalError": "@roblox/enum/AdAvailabilityResult.InternalError", "NoFill": "@roblox/enum/AdAvailabilityResult.NoFill", "PlayerIneligible": "@roblox/enum/AdAvailabilityResult.PlayerIneligible", "PublisherIneligible": "@roblox/enum/AdAvailabilityResult.PublisherIneligible" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdAvailabilityResult", "code_sample": "" }, "@roblox/enum/ThumbnailType.HeadShot": { "documentation": "The returned thumbnail shows just the headshot (head and up) of the user's avatar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailType#HeadShot", "code_sample": "" }, "@roblox/enum/ThumbnailType.AvatarBust": { "documentation": "The returned thumbnail shows the bust (chest up) of the user's avatar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailType#AvatarBust", "code_sample": "" }, "@roblox/enum/ThumbnailType.AvatarThumbnail": { "documentation": "The returned thumbnail shows the entire body of the user's avatar.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailType#AvatarThumbnail", "code_sample": "" }, "@roblox/global/Enum.ThumbnailType": { "documentation": "", "keys": { "HeadShot": "@roblox/enum/ThumbnailType.HeadShot", "AvatarBust": "@roblox/enum/ThumbnailType.AvatarBust", "AvatarThumbnail": "@roblox/enum/ThumbnailType.AvatarThumbnail" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThumbnailType", "code_sample": "" }, "@roblox/enum/VirtualCursorMode.Default": { "documentation": "The Virtual Cursor is in the default state.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualCursorMode#Default", "code_sample": "" }, "@roblox/enum/VirtualCursorMode.Disabled": { "documentation": "The Virtual Cursor is disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualCursorMode#Disabled", "code_sample": "" }, "@roblox/enum/VirtualCursorMode.Enabled": { "documentation": "The Virtual Cursor is enabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualCursorMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.VirtualCursorMode": { "documentation": "Enables Virtual Cursor mode within an experience.", "keys": { "Default": "@roblox/enum/VirtualCursorMode.Default", "Disabled": "@roblox/enum/VirtualCursorMode.Disabled", "Enabled": "@roblox/enum/VirtualCursorMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualCursorMode", "code_sample": "" }, "@roblox/enum/HandRigDescriptionSide.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandRigDescriptionSide#None", "code_sample": "" }, "@roblox/enum/HandRigDescriptionSide.Left": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandRigDescriptionSide#Left", "code_sample": "" }, "@roblox/enum/HandRigDescriptionSide.Right": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandRigDescriptionSide#Right", "code_sample": "" }, "@roblox/global/Enum.HandRigDescriptionSide": { "documentation": "", "keys": { "None": "@roblox/enum/HandRigDescriptionSide.None", "Left": "@roblox/enum/HandRigDescriptionSide.Left", "Right": "@roblox/enum/HandRigDescriptionSide.Right" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HandRigDescriptionSide", "code_sample": "" }, "@roblox/enum/DeviceLevel.Low": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceLevel#Low", "code_sample": "" }, "@roblox/enum/DeviceLevel.Medium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceLevel#Medium", "code_sample": "" }, "@roblox/enum/DeviceLevel.High": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceLevel#High", "code_sample": "" }, "@roblox/global/Enum.DeviceLevel": { "documentation": "", "keys": { "Low": "@roblox/enum/DeviceLevel.Low", "Medium": "@roblox/enum/DeviceLevel.Medium", "High": "@roblox/enum/DeviceLevel.High" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceLevel", "code_sample": "" }, "@roblox/enum/ParticleFlipbookMode.Loop": { "documentation": "Continuously play through all frames, starting back at the first frame after playing the last.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookMode#Loop", "code_sample": "" }, "@roblox/enum/ParticleFlipbookMode.OneShot": { "documentation": "Play through the animation only once across the particle's lifetime. With this setting, the ParticleEmitter.FlipbookFramerate property doesn't apply; instead, the framerate is determined by the particle's ParticleEmitter.Lifetime divided evenly by the number of frames in the animation. OneShot animations are useful for clear non-repeating animations, such as an explosion that creates a puff of smoke and then fades out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookMode#OneShot", "code_sample": "" }, "@roblox/enum/ParticleFlipbookMode.PingPong": { "documentation": "Play from the first to the last frame, then in reverse from the last to the first, repeating throughout the ParticleEmitter.Lifetime of the particle.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookMode#PingPong", "code_sample": "" }, "@roblox/enum/ParticleFlipbookMode.Random": { "documentation": "Play the frames in a random order, blending/crossfading from one frame to the next. This can be useful for organic particle textures at low framerates, such as stars slowly twinkling between subtly different shapes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookMode#Random", "code_sample": "" }, "@roblox/global/Enum.ParticleFlipbookMode": { "documentation": "Determines the type of the flipbook animation.", "keys": { "Loop": "@roblox/enum/ParticleFlipbookMode.Loop", "OneShot": "@roblox/enum/ParticleFlipbookMode.OneShot", "PingPong": "@roblox/enum/ParticleFlipbookMode.PingPong", "Random": "@roblox/enum/ParticleFlipbookMode.Random" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ParticleFlipbookMode", "code_sample": "" }, "@roblox/enum/MoveState.Stopped": { "documentation": "Skateboard is stopped (not moving).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoveState#Stopped", "code_sample": "" }, "@roblox/enum/MoveState.Coasting": { "documentation": "Skateboard is coasting (not actively speeding up / being pushed).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoveState#Coasting", "code_sample": "" }, "@roblox/enum/MoveState.Pushing": { "documentation": "Skateboard is being pushed (speeding up).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoveState#Pushing", "code_sample": "" }, "@roblox/enum/MoveState.Stopping": { "documentation": "Skateboard is stopping, but still moving.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoveState#Stopping", "code_sample": "" }, "@roblox/enum/MoveState.AirFree": { "documentation": "Skateboard is in the air.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoveState#AirFree", "code_sample": "" }, "@roblox/global/Enum.MoveState": { "documentation": "Represents the state of a SkateboardPlatform.", "keys": { "Stopped": "@roblox/enum/MoveState.Stopped", "Coasting": "@roblox/enum/MoveState.Coasting", "Pushing": "@roblox/enum/MoveState.Pushing", "Stopping": "@roblox/enum/MoveState.Stopping", "AirFree": "@roblox/enum/MoveState.AirFree" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoveState", "code_sample": "" }, "@roblox/enum/Severity.Error": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Severity#Error", "code_sample": "" }, "@roblox/enum/Severity.Warning": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Severity#Warning", "code_sample": "" }, "@roblox/enum/Severity.Information": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Severity#Information", "code_sample": "" }, "@roblox/enum/Severity.Hint": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Severity#Hint", "code_sample": "" }, "@roblox/global/Enum.Severity": { "documentation": "", "keys": { "Error": "@roblox/enum/Severity.Error", "Warning": "@roblox/enum/Severity.Warning", "Information": "@roblox/enum/Severity.Information", "Hint": "@roblox/enum/Severity.Hint" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Severity", "code_sample": "" }, "@roblox/enum/FriendRequestEvent.Issue": { "documentation": "A player invokes (sends) a connection request.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Issue", "code_sample": "" }, "@roblox/enum/FriendRequestEvent.Revoke": { "documentation": "A player revokes (cancels) a previously invoked (sent) connection request.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Revoke", "code_sample": "" }, "@roblox/enum/FriendRequestEvent.Accept": { "documentation": "A player accepts a connection request.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Accept", "code_sample": "" }, "@roblox/enum/FriendRequestEvent.Deny": { "documentation": "A player denies a connection request.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent#Deny", "code_sample": "" }, "@roblox/global/Enum.FriendRequestEvent": { "documentation": "", "keys": { "Issue": "@roblox/enum/FriendRequestEvent.Issue", "Revoke": "@roblox/enum/FriendRequestEvent.Revoke", "Accept": "@roblox/enum/FriendRequestEvent.Accept", "Deny": "@roblox/enum/FriendRequestEvent.Deny" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendRequestEvent", "code_sample": "" }, "@roblox/enum/SwipeDirection.Right": { "documentation": "The user swiped right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SwipeDirection#Right", "code_sample": "" }, "@roblox/enum/SwipeDirection.Left": { "documentation": "The user swiped left.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SwipeDirection#Left", "code_sample": "" }, "@roblox/enum/SwipeDirection.Up": { "documentation": "The user swiped up.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SwipeDirection#Up", "code_sample": "" }, "@roblox/enum/SwipeDirection.Down": { "documentation": "The user swiped down.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SwipeDirection#Down", "code_sample": "" }, "@roblox/enum/SwipeDirection.None": { "documentation": "The user did not swipe in a certain direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SwipeDirection#None", "code_sample": "" }, "@roblox/global/Enum.SwipeDirection": { "documentation": "The direction that a user is swiping on their touch screen.", "keys": { "Right": "@roblox/enum/SwipeDirection.Right", "Left": "@roblox/enum/SwipeDirection.Left", "Up": "@roblox/enum/SwipeDirection.Up", "Down": "@roblox/enum/SwipeDirection.Down", "None": "@roblox/enum/SwipeDirection.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SwipeDirection", "code_sample": "" }, "@roblox/enum/RollOffMode.Inverse": { "documentation": "Volume attenuates from Sound.RollOffMinDistance in an inverse manner, mirroring how sounds attenuate in the real world. This is done through Sound.RollOffMinDistance/distance, where distance is the Vector3.Magnitude between the audio source and the audio listener.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RollOffMode#Inverse", "code_sample": "" }, "@roblox/enum/RollOffMode.Linear": { "documentation": "Volume attenuates between Sound.RollOffMinDistance and Sound.RollOffMaxDistance with a linear relationship. This is done through (Sound.RollOffMaxDistance/distance)/(Sound.RollOffMaxDistance-Sound.RollOffMinDistance), where distance is the Vector3.Magnitude between the audio source and the audio listener.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RollOffMode#Linear", "code_sample": "" }, "@roblox/enum/RollOffMode.LinearSquare": { "documentation": "Volume attenuates between Sound.RollOffMinDistance and Sound.RollOffMaxDistance with a linear squared relationship. This is done through squaring Linear.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RollOffMode#LinearSquare", "code_sample": "" }, "@roblox/enum/RollOffMode.InverseTapered": { "documentation": "A hybrid model which follows the Inverse model when close to Sound.RollOffMinDistance and the LinearSquare model when close to Sound.RollOffMaxDistance. This is done by taking the lesser of Inverse and LinearSquare.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RollOffMode#InverseTapered", "code_sample": "" }, "@roblox/global/Enum.RollOffMode": { "documentation": "How Sounds parented to a BasePart or Attachment attenuate (fade out) as the distance between the listener and the parent increases.", "keys": { "Inverse": "@roblox/enum/RollOffMode.Inverse", "Linear": "@roblox/enum/RollOffMode.Linear", "LinearSquare": "@roblox/enum/RollOffMode.LinearSquare", "InverseTapered": "@roblox/enum/RollOffMode.InverseTapered" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RollOffMode", "code_sample": "" }, "@roblox/enum/TonemapperPreset.Default": { "documentation": "Sets the tone mapper to use the post‑2019 Roblox appearance which provides vivid colors and high contrasts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TonemapperPreset#Default", "code_sample": "" }, "@roblox/enum/TonemapperPreset.Retro": { "documentation": "Sets the tone mapper to imitate the pre‑2019 Roblox appearance. Colors look less saturated and there is less contrast between them.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TonemapperPreset#Retro", "code_sample": "" }, "@roblox/global/Enum.TonemapperPreset": { "documentation": "", "keys": { "Default": "@roblox/enum/TonemapperPreset.Default", "Retro": "@roblox/enum/TonemapperPreset.Retro" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TonemapperPreset", "code_sample": "" }, "@roblox/enum/DialogTone.Neutral": { "documentation": "Causes the dialog to have a blue bar on its left-hand side.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogTone#Neutral", "code_sample": "" }, "@roblox/enum/DialogTone.Friendly": { "documentation": "Causes the dialog to have a green bar on its left-hand side.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogTone#Friendly", "code_sample": "" }, "@roblox/enum/DialogTone.Enemy": { "documentation": "Causes the dialog to have a red bar on its left-hand side.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogTone#Enemy", "code_sample": "" }, "@roblox/global/Enum.DialogTone": { "documentation": "Sets the Dialog.Tone of a Dialog object, which influences how the dialog appears.", "keys": { "Neutral": "@roblox/enum/DialogTone.Neutral", "Friendly": "@roblox/enum/DialogTone.Friendly", "Enemy": "@roblox/enum/DialogTone.Enemy" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogTone", "code_sample": "" }, "@roblox/enum/MouseBehavior.Default": { "documentation": "The mouse moves freely around the user's screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#Default", "code_sample": "" }, "@roblox/enum/MouseBehavior.LockCenter": { "documentation": "The mouse is locked and cannot move from the center of the user's screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#LockCenter", "code_sample": "" }, "@roblox/enum/MouseBehavior.LockCurrentPosition": { "documentation": "The mouse is locked and cannot move from its current position on the user's screen at the time of locking.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MouseBehavior#LockCurrentPosition", "code_sample": "" }, "@roblox/global/Enum.MouseBehavior": { "documentation": "Sets the user's mouse behavior.", "keys": { "Default": "@roblox/enum/MouseBehavior.Default", "LockCenter": "@roblox/enum/MouseBehavior.LockCenter", "LockCurrentPosition": "@roblox/enum/MouseBehavior.LockCurrentPosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MouseBehavior", "code_sample": "" }, "@roblox/enum/DebuggerExceptionBreakMode.Never": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode#Never", "code_sample": "" }, "@roblox/enum/DebuggerExceptionBreakMode.Always": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode#Always", "code_sample": "" }, "@roblox/enum/DebuggerExceptionBreakMode.Unhandled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode#Unhandled", "code_sample": "" }, "@roblox/global/Enum.DebuggerExceptionBreakMode": { "documentation": "", "keys": { "Never": "@roblox/enum/DebuggerExceptionBreakMode.Never", "Always": "@roblox/enum/DebuggerExceptionBreakMode.Always", "Unhandled": "@roblox/enum/DebuggerExceptionBreakMode.Unhandled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerExceptionBreakMode", "code_sample": "" }, "@roblox/enum/ScreenInsets.None": { "documentation": "No insets are added to the fullscreen area. This mode may result in UI that is obscured or completely hidden by device notches and cutouts, so you should only use it for a ScreenGui that contains non‑interactive content like background images.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenInsets#None", "code_sample": "" }, "@roblox/enum/ScreenInsets.DeviceSafeInsets": { "documentation": "Device safe area insets are added to the fullscreen area. The resulting area is guaranteed to not be occluded by any device screen cutouts such as the camera notch, although no inset is added for Roblox core UI elements like the top bar buttons. As a result, it's recommended that you use CoreUISafeInsets for a ScreenGui whose contents should remain unobscured by both device cutouts and core screen elements.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenInsets#DeviceSafeInsets", "code_sample": "" }, "@roblox/enum/ScreenInsets.CoreUISafeInsets": { "documentation": "Core UI insets are added to the DeviceSafeInsets area, resulting in an area guaranteed to be unobscured by both device screen cutouts and Roblox core UI elements like the top bar buttons. This mode is recommended for any ScreenGui that contains interactive and/or important UI elements such as buttons and status messages.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenInsets#CoreUISafeInsets", "code_sample": "" }, "@roblox/enum/ScreenInsets.TopbarSafeInsets": { "documentation": "Top bar safe area insets are added to the DeviceSafeInsets area, resulting in an area guaranteed to be unobscured by both device screen cutouts and Roblox core UI elements like the experience controls. Unlike CoreUISafeInsets, this area's position and size is dynamic and is limited to the space available within the top bar area itself, outside of CoreUISafeInsets. See the GuiService.TopbarInset property which represents the absolute size and position of the unobstructed area within the top bar space.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenInsets#TopbarSafeInsets", "code_sample": "" }, "@roblox/global/Enum.ScreenInsets": { "documentation": "Insets associated with various screen safe areas.", "keys": { "None": "@roblox/enum/ScreenInsets.None", "DeviceSafeInsets": "@roblox/enum/ScreenInsets.DeviceSafeInsets", "CoreUISafeInsets": "@roblox/enum/ScreenInsets.CoreUISafeInsets", "TopbarSafeInsets": "@roblox/enum/ScreenInsets.TopbarSafeInsets" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScreenInsets", "code_sample": "" }, "@roblox/enum/CatalogSortAggregation.Past12Hours": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#Past12Hours", "code_sample": "" }, "@roblox/enum/CatalogSortAggregation.PastDay": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#PastDay", "code_sample": "" }, "@roblox/enum/CatalogSortAggregation.Past3Days": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#Past3Days", "code_sample": "" }, "@roblox/enum/CatalogSortAggregation.PastWeek": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#PastWeek", "code_sample": "" }, "@roblox/enum/CatalogSortAggregation.PastMonth": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#PastMonth", "code_sample": "" }, "@roblox/enum/CatalogSortAggregation.AllTime": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation#AllTime", "code_sample": "" }, "@roblox/global/Enum.CatalogSortAggregation": { "documentation": "", "keys": { "Past12Hours": "@roblox/enum/CatalogSortAggregation.Past12Hours", "PastDay": "@roblox/enum/CatalogSortAggregation.PastDay", "Past3Days": "@roblox/enum/CatalogSortAggregation.Past3Days", "PastWeek": "@roblox/enum/CatalogSortAggregation.PastWeek", "PastMonth": "@roblox/enum/CatalogSortAggregation.PastMonth", "AllTime": "@roblox/enum/CatalogSortAggregation.AllTime" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogSortAggregation", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Default", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Operator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Operator", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Number": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Number", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.String": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#String", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Comment": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Comment", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Keyword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Keyword", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Builtin": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Builtin", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Method": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Method", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Property": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Property", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Nil": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Nil", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Bool": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Bool", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Function": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Function", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Local": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Local", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Self": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Self", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.LuauKeyword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#LuauKeyword", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.FunctionName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#FunctionName", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.TODO": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#TODO", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Background": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Background", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.SelectionText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#SelectionText", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.SelectionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#SelectionBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.FindSelectionBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#FindSelectionBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MatchingWordBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MatchingWordBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Warning": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Warning", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Error": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Error", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Info": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Info", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Hint": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Hint", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Whitespace": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Whitespace", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.ActiveLine": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#ActiveLine", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.DebuggerCurrentLine": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#DebuggerCurrentLine", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.DebuggerErrorLine": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#DebuggerErrorLine", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Ruler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Ruler", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Bracket": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Bracket", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.Type": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#Type", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuPrimaryText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuPrimaryText", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuSecondaryText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuSecondaryText", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuSelectedText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuSelectedText", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuSelectedBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuSelectedBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuScrollbarBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuScrollbarBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuScrollbarHandle": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuScrollbarHandle", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.MenuBorder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#MenuBorder", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.DocViewCodeBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#DocViewCodeBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayText": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#AICOOverlayText", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayButtonBackground": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#AICOOverlayButtonBackground", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundHover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#AICOOverlayButtonBackgroundHover", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundPressed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#AICOOverlayButtonBackgroundPressed", "code_sample": "" }, "@roblox/enum/StudioScriptEditorColorCategories.IndentationRuler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories#IndentationRuler", "code_sample": "" }, "@roblox/global/Enum.StudioScriptEditorColorCategories": { "documentation": "", "keys": { "Default": "@roblox/enum/StudioScriptEditorColorCategories.Default", "Operator": "@roblox/enum/StudioScriptEditorColorCategories.Operator", "Number": "@roblox/enum/StudioScriptEditorColorCategories.Number", "String": "@roblox/enum/StudioScriptEditorColorCategories.String", "Comment": "@roblox/enum/StudioScriptEditorColorCategories.Comment", "Keyword": "@roblox/enum/StudioScriptEditorColorCategories.Keyword", "Builtin": "@roblox/enum/StudioScriptEditorColorCategories.Builtin", "Method": "@roblox/enum/StudioScriptEditorColorCategories.Method", "Property": "@roblox/enum/StudioScriptEditorColorCategories.Property", "Nil": "@roblox/enum/StudioScriptEditorColorCategories.Nil", "Bool": "@roblox/enum/StudioScriptEditorColorCategories.Bool", "Function": "@roblox/enum/StudioScriptEditorColorCategories.Function", "Local": "@roblox/enum/StudioScriptEditorColorCategories.Local", "Self": "@roblox/enum/StudioScriptEditorColorCategories.Self", "LuauKeyword": "@roblox/enum/StudioScriptEditorColorCategories.LuauKeyword", "FunctionName": "@roblox/enum/StudioScriptEditorColorCategories.FunctionName", "TODO": "@roblox/enum/StudioScriptEditorColorCategories.TODO", "Background": "@roblox/enum/StudioScriptEditorColorCategories.Background", "SelectionText": "@roblox/enum/StudioScriptEditorColorCategories.SelectionText", "SelectionBackground": "@roblox/enum/StudioScriptEditorColorCategories.SelectionBackground", "FindSelectionBackground": "@roblox/enum/StudioScriptEditorColorCategories.FindSelectionBackground", "MatchingWordBackground": "@roblox/enum/StudioScriptEditorColorCategories.MatchingWordBackground", "Warning": "@roblox/enum/StudioScriptEditorColorCategories.Warning", "Error": "@roblox/enum/StudioScriptEditorColorCategories.Error", "Info": "@roblox/enum/StudioScriptEditorColorCategories.Info", "Hint": "@roblox/enum/StudioScriptEditorColorCategories.Hint", "Whitespace": "@roblox/enum/StudioScriptEditorColorCategories.Whitespace", "ActiveLine": "@roblox/enum/StudioScriptEditorColorCategories.ActiveLine", "DebuggerCurrentLine": "@roblox/enum/StudioScriptEditorColorCategories.DebuggerCurrentLine", "DebuggerErrorLine": "@roblox/enum/StudioScriptEditorColorCategories.DebuggerErrorLine", "Ruler": "@roblox/enum/StudioScriptEditorColorCategories.Ruler", "Bracket": "@roblox/enum/StudioScriptEditorColorCategories.Bracket", "Type": "@roblox/enum/StudioScriptEditorColorCategories.Type", "MenuPrimaryText": "@roblox/enum/StudioScriptEditorColorCategories.MenuPrimaryText", "MenuSecondaryText": "@roblox/enum/StudioScriptEditorColorCategories.MenuSecondaryText", "MenuSelectedText": "@roblox/enum/StudioScriptEditorColorCategories.MenuSelectedText", "MenuBackground": "@roblox/enum/StudioScriptEditorColorCategories.MenuBackground", "MenuSelectedBackground": "@roblox/enum/StudioScriptEditorColorCategories.MenuSelectedBackground", "MenuScrollbarBackground": "@roblox/enum/StudioScriptEditorColorCategories.MenuScrollbarBackground", "MenuScrollbarHandle": "@roblox/enum/StudioScriptEditorColorCategories.MenuScrollbarHandle", "MenuBorder": "@roblox/enum/StudioScriptEditorColorCategories.MenuBorder", "DocViewCodeBackground": "@roblox/enum/StudioScriptEditorColorCategories.DocViewCodeBackground", "AICOOverlayText": "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayText", "AICOOverlayButtonBackground": "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayButtonBackground", "AICOOverlayButtonBackgroundHover": "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundHover", "AICOOverlayButtonBackgroundPressed": "@roblox/enum/StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundPressed", "IndentationRuler": "@roblox/enum/StudioScriptEditorColorCategories.IndentationRuler" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioScriptEditorColorCategories", "code_sample": "" }, "@roblox/enum/TextDirection.Auto": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextDirection#Auto", "code_sample": "" }, "@roblox/enum/TextDirection.LeftToRight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextDirection#LeftToRight", "code_sample": "" }, "@roblox/enum/TextDirection.RightToLeft": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextDirection#RightToLeft", "code_sample": "" }, "@roblox/global/Enum.TextDirection": { "documentation": "", "keys": { "Auto": "@roblox/enum/TextDirection.Auto", "LeftToRight": "@roblox/enum/TextDirection.LeftToRight", "RightToLeft": "@roblox/enum/TextDirection.RightToLeft" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TextDirection", "code_sample": "" }, "@roblox/enum/SensorMode.Floor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SensorMode#Floor", "code_sample": "" }, "@roblox/enum/SensorMode.Ladder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SensorMode#Ladder", "code_sample": "" }, "@roblox/global/Enum.SensorMode": { "documentation": "", "keys": { "Floor": "@roblox/enum/SensorMode.Floor", "Ladder": "@roblox/enum/SensorMode.Ladder" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SensorMode", "code_sample": "" }, "@roblox/enum/PromptPublishAssetResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult#Success", "code_sample": "" }, "@roblox/enum/PromptPublishAssetResult.PermissionDenied": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult#PermissionDenied", "code_sample": "" }, "@roblox/enum/PromptPublishAssetResult.Timeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult#Timeout", "code_sample": "" }, "@roblox/enum/PromptPublishAssetResult.UploadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult#UploadFailed", "code_sample": "" }, "@roblox/enum/PromptPublishAssetResult.NoUserInput": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult#NoUserInput", "code_sample": "" }, "@roblox/enum/PromptPublishAssetResult.UnknownFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult#UnknownFailure", "code_sample": "" }, "@roblox/global/Enum.PromptPublishAssetResult": { "documentation": "", "keys": { "Success": "@roblox/enum/PromptPublishAssetResult.Success", "PermissionDenied": "@roblox/enum/PromptPublishAssetResult.PermissionDenied", "Timeout": "@roblox/enum/PromptPublishAssetResult.Timeout", "UploadFailed": "@roblox/enum/PromptPublishAssetResult.UploadFailed", "NoUserInput": "@roblox/enum/PromptPublishAssetResult.NoUserInput", "UnknownFailure": "@roblox/enum/PromptPublishAssetResult.UnknownFailure" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptPublishAssetResult", "code_sample": "" }, "@roblox/enum/ModerationStatus.ReviewedApproved": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModerationStatus#ReviewedApproved", "code_sample": "" }, "@roblox/enum/ModerationStatus.ReviewedRejected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModerationStatus#ReviewedRejected", "code_sample": "" }, "@roblox/enum/ModerationStatus.NotReviewed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModerationStatus#NotReviewed", "code_sample": "" }, "@roblox/enum/ModerationStatus.NotApplicable": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModerationStatus#NotApplicable", "code_sample": "" }, "@roblox/enum/ModerationStatus.Invalid": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModerationStatus#Invalid", "code_sample": "" }, "@roblox/global/Enum.ModerationStatus": { "documentation": "", "keys": { "ReviewedApproved": "@roblox/enum/ModerationStatus.ReviewedApproved", "ReviewedRejected": "@roblox/enum/ModerationStatus.ReviewedRejected", "NotReviewed": "@roblox/enum/ModerationStatus.NotReviewed", "NotApplicable": "@roblox/enum/ModerationStatus.NotApplicable", "Invalid": "@roblox/enum/ModerationStatus.Invalid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModerationStatus", "code_sample": "" }, "@roblox/enum/MeshPartDetailLevel.DistanceBased": { "documentation": "Select level of detail based on distance (default behavior as in game).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel#DistanceBased", "code_sample": "" }, "@roblox/enum/MeshPartDetailLevel.Level00": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel#Level00", "code_sample": "" }, "@roblox/enum/MeshPartDetailLevel.Level01": { "documentation": "Highest level of detail.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel#Level01", "code_sample": "" }, "@roblox/enum/MeshPartDetailLevel.Level02": { "documentation": "Second highest level of detail.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel#Level02", "code_sample": "" }, "@roblox/enum/MeshPartDetailLevel.Level03": { "documentation": "Third highest level of detail.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel#Level03", "code_sample": "" }, "@roblox/enum/MeshPartDetailLevel.Level04": { "documentation": "Lowest level of detail.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel#Level04", "code_sample": "" }, "@roblox/global/Enum.MeshPartDetailLevel": { "documentation": "The level of detail of MeshParts displayed in Studio.", "keys": { "DistanceBased": "@roblox/enum/MeshPartDetailLevel.DistanceBased", "Level00": "@roblox/enum/MeshPartDetailLevel.Level00", "Level01": "@roblox/enum/MeshPartDetailLevel.Level01", "Level02": "@roblox/enum/MeshPartDetailLevel.Level02", "Level03": "@roblox/enum/MeshPartDetailLevel.Level03", "Level04": "@roblox/enum/MeshPartDetailLevel.Level04" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshPartDetailLevel", "code_sample": "" }, "@roblox/enum/UIDragSpeedAxisMapping.XY": { "documentation": "Default setting for a detector's UIDragSpeedAxisMapping where the X and Y axis speeds are based off the X and Y Scale/Offset values respectively.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragSpeedAxisMapping#XY", "code_sample": "" }, "@roblox/enum/UIDragSpeedAxisMapping.XX": { "documentation": "Both the X and Y axis speeds are based off the X axis for Scale, while the Offset values still apply to their respective axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragSpeedAxisMapping#XX", "code_sample": "" }, "@roblox/enum/UIDragSpeedAxisMapping.YY": { "documentation": "Both the X and Y axis speeds are based off the Y axis for Scale, while the Offset values still apply to their respective axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragSpeedAxisMapping#YY", "code_sample": "" }, "@roblox/global/Enum.UIDragSpeedAxisMapping": { "documentation": "Used with UIDragDetector.UIDragSpeedAxisMapping to determine the X/Y dimension dragging speeds.", "keys": { "XY": "@roblox/enum/UIDragSpeedAxisMapping.XY", "XX": "@roblox/enum/UIDragSpeedAxisMapping.XX", "YY": "@roblox/enum/UIDragSpeedAxisMapping.YY" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragSpeedAxisMapping", "code_sample": "" }, "@roblox/enum/VoiceControlPath.Publish": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceControlPath#Publish", "code_sample": "" }, "@roblox/enum/VoiceControlPath.Subscribe": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceControlPath#Subscribe", "code_sample": "" }, "@roblox/enum/VoiceControlPath.Join": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceControlPath#Join", "code_sample": "" }, "@roblox/global/Enum.VoiceControlPath": { "documentation": "", "keys": { "Publish": "@roblox/enum/VoiceControlPath.Publish", "Subscribe": "@roblox/enum/VoiceControlPath.Subscribe", "Join": "@roblox/enum/VoiceControlPath.Join" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VoiceControlPath", "code_sample": "" }, "@roblox/enum/GraphicsOptimizationMode.Performance": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsOptimizationMode#Performance", "code_sample": "" }, "@roblox/enum/GraphicsOptimizationMode.Balanced": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsOptimizationMode#Balanced", "code_sample": "" }, "@roblox/enum/GraphicsOptimizationMode.Quality": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsOptimizationMode#Quality", "code_sample": "" }, "@roblox/global/Enum.GraphicsOptimizationMode": { "documentation": "", "keys": { "Performance": "@roblox/enum/GraphicsOptimizationMode.Performance", "Balanced": "@roblox/enum/GraphicsOptimizationMode.Balanced", "Quality": "@roblox/enum/GraphicsOptimizationMode.Quality" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsOptimizationMode", "code_sample": "" }, "@roblox/enum/FriendStatus.Unknown": { "documentation": "The connection status of two players is unknown.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendStatus#Unknown", "code_sample": "" }, "@roblox/enum/FriendStatus.NotFriend": { "documentation": "Two players are not connections.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendStatus#NotFriend", "code_sample": "" }, "@roblox/enum/FriendStatus.Friend": { "documentation": "Two players are connections.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendStatus#Friend", "code_sample": "" }, "@roblox/enum/FriendStatus.FriendRequestSent": { "documentation": "At least one of two players has sent a connection request to the other player.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendStatus#FriendRequestSent", "code_sample": "" }, "@roblox/enum/FriendStatus.FriendRequestReceived": { "documentation": "At least one of two players has received a connection request sent by the other player.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendStatus#FriendRequestReceived", "code_sample": "" }, "@roblox/global/Enum.FriendStatus": { "documentation": "", "keys": { "Unknown": "@roblox/enum/FriendStatus.Unknown", "NotFriend": "@roblox/enum/FriendStatus.NotFriend", "Friend": "@roblox/enum/FriendStatus.Friend", "FriendRequestSent": "@roblox/enum/FriendStatus.FriendRequestSent", "FriendRequestReceived": "@roblox/enum/FriendStatus.FriendRequestReceived" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FriendStatus", "code_sample": "" }, "@roblox/enum/ItemLineAlignment.Automatic": { "documentation": "Aligns the siblings of the UIListLayout or the specific UIFlexItem parent to the layout's HorizontalAlignment or VerticalAlignment, depending on its FillDirection. If HorizontalFlex or VerticalFlex is enabled for the UIListLayout cross‑direction, Stretch will be used for that direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ItemLineAlignment#Automatic", "code_sample": "" }, "@roblox/enum/ItemLineAlignment.Start": { "documentation": "Aligns the siblings of the UIListLayout or the specific UIFlexItem parent to the line's top in a horizontal fill or the line's left in a vertical fill.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ItemLineAlignment#Start", "code_sample": "" }, "@roblox/enum/ItemLineAlignment.Center": { "documentation": "Aligns the siblings of the UIListLayout or the specific UIFlexItem parent to the line's center in either a horizontal or vertical fill.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ItemLineAlignment#Center", "code_sample": "" }, "@roblox/enum/ItemLineAlignment.End": { "documentation": "Aligns the siblings of the UIListLayout or the specific UIFlexItem parent to the line's bottom in a horizontal fill or the line's right in a vertical fill.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ItemLineAlignment#End", "code_sample": "" }, "@roblox/enum/ItemLineAlignment.Stretch": { "documentation": "Stretches the siblings of the UIListLayout or the specific UIFlexItem parent to fill the entire cross‑direction of the line in either a horizontal or vertical fill.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ItemLineAlignment#Stretch", "code_sample": "" }, "@roblox/global/Enum.ItemLineAlignment": { "documentation": "Used for UIListLayout.ItemLineAlignment and UIFlexItem.ItemLineAlignment in a flex layout to define the cross-directional alignment of siblings or the parent within a line.", "keys": { "Automatic": "@roblox/enum/ItemLineAlignment.Automatic", "Start": "@roblox/enum/ItemLineAlignment.Start", "Center": "@roblox/enum/ItemLineAlignment.Center", "End": "@roblox/enum/ItemLineAlignment.End", "Stretch": "@roblox/enum/ItemLineAlignment.Stretch" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ItemLineAlignment", "code_sample": "" }, "@roblox/enum/TrackerError.Ok": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#Ok", "code_sample": "" }, "@roblox/enum/TrackerError.NoService": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#NoService", "code_sample": "" }, "@roblox/enum/TrackerError.InitFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#InitFailed", "code_sample": "" }, "@roblox/enum/TrackerError.NoVideo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#NoVideo", "code_sample": "" }, "@roblox/enum/TrackerError.VideoError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#VideoError", "code_sample": "" }, "@roblox/enum/TrackerError.VideoNoPermission": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#VideoNoPermission", "code_sample": "" }, "@roblox/enum/TrackerError.VideoUnsupported": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#VideoUnsupported", "code_sample": "" }, "@roblox/enum/TrackerError.NoAudio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#NoAudio", "code_sample": "" }, "@roblox/enum/TrackerError.AudioError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#AudioError", "code_sample": "" }, "@roblox/enum/TrackerError.AudioNoPermission": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#AudioNoPermission", "code_sample": "" }, "@roblox/enum/TrackerError.UnsupportedDevice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError#UnsupportedDevice", "code_sample": "" }, "@roblox/global/Enum.TrackerError": { "documentation": "", "keys": { "Ok": "@roblox/enum/TrackerError.Ok", "NoService": "@roblox/enum/TrackerError.NoService", "InitFailed": "@roblox/enum/TrackerError.InitFailed", "NoVideo": "@roblox/enum/TrackerError.NoVideo", "VideoError": "@roblox/enum/TrackerError.VideoError", "VideoNoPermission": "@roblox/enum/TrackerError.VideoNoPermission", "VideoUnsupported": "@roblox/enum/TrackerError.VideoUnsupported", "NoAudio": "@roblox/enum/TrackerError.NoAudio", "AudioError": "@roblox/enum/TrackerError.AudioError", "AudioNoPermission": "@roblox/enum/TrackerError.AudioNoPermission", "UnsupportedDevice": "@roblox/enum/TrackerError.UnsupportedDevice" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TrackerError", "code_sample": "" }, "@roblox/enum/AvatarSettingsCollisionMode.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode#Default", "code_sample": "" }, "@roblox/enum/AvatarSettingsCollisionMode.SingleCollider": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode#SingleCollider", "code_sample": "" }, "@roblox/enum/AvatarSettingsCollisionMode.Legacy": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode#Legacy", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsCollisionMode": { "documentation": "", "keys": { "Default": "@roblox/enum/AvatarSettingsCollisionMode.Default", "SingleCollider": "@roblox/enum/AvatarSettingsCollisionMode.SingleCollider", "Legacy": "@roblox/enum/AvatarSettingsCollisionMode.Legacy" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsCollisionMode", "code_sample": "" }, "@roblox/enum/VirtualInputMode.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualInputMode#None", "code_sample": "" }, "@roblox/enum/VirtualInputMode.Recording": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualInputMode#Recording", "code_sample": "" }, "@roblox/enum/VirtualInputMode.Playing": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualInputMode#Playing", "code_sample": "" }, "@roblox/global/Enum.VirtualInputMode": { "documentation": "", "keys": { "None": "@roblox/enum/VirtualInputMode.None", "Recording": "@roblox/enum/VirtualInputMode.Recording", "Playing": "@roblox/enum/VirtualInputMode.Playing" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VirtualInputMode", "code_sample": "" }, "@roblox/enum/OutfitType.All": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitType#All", "code_sample": "" }, "@roblox/enum/OutfitType.Avatar": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitType#Avatar", "code_sample": "" }, "@roblox/enum/OutfitType.DynamicHead": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitType#DynamicHead", "code_sample": "" }, "@roblox/global/Enum.OutfitType": { "documentation": "", "keys": { "All": "@roblox/enum/OutfitType.All", "Avatar": "@roblox/enum/OutfitType.Avatar", "DynamicHead": "@roblox/enum/OutfitType.DynamicHead" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutfitType", "code_sample": "" }, "@roblox/enum/StudioPlaceUpdateFailureReason.Other": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioPlaceUpdateFailureReason#Other", "code_sample": "" }, "@roblox/enum/StudioPlaceUpdateFailureReason.TeamCreateConflict": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioPlaceUpdateFailureReason#TeamCreateConflict", "code_sample": "" }, "@roblox/global/Enum.StudioPlaceUpdateFailureReason": { "documentation": "", "keys": { "Other": "@roblox/enum/StudioPlaceUpdateFailureReason.Other", "TeamCreateConflict": "@roblox/enum/StudioPlaceUpdateFailureReason.TeamCreateConflict" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioPlaceUpdateFailureReason", "code_sample": "" }, "@roblox/enum/OperationType.Null": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OperationType#Null", "code_sample": "" }, "@roblox/enum/OperationType.Union": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OperationType#Union", "code_sample": "" }, "@roblox/enum/OperationType.Subtraction": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OperationType#Subtraction", "code_sample": "" }, "@roblox/enum/OperationType.Intersection": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OperationType#Intersection", "code_sample": "" }, "@roblox/enum/OperationType.Primitive": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OperationType#Primitive", "code_sample": "" }, "@roblox/global/Enum.OperationType": { "documentation": "", "keys": { "Null": "@roblox/enum/OperationType.Null", "Union": "@roblox/enum/OperationType.Union", "Subtraction": "@roblox/enum/OperationType.Subtraction", "Intersection": "@roblox/enum/OperationType.Intersection", "Primitive": "@roblox/enum/OperationType.Primitive" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OperationType", "code_sample": "" }, "@roblox/enum/ModifierKey.Shift": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModifierKey#Shift", "code_sample": "" }, "@roblox/enum/ModifierKey.Ctrl": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModifierKey#Ctrl", "code_sample": "" }, "@roblox/enum/ModifierKey.Alt": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModifierKey#Alt", "code_sample": "" }, "@roblox/enum/ModifierKey.Meta": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModifierKey#Meta", "code_sample": "" }, "@roblox/global/Enum.ModifierKey": { "documentation": "", "keys": { "Shift": "@roblox/enum/ModifierKey.Shift", "Ctrl": "@roblox/enum/ModifierKey.Ctrl", "Alt": "@roblox/enum/ModifierKey.Alt", "Meta": "@roblox/enum/ModifierKey.Meta" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModifierKey", "code_sample": "" }, "@roblox/enum/PlayerActions.CharacterForward": { "documentation": "The player moved forward.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerActions#CharacterForward", "code_sample": "" }, "@roblox/enum/PlayerActions.CharacterBackward": { "documentation": "The player moved backward.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerActions#CharacterBackward", "code_sample": "" }, "@roblox/enum/PlayerActions.CharacterLeft": { "documentation": "The player moved left.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerActions#CharacterLeft", "code_sample": "" }, "@roblox/enum/PlayerActions.CharacterRight": { "documentation": "The player moved right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerActions#CharacterRight", "code_sample": "" }, "@roblox/enum/PlayerActions.CharacterJump": { "documentation": "The player jumped.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerActions#CharacterJump", "code_sample": "" }, "@roblox/global/Enum.PlayerActions": { "documentation": "References a movement action taken by a player.", "keys": { "CharacterForward": "@roblox/enum/PlayerActions.CharacterForward", "CharacterBackward": "@roblox/enum/PlayerActions.CharacterBackward", "CharacterLeft": "@roblox/enum/PlayerActions.CharacterLeft", "CharacterRight": "@roblox/enum/PlayerActions.CharacterRight", "CharacterJump": "@roblox/enum/PlayerActions.CharacterJump" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerActions", "code_sample": "" }, "@roblox/enum/ProximityPromptInputType.Keyboard": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptInputType#Keyboard", "code_sample": "" }, "@roblox/enum/ProximityPromptInputType.Gamepad": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptInputType#Gamepad", "code_sample": "" }, "@roblox/enum/ProximityPromptInputType.Touch": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptInputType#Touch", "code_sample": "" }, "@roblox/global/Enum.ProximityPromptInputType": { "documentation": "", "keys": { "Keyboard": "@roblox/enum/ProximityPromptInputType.Keyboard", "Gamepad": "@roblox/enum/ProximityPromptInputType.Gamepad", "Touch": "@roblox/enum/ProximityPromptInputType.Touch" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptInputType", "code_sample": "" }, "@roblox/enum/PlayerCharacterDestroyBehavior.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerCharacterDestroyBehavior#Default", "code_sample": "" }, "@roblox/enum/PlayerCharacterDestroyBehavior.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerCharacterDestroyBehavior#Disabled", "code_sample": "" }, "@roblox/enum/PlayerCharacterDestroyBehavior.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerCharacterDestroyBehavior#Enabled", "code_sample": "" }, "@roblox/global/Enum.PlayerCharacterDestroyBehavior": { "documentation": "", "keys": { "Default": "@roblox/enum/PlayerCharacterDestroyBehavior.Default", "Disabled": "@roblox/enum/PlayerCharacterDestroyBehavior.Disabled", "Enabled": "@roblox/enum/PlayerCharacterDestroyBehavior.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PlayerCharacterDestroyBehavior", "code_sample": "" }, "@roblox/enum/Status.Poison": { "documentation": "Deprecated: This option is deprecated.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Status#Poison", "code_sample": "" }, "@roblox/enum/Status.Confusion": { "documentation": "Deprecated: This option is deprecated.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Status#Confusion", "code_sample": "" }, "@roblox/global/Enum.Status": { "documentation": "Deprecated: This enum is deprecated as it was only used by deprecated methods and events. It should not be used in new work.
This enum was used with the unfinished Status library.", "keys": { "Poison": "@roblox/enum/Status.Poison", "Confusion": "@roblox/enum/Status.Confusion" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Status", "code_sample": "" }, "@roblox/enum/KeywordFilterType.Include": { "documentation": "Include the matched content.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeywordFilterType#Include", "code_sample": "" }, "@roblox/enum/KeywordFilterType.Exclude": { "documentation": "Exclude the matched content.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeywordFilterType#Exclude", "code_sample": "" }, "@roblox/global/Enum.KeywordFilterType": { "documentation": "Determines if a filter is 'inclusive' or 'exclusive'.", "keys": { "Include": "@roblox/enum/KeywordFilterType.Include", "Exclude": "@roblox/enum/KeywordFilterType.Exclude" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeywordFilterType", "code_sample": "" }, "@roblox/enum/InterpolationThrottlingMode.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InterpolationThrottlingMode#Default", "code_sample": "" }, "@roblox/enum/InterpolationThrottlingMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InterpolationThrottlingMode#Disabled", "code_sample": "" }, "@roblox/enum/InterpolationThrottlingMode.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InterpolationThrottlingMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.InterpolationThrottlingMode": { "documentation": "", "keys": { "Default": "@roblox/enum/InterpolationThrottlingMode.Default", "Disabled": "@roblox/enum/InterpolationThrottlingMode.Disabled", "Enabled": "@roblox/enum/InterpolationThrottlingMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InterpolationThrottlingMode", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.ColorRGB": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"R\", \"G\", and \"B\" to animate the corresponding components of the Color3 value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#ColorRGB", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.ColorHSV": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"H\", \"S\", and \"V\" to animate hue, saturation, and value of a color that will be converted to RGB before returning a Color3 value from the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#ColorHSV", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.NumberRange": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"Min\" and \"Max\" to animate the corresponding components of the NumberRange value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#NumberRange", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.Rect": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"MinX\", \"MaxX\", \"MinY\", and \"MaxY\" to animate the corresponding components of the Rect value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#Rect", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.UDim": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"Scale\" and \"Offset\" to animate the corresponding components of the UDim value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#UDim", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.UDim2": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"ScaleX\", \"OffsetX\", \"ScaleY\", and \"OffsetY\" to animate the corresponding components of the UDim2 value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#UDim2", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.Vector2": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"X\" and \"Y\" to animate the corresponding components of the Vector2 value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#Vector2", "code_sample": "" }, "@roblox/enum/CompositeValueCurveType.Vector3": { "documentation": "The CompositeValueCurve will animate children of type FloatCurve named \"X\", \"Y\", and \"Z\" to animate the corresponding components of the Vector3 value returned by the method CompositeValueCurve:GetValueAtTime().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType#Vector3", "code_sample": "" }, "@roblox/global/Enum.CompositeValueCurveType": { "documentation": "Describes the type of value animated by a CompositeValueCurve.", "keys": { "ColorRGB": "@roblox/enum/CompositeValueCurveType.ColorRGB", "ColorHSV": "@roblox/enum/CompositeValueCurveType.ColorHSV", "NumberRange": "@roblox/enum/CompositeValueCurveType.NumberRange", "Rect": "@roblox/enum/CompositeValueCurveType.Rect", "UDim": "@roblox/enum/CompositeValueCurveType.UDim", "UDim2": "@roblox/enum/CompositeValueCurveType.UDim2", "Vector2": "@roblox/enum/CompositeValueCurveType.Vector2", "Vector3": "@roblox/enum/CompositeValueCurveType.Vector3" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompositeValueCurveType", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Text": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Text", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Method": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Method", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Function": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Function", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Constructor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Constructor", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Field": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Field", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Variable": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Variable", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Class": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Class", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Interface": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Interface", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Module": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Module", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Property": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Property", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Unit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Unit", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Value": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Value", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Enum": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Enum", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Keyword": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Keyword", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Snippet": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Snippet", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Color": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Color", "code_sample": "" }, "@roblox/enum/CompletionItemKind.File": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#File", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Reference": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Reference", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Folder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Folder", "code_sample": "" }, "@roblox/enum/CompletionItemKind.EnumMember": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#EnumMember", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Constant": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Constant", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Struct": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Struct", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Event": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Event", "code_sample": "" }, "@roblox/enum/CompletionItemKind.Operator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#Operator", "code_sample": "" }, "@roblox/enum/CompletionItemKind.TypeParameter": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind#TypeParameter", "code_sample": "" }, "@roblox/global/Enum.CompletionItemKind": { "documentation": "", "keys": { "Text": "@roblox/enum/CompletionItemKind.Text", "Method": "@roblox/enum/CompletionItemKind.Method", "Function": "@roblox/enum/CompletionItemKind.Function", "Constructor": "@roblox/enum/CompletionItemKind.Constructor", "Field": "@roblox/enum/CompletionItemKind.Field", "Variable": "@roblox/enum/CompletionItemKind.Variable", "Class": "@roblox/enum/CompletionItemKind.Class", "Interface": "@roblox/enum/CompletionItemKind.Interface", "Module": "@roblox/enum/CompletionItemKind.Module", "Property": "@roblox/enum/CompletionItemKind.Property", "Unit": "@roblox/enum/CompletionItemKind.Unit", "Value": "@roblox/enum/CompletionItemKind.Value", "Enum": "@roblox/enum/CompletionItemKind.Enum", "Keyword": "@roblox/enum/CompletionItemKind.Keyword", "Snippet": "@roblox/enum/CompletionItemKind.Snippet", "Color": "@roblox/enum/CompletionItemKind.Color", "File": "@roblox/enum/CompletionItemKind.File", "Reference": "@roblox/enum/CompletionItemKind.Reference", "Folder": "@roblox/enum/CompletionItemKind.Folder", "EnumMember": "@roblox/enum/CompletionItemKind.EnumMember", "Constant": "@roblox/enum/CompletionItemKind.Constant", "Struct": "@roblox/enum/CompletionItemKind.Struct", "Event": "@roblox/enum/CompletionItemKind.Event", "Operator": "@roblox/enum/CompletionItemKind.Operator", "TypeParameter": "@roblox/enum/CompletionItemKind.TypeParameter" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CompletionItemKind", "code_sample": "" }, "@roblox/enum/MuteState.Unmuted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MuteState#Unmuted", "code_sample": "" }, "@roblox/enum/MuteState.Muted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MuteState#Muted", "code_sample": "" }, "@roblox/global/Enum.MuteState": { "documentation": "", "keys": { "Unmuted": "@roblox/enum/MuteState.Unmuted", "Muted": "@roblox/enum/MuteState.Muted" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MuteState", "code_sample": "" }, "@roblox/enum/ActionOnAutoResumeSync.DontResume": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync#DontResume", "code_sample": "" }, "@roblox/enum/ActionOnAutoResumeSync.KeepStudio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync#KeepStudio", "code_sample": "" }, "@roblox/enum/ActionOnAutoResumeSync.KeepLocal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync#KeepLocal", "code_sample": "" }, "@roblox/global/Enum.ActionOnAutoResumeSync": { "documentation": "", "keys": { "DontResume": "@roblox/enum/ActionOnAutoResumeSync.DontResume", "KeepStudio": "@roblox/enum/ActionOnAutoResumeSync.KeepStudio", "KeepLocal": "@roblox/enum/ActionOnAutoResumeSync.KeepLocal" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ActionOnAutoResumeSync", "code_sample": "" }, "@roblox/enum/FunctionalTestResult.Passed": { "documentation": "The test run was successful.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult#Passed", "code_sample": "" }, "@roblox/enum/FunctionalTestResult.Warning": { "documentation": "The test run is potentially unstable.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult#Warning", "code_sample": "" }, "@roblox/enum/FunctionalTestResult.Error": { "documentation": "The test run failed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult#Error", "code_sample": "" }, "@roblox/global/Enum.FunctionalTestResult": { "documentation": "Status of a single functional test run.", "keys": { "Passed": "@roblox/enum/FunctionalTestResult.Passed", "Warning": "@roblox/enum/FunctionalTestResult.Warning", "Error": "@roblox/enum/FunctionalTestResult.Error" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FunctionalTestResult", "code_sample": "" }, "@roblox/enum/TouchCameraMovementMode.Default": { "documentation": "Default mode used by Roblox core scripts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchCameraMovementMode#Default", "code_sample": "" }, "@roblox/enum/TouchCameraMovementMode.Classic": { "documentation": "Default mode used by Roblox core scripts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchCameraMovementMode#Classic", "code_sample": "" }, "@roblox/enum/TouchCameraMovementMode.Follow": { "documentation": "Camera moves with the subject and rotates to keep the subject in the center.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchCameraMovementMode#Follow", "code_sample": "" }, "@roblox/enum/TouchCameraMovementMode.Orbital": { "documentation": "The camera locks at a certain angle. Once it's set, players can rotate the camera, but it will always maintain a consistent angle to the ground.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchCameraMovementMode#Orbital", "code_sample": "" }, "@roblox/global/Enum.TouchCameraMovementMode": { "documentation": "Changes the touch camera movement mode currently in-use by the client using a TouchEnabled device.", "keys": { "Default": "@roblox/enum/TouchCameraMovementMode.Default", "Classic": "@roblox/enum/TouchCameraMovementMode.Classic", "Follow": "@roblox/enum/TouchCameraMovementMode.Follow", "Orbital": "@roblox/enum/TouchCameraMovementMode.Orbital" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TouchCameraMovementMode", "code_sample": "" }, "@roblox/enum/DeviceType.Unknown": { "documentation": "The client is an unknown device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceType#Unknown", "code_sample": "" }, "@roblox/enum/DeviceType.Desktop": { "documentation": "The client is a desktop device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceType#Desktop", "code_sample": "" }, "@roblox/enum/DeviceType.Tablet": { "documentation": "The client is a tablet device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceType#Tablet", "code_sample": "" }, "@roblox/enum/DeviceType.Phone": { "documentation": "The client is a phone device.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceType#Phone", "code_sample": "" }, "@roblox/global/Enum.DeviceType": { "documentation": "Device category of the client.", "keys": { "Unknown": "@roblox/enum/DeviceType.Unknown", "Desktop": "@roblox/enum/DeviceType.Desktop", "Tablet": "@roblox/enum/DeviceType.Tablet", "Phone": "@roblox/enum/DeviceType.Phone" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceType", "code_sample": "" }, "@roblox/enum/AutoIndentRule.Off": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule#Off", "code_sample": "" }, "@roblox/enum/AutoIndentRule.Absolute": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule#Absolute", "code_sample": "" }, "@roblox/enum/AutoIndentRule.Relative": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule#Relative", "code_sample": "" }, "@roblox/global/Enum.AutoIndentRule": { "documentation": "", "keys": { "Off": "@roblox/enum/AutoIndentRule.Off", "Absolute": "@roblox/enum/AutoIndentRule.Absolute", "Relative": "@roblox/enum/AutoIndentRule.Relative" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutoIndentRule", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.TranslateLine": { "documentation": "1D motion along the detector's Axis, by default the world Y axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslateLine", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.TranslatePlane": { "documentation": "2D motion in the plane perpendicular to the detector's Axis, by default the world XZ plane.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslatePlane", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.TranslatePlaneOrLine": { "documentation": "2D motion in the plane perpendicular to the detector's Axis and, when the modifier is active, 1D motion along the detector's Axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslatePlaneOrLine", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.TranslateLineOrPlane": { "documentation": "1D motion along the detector's Axis and, when the modifier is active, 2D motion in the plane perpendicular to the detector's Axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslateLineOrPlane", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.TranslateViewPlane": { "documentation": "2D motion in the plane perpendicular to the camera's view. In this mode, the plane is constantly updated, even while dragging, and will always face the camera's current view.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#TranslateViewPlane", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.RotateAxis": { "documentation": "Rotation about the detector's Axis, by default the world Y axis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#RotateAxis", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.RotateTrackball": { "documentation": "Trackball rotation, further customized through the TrackballRadialPullFactor and TrackballRollFactor properties.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#RotateTrackball", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.Scriptable": { "documentation": "Calculates desired motion via a custom function provided through SetDragStyleFunction().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#Scriptable", "code_sample": "" }, "@roblox/enum/DragDetectorDragStyle.BestForDevice": { "documentation": "TranslatePlaneOrLine for mouse and gamepad; TranslatePlane for touch; 6DOF for VR.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle#BestForDevice", "code_sample": "" }, "@roblox/global/Enum.DragDetectorDragStyle": { "documentation": "Used with DragDetector as the paradigm to generate proposed motion, given a stream of cursor rays.", "keys": { "TranslateLine": "@roblox/enum/DragDetectorDragStyle.TranslateLine", "TranslatePlane": "@roblox/enum/DragDetectorDragStyle.TranslatePlane", "TranslatePlaneOrLine": "@roblox/enum/DragDetectorDragStyle.TranslatePlaneOrLine", "TranslateLineOrPlane": "@roblox/enum/DragDetectorDragStyle.TranslateLineOrPlane", "TranslateViewPlane": "@roblox/enum/DragDetectorDragStyle.TranslateViewPlane", "RotateAxis": "@roblox/enum/DragDetectorDragStyle.RotateAxis", "RotateTrackball": "@roblox/enum/DragDetectorDragStyle.RotateTrackball", "Scriptable": "@roblox/enum/DragDetectorDragStyle.Scriptable", "BestForDevice": "@roblox/enum/DragDetectorDragStyle.BestForDevice" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DragDetectorDragStyle", "code_sample": "" }, "@roblox/enum/SolverConvergenceMetricType.IterationBased": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceMetricType#IterationBased", "code_sample": "" }, "@roblox/enum/SolverConvergenceMetricType.AlgorithmAgnostic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceMetricType#AlgorithmAgnostic", "code_sample": "" }, "@roblox/global/Enum.SolverConvergenceMetricType": { "documentation": "", "keys": { "IterationBased": "@roblox/enum/SolverConvergenceMetricType.IterationBased", "AlgorithmAgnostic": "@roblox/enum/SolverConvergenceMetricType.AlgorithmAgnostic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SolverConvergenceMetricType", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyTransactionType.IAP": { "documentation": "Represents a source of currency purchased via Robux, for example in-experience \"gold\" purchased for Robux.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#IAP", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyTransactionType.Shop": { "documentation": "Purchases within a shop, for example in-experience \"coins\" used to buy an item within the experience.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#Shop", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyTransactionType.Gameplay": { "documentation": "Currency earned or paid through gameplay, for example in-experience \"gold\" earned from winning a match.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#Gameplay", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyTransactionType.ContextualPurchase": { "documentation": "Purchase with direct context to a reward, for example in-experience \"gold\" used to purchase an extra life.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#ContextualPurchase", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyTransactionType.TimedReward": { "documentation": "Time-based reward, for example in-experience \"gold\" rewarded for logging in daily.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#TimedReward", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyTransactionType.Onboarding": { "documentation": "Transaction related to onboarding, for example in-experience \"gold\" rewarded for completing the tutorial.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType#Onboarding", "code_sample": "" }, "@roblox/global/Enum.AnalyticsEconomyTransactionType": { "documentation": "", "keys": { "IAP": "@roblox/enum/AnalyticsEconomyTransactionType.IAP", "Shop": "@roblox/enum/AnalyticsEconomyTransactionType.Shop", "Gameplay": "@roblox/enum/AnalyticsEconomyTransactionType.Gameplay", "ContextualPurchase": "@roblox/enum/AnalyticsEconomyTransactionType.ContextualPurchase", "TimedReward": "@roblox/enum/AnalyticsEconomyTransactionType.TimedReward", "Onboarding": "@roblox/enum/AnalyticsEconomyTransactionType.Onboarding" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyTransactionType", "code_sample": "" }, "@roblox/enum/VRTouchpadMode.Touch": { "documentation": "The touchpad is treated as ButtonB if it is the left touchpad, or ButtonA if it is the right touchpad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpadMode#Touch", "code_sample": "" }, "@roblox/enum/VRTouchpadMode.VirtualThumbstick": { "documentation": "The touchpad will function as a gamepad joystick.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpadMode#VirtualThumbstick", "code_sample": "" }, "@roblox/enum/VRTouchpadMode.ABXY": { "documentation": "The touchpad will function as a means of inputting the standard ABXY gamepad input, dividing it up into 4 diagonal pie slices.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpadMode#ABXY", "code_sample": "" }, "@roblox/global/Enum.VRTouchpadMode": { "documentation": "Used to identify the behavior of a specified VR touchpad.", "keys": { "Touch": "@roblox/enum/VRTouchpadMode.Touch", "VirtualThumbstick": "@roblox/enum/VRTouchpadMode.VirtualThumbstick", "ABXY": "@roblox/enum/VRTouchpadMode.ABXY" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpadMode", "code_sample": "" }, "@roblox/enum/KeyInterpolationMode.Constant": { "documentation": "The segment starting at this key will constantly evaluate to the value set at this key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyInterpolationMode#Constant", "code_sample": "" }, "@roblox/enum/KeyInterpolationMode.Linear": { "documentation": "The segment starting at this key will evaluate using a linear interpolation at this key and the value at the next key.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyInterpolationMode#Linear", "code_sample": "" }, "@roblox/enum/KeyInterpolationMode.Cubic": { "documentation": "The segment starting at this key will evaluate using cubic interpolation of this key value using its right tangent and the next key value and its left tangent.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyInterpolationMode#Cubic", "code_sample": "" }, "@roblox/global/Enum.KeyInterpolationMode": { "documentation": "Describes the interpolation method between two keys.", "keys": { "Constant": "@roblox/enum/KeyInterpolationMode.Constant", "Linear": "@roblox/enum/KeyInterpolationMode.Linear", "Cubic": "@roblox/enum/KeyInterpolationMode.Cubic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/KeyInterpolationMode", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#Success", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.PermissionDenied": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#PermissionDenied", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.Timeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#Timeout", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.UploadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#UploadFailed", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.NoUserInput": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#NoUserInput", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.UnknownFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#UnknownFailure", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.UGCValidationFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#UGCValidationFailed", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.ModeratedName": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#ModeratedName", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.PurchaseFailure": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#PurchaseFailure", "code_sample": "" }, "@roblox/enum/PromptCreateAssetResult.TokenInvalid": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult#TokenInvalid", "code_sample": "" }, "@roblox/global/Enum.PromptCreateAssetResult": { "documentation": "", "keys": { "Success": "@roblox/enum/PromptCreateAssetResult.Success", "PermissionDenied": "@roblox/enum/PromptCreateAssetResult.PermissionDenied", "Timeout": "@roblox/enum/PromptCreateAssetResult.Timeout", "UploadFailed": "@roblox/enum/PromptCreateAssetResult.UploadFailed", "NoUserInput": "@roblox/enum/PromptCreateAssetResult.NoUserInput", "UnknownFailure": "@roblox/enum/PromptCreateAssetResult.UnknownFailure", "UGCValidationFailed": "@roblox/enum/PromptCreateAssetResult.UGCValidationFailed", "ModeratedName": "@roblox/enum/PromptCreateAssetResult.ModeratedName", "PurchaseFailure": "@roblox/enum/PromptCreateAssetResult.PurchaseFailure", "TokenInvalid": "@roblox/enum/PromptCreateAssetResult.TokenInvalid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PromptCreateAssetResult", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionType.Custom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Custom", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionType.Start": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Start", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionType.Fail": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Fail", "code_sample": "" }, "@roblox/enum/AnalyticsProgressionType.Complete": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType#Complete", "code_sample": "" }, "@roblox/global/Enum.AnalyticsProgressionType": { "documentation": "", "keys": { "Custom": "@roblox/enum/AnalyticsProgressionType.Custom", "Start": "@roblox/enum/AnalyticsProgressionType.Start", "Fail": "@roblox/enum/AnalyticsProgressionType.Fail", "Complete": "@roblox/enum/AnalyticsProgressionType.Complete" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsProgressionType", "code_sample": "" }, "@roblox/enum/ForceLimitMode.Magnitude": { "documentation": "A single number is used to specify the magnitude of the maximum constraint force. The constraint will ensure that the force it applies will have a magnitude that is less than this limit.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ForceLimitMode#Magnitude", "code_sample": "" }, "@roblox/enum/ForceLimitMode.PerAxis": { "documentation": "A vector is used to specify the maximum force value along each axis of a given reference frame. The constraint will ensure that each component of the force will have an absolute value that's less than the corresponding vector entry.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ForceLimitMode#PerAxis", "code_sample": "" }, "@roblox/global/Enum.ForceLimitMode": { "documentation": "The ForceLimitMode enum determines how the maximum force for a constraint is specified and how that limit is enforced by the constraint.", "keys": { "Magnitude": "@roblox/enum/ForceLimitMode.Magnitude", "PerAxis": "@roblox/enum/ForceLimitMode.PerAxis" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ForceLimitMode", "code_sample": "" }, "@roblox/enum/StrokeSizingMode.FixedSize": { "documentation": "Thickness is measured in pixels.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StrokeSizingMode#FixedSize", "code_sample": "" }, "@roblox/enum/StrokeSizingMode.ScaledSize": { "documentation": "Thickness is relative to minimum parent width or height. If stroke is on text, thickness is relative to font size.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StrokeSizingMode#ScaledSize", "code_sample": "" }, "@roblox/global/Enum.StrokeSizingMode": { "documentation": "Used by UIStroke.StrokeSizingMode to determine whether the stroke's Thickness will be measured in pixels or be relative to the parent.", "keys": { "FixedSize": "@roblox/enum/StrokeSizingMode.FixedSize", "ScaledSize": "@roblox/enum/StrokeSizingMode.ScaledSize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StrokeSizingMode", "code_sample": "" }, "@roblox/enum/MeshType.Head": { "documentation": "The mesh is the default Humanoid head mesh.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Head", "code_sample": "" }, "@roblox/enum/MeshType.Torso": { "documentation": "The mesh is the default Humanoid torso mesh.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Torso", "code_sample": "" }, "@roblox/enum/MeshType.Wedge": { "documentation": "The mesh is a wedge.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Wedge", "code_sample": "" }, "@roblox/enum/MeshType.Sphere": { "documentation": "The mesh is a sphere.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Sphere", "code_sample": "" }, "@roblox/enum/MeshType.Cylinder": { "documentation": "The mesh is a cylinder.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Cylinder", "code_sample": "" }, "@roblox/enum/MeshType.FileMesh": { "documentation": "The mesh is determined by the Roblox mesh asset ID provided.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#FileMesh", "code_sample": "" }, "@roblox/enum/MeshType.Brick": { "documentation": "The mesh is a brick (just like the shape of a default BasePart).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Brick", "code_sample": "" }, "@roblox/enum/MeshType.Prism": { "documentation": "Deprecated:
The mesh is a prism.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Prism", "code_sample": "" }, "@roblox/enum/MeshType.Pyramid": { "documentation": "Deprecated:
The mesh is a pyramid.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#Pyramid", "code_sample": "" }, "@roblox/enum/MeshType.ParallelRamp": { "documentation": "Deprecated:
The mesh is a parallel ramp.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#ParallelRamp", "code_sample": "" }, "@roblox/enum/MeshType.RightAngleRamp": { "documentation": "Deprecated:
The mesh is a right angle ramp.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#RightAngleRamp", "code_sample": "" }, "@roblox/enum/MeshType.CornerWedge": { "documentation": "Deprecated:
The mesh is a corner wedge.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType#CornerWedge", "code_sample": "" }, "@roblox/global/Enum.MeshType": { "documentation": "The MeshType Enum is used to set what type of mesh the SpecialMesh is.", "keys": { "Head": "@roblox/enum/MeshType.Head", "Torso": "@roblox/enum/MeshType.Torso", "Wedge": "@roblox/enum/MeshType.Wedge", "Sphere": "@roblox/enum/MeshType.Sphere", "Cylinder": "@roblox/enum/MeshType.Cylinder", "FileMesh": "@roblox/enum/MeshType.FileMesh", "Brick": "@roblox/enum/MeshType.Brick", "Prism": "@roblox/enum/MeshType.Prism", "Pyramid": "@roblox/enum/MeshType.Pyramid", "ParallelRamp": "@roblox/enum/MeshType.ParallelRamp", "RightAngleRamp": "@roblox/enum/MeshType.RightAngleRamp", "CornerWedge": "@roblox/enum/MeshType.CornerWedge" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MeshType", "code_sample": "" }, "@roblox/enum/FontStyle.Normal": { "documentation": "The text renders normally with this font.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontStyle#Normal", "code_sample": "" }, "@roblox/enum/FontStyle.Italic": { "documentation": "The text renders italic with this font.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontStyle#Italic", "code_sample": "" }, "@roblox/global/Enum.FontStyle": { "documentation": "Describes whether a Font style is normal or italic.", "keys": { "Normal": "@roblox/enum/FontStyle.Normal", "Italic": "@roblox/enum/FontStyle.Italic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FontStyle", "code_sample": "" }, "@roblox/enum/MoverConstraintRootBehaviorMode.Default": { "documentation": "The default option for Workspace.MoverConstraintRootBehavior. Currently set to Disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoverConstraintRootBehaviorMode#Default", "code_sample": "" }, "@roblox/enum/MoverConstraintRootBehaviorMode.Disabled": { "documentation": "The legacy logic will be used for assembly root part selection when a mechanism contains a mover constraint.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoverConstraintRootBehaviorMode#Disabled", "code_sample": "" }, "@roblox/enum/MoverConstraintRootBehaviorMode.Enabled": { "documentation": "Improved logic will be used for assembly root part selection when a mechanism contains a mover constraint. This improved logic gives more consistent behavior when compared with other constraints or the deprecated BodyMover classes.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoverConstraintRootBehaviorMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.MoverConstraintRootBehaviorMode": { "documentation": "Values for Workspace.MoverConstraintRootBehavior. Controls the logic for selecting the assembly root part when using various mover constraints.", "keys": { "Default": "@roblox/enum/MoverConstraintRootBehaviorMode.Default", "Disabled": "@roblox/enum/MoverConstraintRootBehaviorMode.Disabled", "Enabled": "@roblox/enum/MoverConstraintRootBehaviorMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MoverConstraintRootBehaviorMode", "code_sample": "" }, "@roblox/enum/RigScale.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigScale#Default", "code_sample": "" }, "@roblox/enum/RigScale.Rthro": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigScale#Rthro", "code_sample": "" }, "@roblox/enum/RigScale.RthroNarrow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigScale#RthroNarrow", "code_sample": "" }, "@roblox/global/Enum.RigScale": { "documentation": "", "keys": { "Default": "@roblox/enum/RigScale.Default", "Rthro": "@roblox/enum/RigScale.Rthro", "RthroNarrow": "@roblox/enum/RigScale.RthroNarrow" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RigScale", "code_sample": "" }, "@roblox/enum/GraphicsMode.Automatic": { "documentation": "Roblox will automatically decide what graphics mode to use, depending on what best suits your device's specifications.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode#Automatic", "code_sample": "" }, "@roblox/enum/GraphicsMode.Direct3D11": { "documentation": "Direct3D Version 11 (Microsoft).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode#Direct3D11", "code_sample": "" }, "@roblox/enum/GraphicsMode.OpenGL": { "documentation": "OpenGL (Khronos Group).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode#OpenGL", "code_sample": "" }, "@roblox/enum/GraphicsMode.Metal": { "documentation": "Metal (Apple).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode#Metal", "code_sample": "" }, "@roblox/enum/GraphicsMode.Vulkan": { "documentation": "Vulkan (Khronos Group).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode#Vulkan", "code_sample": "" }, "@roblox/enum/GraphicsMode.NoGraphics": { "documentation": "Game will not be rendered, and instead a Diagnostics window is rendered on screen.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode#NoGraphics", "code_sample": "" }, "@roblox/global/Enum.GraphicsMode": { "documentation": "Used to set the graphics API that Roblox uses to render the game.", "keys": { "Automatic": "@roblox/enum/GraphicsMode.Automatic", "Direct3D11": "@roblox/enum/GraphicsMode.Direct3D11", "OpenGL": "@roblox/enum/GraphicsMode.OpenGL", "Metal": "@roblox/enum/GraphicsMode.Metal", "Vulkan": "@roblox/enum/GraphicsMode.Vulkan", "NoGraphics": "@roblox/enum/GraphicsMode.NoGraphics" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GraphicsMode", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragStyle.TranslatePlane": { "documentation": "2D motion in the plane of the LayerCollector.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragStyle#TranslatePlane", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragStyle.TranslateLine": { "documentation": "1D motion along the detector's DragAxis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragStyle#TranslateLine", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragStyle.Rotate": { "documentation": "By default, rotation about the absolute center position of the detector's parent GuiObject. If ReferenceUIInstance is set, rotation happens about that instance's absolute center position.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragStyle#Rotate", "code_sample": "" }, "@roblox/enum/UIDragDetectorDragStyle.Scriptable": { "documentation": "Calculates desired motion via a custom function provided through SetDragStyleFunction().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragStyle#Scriptable", "code_sample": "" }, "@roblox/global/Enum.UIDragDetectorDragStyle": { "documentation": "Used with UIDragDetector as the paradigm to generate proposed motion, given a stream of input position vectors.", "keys": { "TranslatePlane": "@roblox/enum/UIDragDetectorDragStyle.TranslatePlane", "TranslateLine": "@roblox/enum/UIDragDetectorDragStyle.TranslateLine", "Rotate": "@roblox/enum/UIDragDetectorDragStyle.Rotate", "Scriptable": "@roblox/enum/UIDragDetectorDragStyle.Scriptable" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/UIDragDetectorDragStyle", "code_sample": "" }, "@roblox/enum/HttpRequestType.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#Default", "code_sample": "" }, "@roblox/enum/HttpRequestType.MarketplaceService": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#MarketplaceService", "code_sample": "" }, "@roblox/enum/HttpRequestType.Players": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#Players", "code_sample": "" }, "@roblox/enum/HttpRequestType.Chat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#Chat", "code_sample": "" }, "@roblox/enum/HttpRequestType.Avatar": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#Avatar", "code_sample": "" }, "@roblox/enum/HttpRequestType.Analytics": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#Analytics", "code_sample": "" }, "@roblox/enum/HttpRequestType.Localization": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType#Localization", "code_sample": "" }, "@roblox/global/Enum.HttpRequestType": { "documentation": "", "keys": { "Default": "@roblox/enum/HttpRequestType.Default", "MarketplaceService": "@roblox/enum/HttpRequestType.MarketplaceService", "Players": "@roblox/enum/HttpRequestType.Players", "Chat": "@roblox/enum/HttpRequestType.Chat", "Avatar": "@roblox/enum/HttpRequestType.Avatar", "Analytics": "@roblox/enum/HttpRequestType.Analytics", "Localization": "@roblox/enum/HttpRequestType.Localization" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HttpRequestType", "code_sample": "" }, "@roblox/enum/StudioStyleGuideModifier.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideModifier#Default", "code_sample": "" }, "@roblox/enum/StudioStyleGuideModifier.Selected": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideModifier#Selected", "code_sample": "" }, "@roblox/enum/StudioStyleGuideModifier.Pressed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideModifier#Pressed", "code_sample": "" }, "@roblox/enum/StudioStyleGuideModifier.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideModifier#Disabled", "code_sample": "" }, "@roblox/enum/StudioStyleGuideModifier.Hover": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideModifier#Hover", "code_sample": "" }, "@roblox/global/Enum.StudioStyleGuideModifier": { "documentation": "", "keys": { "Default": "@roblox/enum/StudioStyleGuideModifier.Default", "Selected": "@roblox/enum/StudioStyleGuideModifier.Selected", "Pressed": "@roblox/enum/StudioStyleGuideModifier.Pressed", "Disabled": "@roblox/enum/StudioStyleGuideModifier.Disabled", "Hover": "@roblox/enum/StudioStyleGuideModifier.Hover" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/StudioStyleGuideModifier", "code_sample": "" }, "@roblox/enum/ProductPurchaseDecision.NotProcessedYet": { "documentation": "The purchase request has been sent but not yet processed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseDecision#NotProcessedYet", "code_sample": "" }, "@roblox/enum/ProductPurchaseDecision.PurchaseGranted": { "documentation": "The purchase has been processed and granted to the user who initiated the purchase request.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseDecision#PurchaseGranted", "code_sample": "" }, "@roblox/global/Enum.ProductPurchaseDecision": { "documentation": "The ProductPurchaseDecisionEnum works with MarketplaceService to indicate the status of the sale of developer products.", "keys": { "NotProcessedYet": "@roblox/enum/ProductPurchaseDecision.NotProcessedYet", "PurchaseGranted": "@roblox/enum/ProductPurchaseDecision.PurchaseGranted" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProductPurchaseDecision", "code_sample": "" }, "@roblox/enum/VRScaling.World": { "documentation": "Adjusts `Class.Camera.HeadScale' so that the world in VR is seen from the avatar's perspective.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRScaling#World", "code_sample": "" }, "@roblox/enum/VRScaling.Off": { "documentation": "Disable VR AutomaticScaling .", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRScaling#Off", "code_sample": "" }, "@roblox/global/Enum.VRScaling": { "documentation": "", "keys": { "World": "@roblox/enum/VRScaling.World", "Off": "@roblox/enum/VRScaling.Off" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRScaling", "code_sample": "" }, "@roblox/enum/DraggerCoordinateSpace.Object": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggerCoordinateSpace#Object", "code_sample": "" }, "@roblox/enum/DraggerCoordinateSpace.World": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggerCoordinateSpace#World", "code_sample": "" }, "@roblox/global/Enum.DraggerCoordinateSpace": { "documentation": "", "keys": { "Object": "@roblox/enum/DraggerCoordinateSpace.Object", "World": "@roblox/enum/DraggerCoordinateSpace.World" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggerCoordinateSpace", "code_sample": "" }, "@roblox/enum/GuiType.Core": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiType#Core", "code_sample": "" }, "@roblox/enum/GuiType.Custom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiType#Custom", "code_sample": "" }, "@roblox/enum/GuiType.PlayerNameplates": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiType#PlayerNameplates", "code_sample": "" }, "@roblox/enum/GuiType.CustomBillboards": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiType#CustomBillboards", "code_sample": "" }, "@roblox/enum/GuiType.CoreBillboards": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiType#CoreBillboards", "code_sample": "" }, "@roblox/global/Enum.GuiType": { "documentation": "", "keys": { "Core": "@roblox/enum/GuiType.Core", "Custom": "@roblox/enum/GuiType.Custom", "PlayerNameplates": "@roblox/enum/GuiType.PlayerNameplates", "CustomBillboards": "@roblox/enum/GuiType.CustomBillboards", "CoreBillboards": "@roblox/enum/GuiType.CoreBillboards" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/GuiType", "code_sample": "" }, "@roblox/enum/AdFormat.RewardedVideo": { "documentation": "The format of the rewarded video ad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdFormat#RewardedVideo", "code_sample": "" }, "@roblox/global/Enum.AdFormat": { "documentation": "", "keys": { "RewardedVideo": "@roblox/enum/AdFormat.RewardedVideo" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdFormat", "code_sample": "" }, "@roblox/enum/BodyPart.Head": { "documentation": "The head BodyPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart#Head", "code_sample": "" }, "@roblox/enum/BodyPart.Torso": { "documentation": "The torso BodyPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart#Torso", "code_sample": "" }, "@roblox/enum/BodyPart.LeftArm": { "documentation": "The left arm BodyPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart#LeftArm", "code_sample": "" }, "@roblox/enum/BodyPart.RightArm": { "documentation": "The right arm BodyPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart#RightArm", "code_sample": "" }, "@roblox/enum/BodyPart.LeftLeg": { "documentation": "The left leg BodyPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart#LeftLeg", "code_sample": "" }, "@roblox/enum/BodyPart.RightLeg": { "documentation": "The right leg BodyPart.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart#RightLeg", "code_sample": "" }, "@roblox/global/Enum.BodyPart": { "documentation": "The BodyPart Enum determines which BodyPart a CharacterMesh affects.", "keys": { "Head": "@roblox/enum/BodyPart.Head", "Torso": "@roblox/enum/BodyPart.Torso", "LeftArm": "@roblox/enum/BodyPart.LeftArm", "RightArm": "@roblox/enum/BodyPart.RightArm", "LeftLeg": "@roblox/enum/BodyPart.LeftLeg", "RightLeg": "@roblox/enum/BodyPart.RightLeg" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BodyPart", "code_sample": "" }, "@roblox/enum/BulkMoveMode.FireAllEvents": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BulkMoveMode#FireAllEvents", "code_sample": "" }, "@roblox/enum/BulkMoveMode.FireCFrameChanged": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BulkMoveMode#FireCFrameChanged", "code_sample": "" }, "@roblox/global/Enum.BulkMoveMode": { "documentation": "", "keys": { "FireAllEvents": "@roblox/enum/BulkMoveMode.FireAllEvents", "FireCFrameChanged": "@roblox/enum/BulkMoveMode.FireCFrameChanged" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BulkMoveMode", "code_sample": "" }, "@roblox/enum/LoadDynamicHeads.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadDynamicHeads#Default", "code_sample": "" }, "@roblox/enum/LoadDynamicHeads.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadDynamicHeads#Disabled", "code_sample": "" }, "@roblox/enum/LoadDynamicHeads.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadDynamicHeads#Enabled", "code_sample": "" }, "@roblox/global/Enum.LoadDynamicHeads": { "documentation": "", "keys": { "Default": "@roblox/enum/LoadDynamicHeads.Default", "Disabled": "@roblox/enum/LoadDynamicHeads.Disabled", "Enabled": "@roblox/enum/LoadDynamicHeads.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LoadDynamicHeads", "code_sample": "" }, "@roblox/enum/VRTouchpad.Left": { "documentation": "Left hand touchpad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpad#Left", "code_sample": "" }, "@roblox/enum/VRTouchpad.Right": { "documentation": "Right hand touchpad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpad#Right", "code_sample": "" }, "@roblox/global/Enum.VRTouchpad": { "documentation": "Used to universally identify a VR touchpad that is used by either the left, or right hand.", "keys": { "Left": "@roblox/enum/VRTouchpad.Left", "Right": "@roblox/enum/VRTouchpad.Right" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRTouchpad", "code_sample": "" }, "@roblox/enum/VideoSampleSize.Small": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoSampleSize#Small", "code_sample": "" }, "@roblox/enum/VideoSampleSize.Medium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoSampleSize#Medium", "code_sample": "" }, "@roblox/enum/VideoSampleSize.Large": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoSampleSize#Large", "code_sample": "" }, "@roblox/enum/VideoSampleSize.Full": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoSampleSize#Full", "code_sample": "" }, "@roblox/global/Enum.VideoSampleSize": { "documentation": "The size of textures produced by VideoSampler.", "keys": { "Small": "@roblox/enum/VideoSampleSize.Small", "Medium": "@roblox/enum/VideoSampleSize.Medium", "Large": "@roblox/enum/VideoSampleSize.Large", "Full": "@roblox/enum/VideoSampleSize.Full" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoSampleSize", "code_sample": "" }, "@roblox/enum/FacialAnimationStreamingState.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#None", "code_sample": "" }, "@roblox/enum/FacialAnimationStreamingState.Audio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Audio", "code_sample": "" }, "@roblox/enum/FacialAnimationStreamingState.Video": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Video", "code_sample": "" }, "@roblox/enum/FacialAnimationStreamingState.Place": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Place", "code_sample": "" }, "@roblox/enum/FacialAnimationStreamingState.Server": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState#Server", "code_sample": "" }, "@roblox/global/Enum.FacialAnimationStreamingState": { "documentation": "", "keys": { "None": "@roblox/enum/FacialAnimationStreamingState.None", "Audio": "@roblox/enum/FacialAnimationStreamingState.Audio", "Video": "@roblox/enum/FacialAnimationStreamingState.Video", "Place": "@roblox/enum/FacialAnimationStreamingState.Place", "Server": "@roblox/enum/FacialAnimationStreamingState.Server" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAnimationStreamingState", "code_sample": "" }, "@roblox/enum/AvatarThumbnailCustomizationType.Closeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarThumbnailCustomizationType#Closeup", "code_sample": "" }, "@roblox/enum/AvatarThumbnailCustomizationType.FullBody": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarThumbnailCustomizationType#FullBody", "code_sample": "" }, "@roblox/global/Enum.AvatarThumbnailCustomizationType": { "documentation": "", "keys": { "Closeup": "@roblox/enum/AvatarThumbnailCustomizationType.Closeup", "FullBody": "@roblox/enum/AvatarThumbnailCustomizationType.FullBody" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarThumbnailCustomizationType", "code_sample": "" }, "@roblox/enum/SafeAreaCompatibility.None": { "documentation": "Do not apply compatibility transformations to any descendants of the ScreenGui.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SafeAreaCompatibility#None", "code_sample": "" }, "@roblox/enum/SafeAreaCompatibility.FullscreenExtension": { "documentation": "If the total area of any descendant GuiObject within the ScreenGui (including any applied border or UIStroke) covers the device's safe area both horizontally and vertically, its background area will be expanded to cover the fullscreen area. This expansion does not affect the size or position of the descendant's content, except in the case of ImageLabel, ImageButton, or VideoFrame where the image/video is considered part of the background and will be expanded to fullscreen. Note that this option is intended to automatically improve the appearance of UI that was authored for screens without any cutouts. However, it's recommended that you avoid fullscreen extensions for new work; instead, use the ScreenInsets property to specify which insets should be respected for different ScreenGuis.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SafeAreaCompatibility#FullscreenExtension", "code_sample": "" }, "@roblox/global/Enum.SafeAreaCompatibility": { "documentation": "Describes how descendants of a ScreenGui adapt to screens with cutouts.", "keys": { "None": "@roblox/enum/SafeAreaCompatibility.None", "FullscreenExtension": "@roblox/enum/SafeAreaCompatibility.FullscreenExtension" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SafeAreaCompatibility", "code_sample": "" }, "@roblox/enum/AppShellActionType.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#None", "code_sample": "" }, "@roblox/enum/AppShellActionType.OpenApp": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#OpenApp", "code_sample": "" }, "@roblox/enum/AppShellActionType.TapChatTab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapChatTab", "code_sample": "" }, "@roblox/enum/AppShellActionType.TapConversationEntry": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapConversationEntry", "code_sample": "" }, "@roblox/enum/AppShellActionType.TapAvatarTab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapAvatarTab", "code_sample": "" }, "@roblox/enum/AppShellActionType.ReadConversation": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#ReadConversation", "code_sample": "" }, "@roblox/enum/AppShellActionType.TapGamePageTab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapGamePageTab", "code_sample": "" }, "@roblox/enum/AppShellActionType.TapHomePageTab": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#TapHomePageTab", "code_sample": "" }, "@roblox/enum/AppShellActionType.GamePageLoaded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#GamePageLoaded", "code_sample": "" }, "@roblox/enum/AppShellActionType.HomePageLoaded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#HomePageLoaded", "code_sample": "" }, "@roblox/enum/AppShellActionType.AvatarEditorPageLoaded": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType#AvatarEditorPageLoaded", "code_sample": "" }, "@roblox/global/Enum.AppShellActionType": { "documentation": "", "keys": { "None": "@roblox/enum/AppShellActionType.None", "OpenApp": "@roblox/enum/AppShellActionType.OpenApp", "TapChatTab": "@roblox/enum/AppShellActionType.TapChatTab", "TapConversationEntry": "@roblox/enum/AppShellActionType.TapConversationEntry", "TapAvatarTab": "@roblox/enum/AppShellActionType.TapAvatarTab", "ReadConversation": "@roblox/enum/AppShellActionType.ReadConversation", "TapGamePageTab": "@roblox/enum/AppShellActionType.TapGamePageTab", "TapHomePageTab": "@roblox/enum/AppShellActionType.TapHomePageTab", "GamePageLoaded": "@roblox/enum/AppShellActionType.GamePageLoaded", "HomePageLoaded": "@roblox/enum/AppShellActionType.HomePageLoaded", "AvatarEditorPageLoaded": "@roblox/enum/AppShellActionType.AvatarEditorPageLoaded" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AppShellActionType", "code_sample": "" }, "@roblox/enum/ModelLevelOfDetail.Automatic": { "documentation": "Default behavior, currently equivalent to Disabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelLevelOfDetail#Automatic", "code_sample": "" }, "@roblox/enum/ModelLevelOfDetail.StreamingMesh": { "documentation": "A lower resolution \"imposter\" mesh (colored, coarse mesh that wraps around all child parts of the model) renders outside the streaming radius.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelLevelOfDetail#StreamingMesh", "code_sample": "" }, "@roblox/enum/ModelLevelOfDetail.Disabled": { "documentation": "A lower resolution mesh will not be displayed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelLevelOfDetail#Disabled", "code_sample": "" }, "@roblox/enum/ModelLevelOfDetail.SLIM": { "documentation": "A Scalable Lightweight Interactive Model, or SLIM, model (a composite of all child parts of the model) renders at progressively lower resolutions at distances based on the streaming radius. Greatly improves visual quality over StreamingMesh.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelLevelOfDetail#SLIM", "code_sample": "" }, "@roblox/global/Enum.ModelLevelOfDetail": { "documentation": "Controls the level of detail for Models in experiences with instance streaming enabled.", "keys": { "Automatic": "@roblox/enum/ModelLevelOfDetail.Automatic", "StreamingMesh": "@roblox/enum/ModelLevelOfDetail.StreamingMesh", "Disabled": "@roblox/enum/ModelLevelOfDetail.Disabled", "SLIM": "@roblox/enum/ModelLevelOfDetail.SLIM" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelLevelOfDetail", "code_sample": "" }, "@roblox/enum/AutomaticSize.None": { "documentation": "Default sizing behavior.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#None", "code_sample": "" }, "@roblox/enum/AutomaticSize.X": { "documentation": "Automatically resize element along X-axis to fit child contents.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#X", "code_sample": "" }, "@roblox/enum/AutomaticSize.Y": { "documentation": "Automatically resize element along Y-axis to fit child contents. Text Objects will only resize along the Y-axis if TextWrapped is enabled.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#Y", "code_sample": "" }, "@roblox/enum/AutomaticSize.XY": { "documentation": "Automatically resize element along X and Y axes to fit child contents.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutomaticSize#XY", "code_sample": "" }, "@roblox/global/Enum.AutomaticSize": { "documentation": "UI objects with AutomaticSize enabled will increase in size up to maximum size allowed by the parent (if there is one) and no smaller than the Size property bounds.", "keys": { "None": "@roblox/enum/AutomaticSize.None", "X": "@roblox/enum/AutomaticSize.X", "Y": "@roblox/enum/AutomaticSize.Y", "XY": "@roblox/enum/AutomaticSize.XY" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AutomaticSize", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Mono": { "documentation": "Monaural audio streams contain only one Center channel. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Mono", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Stereo": { "documentation": "Stereophonic audio streams consist of two channels: Left and Right. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Stereo", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Quad": { "documentation": "Quadrophonic audio streams consist of four channels: Left, Right, BackLeft, and BackRight. Quadrophonic streams can encode forward/backward spatial information that stereo streams might struggle with. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Quad", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Surround_5": { "documentation": "Surround sound audio streams consist of five channels: Left, Right, Center, BackLeft, and BackRight. Surround sound streams encode spatial information with better resolution front and center. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_5", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Surround_5_1": { "documentation": "5.1 surround sound consists of six channels: Left, Right, Center, BackLeft, BackRight, and a Sub (subsonic) low‑frequency channel. 5.1 surround sound benefits from low frequencies being less directional in order to encode higher resolution spatial information versus simple 5‑channel surround sound. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_5_1", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Surround_7_1": { "documentation": "7.1 surround sound consists of eight channels: Left, Right, Center, SurroundLeft, SurroundRight, BackLeft, BackRight, and a Sub (subsonic) low‑frequency channel. 7.1 surround sound is an improvement over 5.1 surround sound, offering better spatial resolution directly to the left and right as well. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_7_1", "code_sample": "" }, "@roblox/enum/AudioChannelLayout.Surround_7_1_4": { "documentation": "7.1.4 surround sound consists of twelve channels: Left, Right, Center, SurroundLeft, SurroundRight, BackLeft, BackRight, Sub, TopLeft, TopRight, TopBackLeft, and TopBackRight. 7.1.4 is the only currently supported channel layout that encodes height information. \"Diagram", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout#Surround_7_1_4", "code_sample": "" }, "@roblox/global/Enum.AudioChannelLayout": { "documentation": "Describes the channel layout of an audio stream.", "keys": { "Mono": "@roblox/enum/AudioChannelLayout.Mono", "Stereo": "@roblox/enum/AudioChannelLayout.Stereo", "Quad": "@roblox/enum/AudioChannelLayout.Quad", "Surround_5": "@roblox/enum/AudioChannelLayout.Surround_5", "Surround_5_1": "@roblox/enum/AudioChannelLayout.Surround_5_1", "Surround_7_1": "@roblox/enum/AudioChannelLayout.Surround_7_1", "Surround_7_1_4": "@roblox/enum/AudioChannelLayout.Surround_7_1_4" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AudioChannelLayout", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.ConsentAccepted": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#ConsentAccepted", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.InvalidScopes": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#InvalidScopes", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.Timeout": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#Timeout", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.NoUserInput": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#NoUserInput", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.BackendError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#BackendError", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.UnexpectedError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#UnexpectedError", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.InvalidArgument": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#InvalidArgument", "code_sample": "" }, "@roblox/enum/ScopeCheckResult.ConsentDenied": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult#ConsentDenied", "code_sample": "" }, "@roblox/global/Enum.ScopeCheckResult": { "documentation": "", "keys": { "ConsentAccepted": "@roblox/enum/ScopeCheckResult.ConsentAccepted", "InvalidScopes": "@roblox/enum/ScopeCheckResult.InvalidScopes", "Timeout": "@roblox/enum/ScopeCheckResult.Timeout", "NoUserInput": "@roblox/enum/ScopeCheckResult.NoUserInput", "BackendError": "@roblox/enum/ScopeCheckResult.BackendError", "UnexpectedError": "@roblox/enum/ScopeCheckResult.UnexpectedError", "InvalidArgument": "@roblox/enum/ScopeCheckResult.InvalidArgument", "ConsentDenied": "@roblox/enum/ScopeCheckResult.ConsentDenied" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ScopeCheckResult", "code_sample": "" }, "@roblox/enum/ChatVersion.LegacyChatService": { "documentation": "Enables the legacy chat system.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatVersion#LegacyChatService", "code_sample": "" }, "@roblox/enum/ChatVersion.TextChatService": { "documentation": "Enables TextChatService chat and prevents legacy chat system behavior.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatVersion#TextChatService", "code_sample": "" }, "@roblox/global/Enum.ChatVersion": { "documentation": "Determines whether TextChatService should be fully enabled or to allow the legacy system.", "keys": { "LegacyChatService": "@roblox/enum/ChatVersion.LegacyChatService", "TextChatService": "@roblox/enum/ChatVersion.TextChatService" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatVersion", "code_sample": "" }, "@roblox/enum/RuntimeUndoBehavior.Aggregate": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RuntimeUndoBehavior#Aggregate", "code_sample": "" }, "@roblox/enum/RuntimeUndoBehavior.Snapshot": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RuntimeUndoBehavior#Snapshot", "code_sample": "" }, "@roblox/enum/RuntimeUndoBehavior.Hybrid": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RuntimeUndoBehavior#Hybrid", "code_sample": "" }, "@roblox/global/Enum.RuntimeUndoBehavior": { "documentation": "", "keys": { "Aggregate": "@roblox/enum/RuntimeUndoBehavior.Aggregate", "Snapshot": "@roblox/enum/RuntimeUndoBehavior.Snapshot", "Hybrid": "@roblox/enum/RuntimeUndoBehavior.Hybrid" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RuntimeUndoBehavior", "code_sample": "" }, "@roblox/enum/InputActionType.Bool": { "documentation": "The InputAction will receive boolean values from button inputs, for example true/false on press/release from inputs such as KeyCode.ButtonA or KeyCode.E. This setting also exposes the UIButton property on child InputBindings, allowing you to easily hook up press or release of a GuiButton for the action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputActionType#Bool", "code_sample": "" }, "@roblox/enum/InputActionType.Direction1D": { "documentation": "The InputAction will receive numerical values, generally from analog gamepad triggers such as KeyCode.ButtonL2 or KeyCode.ButtonR2. This setting also exposes the Up and Down properties on child InputBindings, allowing for boolean inputs or \"1D\" inputs as composite directions for the action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction1D", "code_sample": "" }, "@roblox/enum/InputActionType.Direction2D": { "documentation": "The InputAction will receive Vector2 values, generally from thumbstick inputs such as KeyCode.Thumbstick1 and KeyCode.Thumbstick2. This setting also exposes the Up, Down, Left, and Right properties on child InputBindings, allowing for \"2D\" inputs as composite directions for the action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction2D", "code_sample": "" }, "@roblox/enum/InputActionType.Direction3D": { "documentation": "The InputAction will receive Vector3 values from inputs assigned to the Up, Down, Left, Right, Forward, and/or Backward properties on child InputBindings, allowing for \"3D\" inputs as composite directions for the action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputActionType#Direction3D", "code_sample": "" }, "@roblox/enum/InputActionType.ViewportPosition": { "documentation": "The InputAction will receive Vector2 values representing the absolute pixel (X, Y) coordinates of a pointer input in the viewport.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputActionType#ViewportPosition", "code_sample": "" }, "@roblox/global/Enum.InputActionType": { "documentation": "This enum is used by InputAction.Type to determine which input data type the InputAction will receive.", "keys": { "Bool": "@roblox/enum/InputActionType.Bool", "Direction1D": "@roblox/enum/InputActionType.Direction1D", "Direction2D": "@roblox/enum/InputActionType.Direction2D", "Direction3D": "@roblox/enum/InputActionType.Direction3D", "ViewportPosition": "@roblox/enum/InputActionType.ViewportPosition" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InputActionType", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyFlowType.Sink": { "documentation": "Currency is being removed from the player's account.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyFlowType#Sink", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyFlowType.Source": { "documentation": "Currency is being added to the player's account.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyFlowType#Source", "code_sample": "" }, "@roblox/global/Enum.AnalyticsEconomyFlowType": { "documentation": "", "keys": { "Sink": "@roblox/enum/AnalyticsEconomyFlowType.Sink", "Source": "@roblox/enum/AnalyticsEconomyFlowType.Source" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyFlowType", "code_sample": "" }, "@roblox/enum/TeleportResult.Success": { "documentation": "The teleport was successful.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#Success", "code_sample": "" }, "@roblox/enum/TeleportResult.Failure": { "documentation": "The teleport failed for an unknown reason.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#Failure", "code_sample": "" }, "@roblox/enum/TeleportResult.GameNotFound": { "documentation": "The game that this player attempted to teleport to could not be found.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#GameNotFound", "code_sample": "" }, "@roblox/enum/TeleportResult.GameEnded": { "documentation": "The game that this player attempted to teleport to has ended.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#GameEnded", "code_sample": "" }, "@roblox/enum/TeleportResult.GameFull": { "documentation": "The game that this player attempted to teleport to is full.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#GameFull", "code_sample": "" }, "@roblox/enum/TeleportResult.Unauthorized": { "documentation": "The player is not authorized to complete this teleport.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#Unauthorized", "code_sample": "" }, "@roblox/enum/TeleportResult.Flooded": { "documentation": "Too many teleport requests have been made recently.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#Flooded", "code_sample": "" }, "@roblox/enum/TeleportResult.IsTeleporting": { "documentation": "The player is currently being teleported.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult#IsTeleporting", "code_sample": "" }, "@roblox/global/Enum.TeleportResult": { "documentation": "Describes the result of a teleport.", "keys": { "Success": "@roblox/enum/TeleportResult.Success", "Failure": "@roblox/enum/TeleportResult.Failure", "GameNotFound": "@roblox/enum/TeleportResult.GameNotFound", "GameEnded": "@roblox/enum/TeleportResult.GameEnded", "GameFull": "@roblox/enum/TeleportResult.GameFull", "Unauthorized": "@roblox/enum/TeleportResult.Unauthorized", "Flooded": "@roblox/enum/TeleportResult.Flooded", "IsTeleporting": "@roblox/enum/TeleportResult.IsTeleporting" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TeleportResult", "code_sample": "" }, "@roblox/enum/RolloutState.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RolloutState#Default", "code_sample": "" }, "@roblox/enum/RolloutState.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RolloutState#Disabled", "code_sample": "" }, "@roblox/enum/RolloutState.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RolloutState#Enabled", "code_sample": "" }, "@roblox/global/Enum.RolloutState": { "documentation": "", "keys": { "Default": "@roblox/enum/RolloutState.Default", "Disabled": "@roblox/enum/RolloutState.Disabled", "Enabled": "@roblox/enum/RolloutState.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RolloutState", "code_sample": "" }, "@roblox/enum/TweenStatus.Canceled": { "documentation": "The tween was cancelled before completion.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TweenStatus#Canceled", "code_sample": "" }, "@roblox/enum/TweenStatus.Completed": { "documentation": "The Tween has successfully completed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TweenStatus#Completed", "code_sample": "" }, "@roblox/global/Enum.TweenStatus": { "documentation": "The completion status of a GuiObject tween function.", "keys": { "Canceled": "@roblox/enum/TweenStatus.Canceled", "Completed": "@roblox/enum/TweenStatus.Completed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/TweenStatus", "code_sample": "" }, "@roblox/enum/ExperienceEventStatus.Active": { "documentation": "The event is currently published and available.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Active", "code_sample": "" }, "@roblox/enum/ExperienceEventStatus.Cancelled": { "documentation": "The event has been cancelled and will not occur.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Cancelled", "code_sample": "" }, "@roblox/enum/ExperienceEventStatus.Moderated": { "documentation": "The event has been removed by moderation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Moderated", "code_sample": "" }, "@roblox/enum/ExperienceEventStatus.Unpublished": { "documentation": "The event has been unpublished by the creator.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Unpublished", "code_sample": "" }, "@roblox/enum/ExperienceEventStatus.Unknown": { "documentation": "The event status could not be determined.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus#Unknown", "code_sample": "" }, "@roblox/global/Enum.ExperienceEventStatus": { "documentation": "", "keys": { "Active": "@roblox/enum/ExperienceEventStatus.Active", "Cancelled": "@roblox/enum/ExperienceEventStatus.Cancelled", "Moderated": "@roblox/enum/ExperienceEventStatus.Moderated", "Unpublished": "@roblox/enum/ExperienceEventStatus.Unpublished", "Unknown": "@roblox/enum/ExperienceEventStatus.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ExperienceEventStatus", "code_sample": "" }, "@roblox/enum/AvatarAssetType.TShirt": { "documentation": "A classic 2D TShirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#TShirt", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Hat": { "documentation": "A hat.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Hat", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Shirt": { "documentation": "A classic 2D shirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Shirt", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Pants": { "documentation": "A classic 2D pants.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Pants", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Head": { "documentation": "A head.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Head", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Face": { "documentation": "A face.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Face", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Gear": { "documentation": "A gear.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Gear", "code_sample": "" }, "@roblox/enum/AvatarAssetType.Torso": { "documentation": "A torso.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#Torso", "code_sample": "" }, "@roblox/enum/AvatarAssetType.RightArm": { "documentation": "A right arm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RightArm", "code_sample": "" }, "@roblox/enum/AvatarAssetType.LeftArm": { "documentation": "A left arm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LeftArm", "code_sample": "" }, "@roblox/enum/AvatarAssetType.LeftLeg": { "documentation": "A left leg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LeftLeg", "code_sample": "" }, "@roblox/enum/AvatarAssetType.RightLeg": { "documentation": "A right leg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RightLeg", "code_sample": "" }, "@roblox/enum/AvatarAssetType.HairAccessory": { "documentation": "A hair accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#HairAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.FaceAccessory": { "documentation": "A face accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FaceAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.NeckAccessory": { "documentation": "A neck accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#NeckAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.ShoulderAccessory": { "documentation": "A shoulder accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ShoulderAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.FrontAccessory": { "documentation": "A front accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FrontAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.BackAccessory": { "documentation": "A back accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#BackAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.WaistAccessory": { "documentation": "A waist accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#WaistAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.ClimbAnimation": { "documentation": "A climb animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ClimbAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.FallAnimation": { "documentation": "A fall animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FallAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.IdleAnimation": { "documentation": "An idle animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#IdleAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.JumpAnimation": { "documentation": "A jump animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#JumpAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.RunAnimation": { "documentation": "A run animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RunAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.SwimAnimation": { "documentation": "A swim animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#SwimAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.WalkAnimation": { "documentation": "A walk animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#WalkAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.EmoteAnimation": { "documentation": "An emote animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EmoteAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.TShirtAccessory": { "documentation": "A layered clothing TShirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#TShirtAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.ShirtAccessory": { "documentation": "A layered clothing shirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ShirtAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.PantsAccessory": { "documentation": "A layered clothing pants.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#PantsAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.JacketAccessory": { "documentation": "A layered clothing jacket.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#JacketAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.SweaterAccessory": { "documentation": "A layered clothing sweater.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#SweaterAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.ShortsAccessory": { "documentation": "A layered clothing shorts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#ShortsAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.LeftShoeAccessory": { "documentation": "A layered clothing left shoe.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LeftShoeAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.RightShoeAccessory": { "documentation": "A layered clothing right shoe.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#RightShoeAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.DressSkirtAccessory": { "documentation": "A layered clothing dress or skirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#DressSkirtAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.EyebrowAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyebrowAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.EyelashAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyelashAccessory", "code_sample": "" }, "@roblox/enum/AvatarAssetType.MoodAnimation": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#MoodAnimation", "code_sample": "" }, "@roblox/enum/AvatarAssetType.DynamicHead": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#DynamicHead", "code_sample": "" }, "@roblox/enum/AvatarAssetType.FaceMakeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#FaceMakeup", "code_sample": "" }, "@roblox/enum/AvatarAssetType.LipMakeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#LipMakeup", "code_sample": "" }, "@roblox/enum/AvatarAssetType.EyeMakeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType#EyeMakeup", "code_sample": "" }, "@roblox/global/Enum.AvatarAssetType": { "documentation": "Describes the asset types that an avatar can equip.", "keys": { "TShirt": "@roblox/enum/AvatarAssetType.TShirt", "Hat": "@roblox/enum/AvatarAssetType.Hat", "Shirt": "@roblox/enum/AvatarAssetType.Shirt", "Pants": "@roblox/enum/AvatarAssetType.Pants", "Head": "@roblox/enum/AvatarAssetType.Head", "Face": "@roblox/enum/AvatarAssetType.Face", "Gear": "@roblox/enum/AvatarAssetType.Gear", "Torso": "@roblox/enum/AvatarAssetType.Torso", "RightArm": "@roblox/enum/AvatarAssetType.RightArm", "LeftArm": "@roblox/enum/AvatarAssetType.LeftArm", "LeftLeg": "@roblox/enum/AvatarAssetType.LeftLeg", "RightLeg": "@roblox/enum/AvatarAssetType.RightLeg", "HairAccessory": "@roblox/enum/AvatarAssetType.HairAccessory", "FaceAccessory": "@roblox/enum/AvatarAssetType.FaceAccessory", "NeckAccessory": "@roblox/enum/AvatarAssetType.NeckAccessory", "ShoulderAccessory": "@roblox/enum/AvatarAssetType.ShoulderAccessory", "FrontAccessory": "@roblox/enum/AvatarAssetType.FrontAccessory", "BackAccessory": "@roblox/enum/AvatarAssetType.BackAccessory", "WaistAccessory": "@roblox/enum/AvatarAssetType.WaistAccessory", "ClimbAnimation": "@roblox/enum/AvatarAssetType.ClimbAnimation", "FallAnimation": "@roblox/enum/AvatarAssetType.FallAnimation", "IdleAnimation": "@roblox/enum/AvatarAssetType.IdleAnimation", "JumpAnimation": "@roblox/enum/AvatarAssetType.JumpAnimation", "RunAnimation": "@roblox/enum/AvatarAssetType.RunAnimation", "SwimAnimation": "@roblox/enum/AvatarAssetType.SwimAnimation", "WalkAnimation": "@roblox/enum/AvatarAssetType.WalkAnimation", "EmoteAnimation": "@roblox/enum/AvatarAssetType.EmoteAnimation", "TShirtAccessory": "@roblox/enum/AvatarAssetType.TShirtAccessory", "ShirtAccessory": "@roblox/enum/AvatarAssetType.ShirtAccessory", "PantsAccessory": "@roblox/enum/AvatarAssetType.PantsAccessory", "JacketAccessory": "@roblox/enum/AvatarAssetType.JacketAccessory", "SweaterAccessory": "@roblox/enum/AvatarAssetType.SweaterAccessory", "ShortsAccessory": "@roblox/enum/AvatarAssetType.ShortsAccessory", "LeftShoeAccessory": "@roblox/enum/AvatarAssetType.LeftShoeAccessory", "RightShoeAccessory": "@roblox/enum/AvatarAssetType.RightShoeAccessory", "DressSkirtAccessory": "@roblox/enum/AvatarAssetType.DressSkirtAccessory", "EyebrowAccessory": "@roblox/enum/AvatarAssetType.EyebrowAccessory", "EyelashAccessory": "@roblox/enum/AvatarAssetType.EyelashAccessory", "MoodAnimation": "@roblox/enum/AvatarAssetType.MoodAnimation", "DynamicHead": "@roblox/enum/AvatarAssetType.DynamicHead", "FaceMakeup": "@roblox/enum/AvatarAssetType.FaceMakeup", "LipMakeup": "@roblox/enum/AvatarAssetType.LipMakeup", "EyeMakeup": "@roblox/enum/AvatarAssetType.EyeMakeup" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarAssetType", "code_sample": "" }, "@roblox/enum/SubscriptionExpirationReason.ProductInactive": { "documentation": "Subscription product is inactive.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason#ProductInactive", "code_sample": "" }, "@roblox/enum/SubscriptionExpirationReason.ProductDeleted": { "documentation": "Subscription product has been deleted.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason#ProductDeleted", "code_sample": "" }, "@roblox/enum/SubscriptionExpirationReason.SubscriberCancelled": { "documentation": "Subscriber has cancelled the subscription.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason#SubscriberCancelled", "code_sample": "" }, "@roblox/enum/SubscriptionExpirationReason.SubscriberRefunded": { "documentation": "Subscriber has been refunded.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason#SubscriberRefunded", "code_sample": "" }, "@roblox/enum/SubscriptionExpirationReason.Lapsed": { "documentation": "Subscription has lapsed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason#Lapsed", "code_sample": "" }, "@roblox/global/Enum.SubscriptionExpirationReason": { "documentation": "", "keys": { "ProductInactive": "@roblox/enum/SubscriptionExpirationReason.ProductInactive", "ProductDeleted": "@roblox/enum/SubscriptionExpirationReason.ProductDeleted", "SubscriberCancelled": "@roblox/enum/SubscriptionExpirationReason.SubscriberCancelled", "SubscriberRefunded": "@roblox/enum/SubscriptionExpirationReason.SubscriberRefunded", "Lapsed": "@roblox/enum/SubscriptionExpirationReason.Lapsed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SubscriptionExpirationReason", "code_sample": "" }, "@roblox/enum/LexemeType.Eof": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Eof", "code_sample": "" }, "@roblox/enum/LexemeType.Name": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Name", "code_sample": "" }, "@roblox/enum/LexemeType.QuotedString": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#QuotedString", "code_sample": "" }, "@roblox/enum/LexemeType.Number": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Number", "code_sample": "" }, "@roblox/enum/LexemeType.And": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#And", "code_sample": "" }, "@roblox/enum/LexemeType.Or": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Or", "code_sample": "" }, "@roblox/enum/LexemeType.Equal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Equal", "code_sample": "" }, "@roblox/enum/LexemeType.TildeEqual": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#TildeEqual", "code_sample": "" }, "@roblox/enum/LexemeType.GreaterThan": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#GreaterThan", "code_sample": "" }, "@roblox/enum/LexemeType.GreaterThanEqual": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#GreaterThanEqual", "code_sample": "" }, "@roblox/enum/LexemeType.LessThan": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#LessThan", "code_sample": "" }, "@roblox/enum/LexemeType.LessThanEqual": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#LessThanEqual", "code_sample": "" }, "@roblox/enum/LexemeType.Colon": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Colon", "code_sample": "" }, "@roblox/enum/LexemeType.Dot": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Dot", "code_sample": "" }, "@roblox/enum/LexemeType.LeftParenthesis": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#LeftParenthesis", "code_sample": "" }, "@roblox/enum/LexemeType.RightParenthesis": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#RightParenthesis", "code_sample": "" }, "@roblox/enum/LexemeType.Star": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#Star", "code_sample": "" }, "@roblox/enum/LexemeType.DoubleStar": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#DoubleStar", "code_sample": "" }, "@roblox/enum/LexemeType.ReservedSpecial": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType#ReservedSpecial", "code_sample": "" }, "@roblox/global/Enum.LexemeType": { "documentation": "", "keys": { "Eof": "@roblox/enum/LexemeType.Eof", "Name": "@roblox/enum/LexemeType.Name", "QuotedString": "@roblox/enum/LexemeType.QuotedString", "Number": "@roblox/enum/LexemeType.Number", "And": "@roblox/enum/LexemeType.And", "Or": "@roblox/enum/LexemeType.Or", "Equal": "@roblox/enum/LexemeType.Equal", "TildeEqual": "@roblox/enum/LexemeType.TildeEqual", "GreaterThan": "@roblox/enum/LexemeType.GreaterThan", "GreaterThanEqual": "@roblox/enum/LexemeType.GreaterThanEqual", "LessThan": "@roblox/enum/LexemeType.LessThan", "LessThanEqual": "@roblox/enum/LexemeType.LessThanEqual", "Colon": "@roblox/enum/LexemeType.Colon", "Dot": "@roblox/enum/LexemeType.Dot", "LeftParenthesis": "@roblox/enum/LexemeType.LeftParenthesis", "RightParenthesis": "@roblox/enum/LexemeType.RightParenthesis", "Star": "@roblox/enum/LexemeType.Star", "DoubleStar": "@roblox/enum/LexemeType.DoubleStar", "ReservedSpecial": "@roblox/enum/LexemeType.ReservedSpecial" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/LexemeType", "code_sample": "" }, "@roblox/enum/SurfaceGuiShape.Flat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceGuiShape#Flat", "code_sample": "" }, "@roblox/enum/SurfaceGuiShape.CurvedHorizontally": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceGuiShape#CurvedHorizontally", "code_sample": "" }, "@roblox/global/Enum.SurfaceGuiShape": { "documentation": "", "keys": { "Flat": "@roblox/enum/SurfaceGuiShape.Flat", "CurvedHorizontally": "@roblox/enum/SurfaceGuiShape.CurvedHorizontally" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SurfaceGuiShape", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#None", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UniverseAudio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UniverseAudio", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UniverseVideo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UniverseVideo", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.PlaceAudio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#PlaceAudio", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.PlaceVideo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#PlaceVideo", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UserAudioEligible": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserAudioEligible", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UserAudio": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserAudio", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UserVideoEligible": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserVideoEligible", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UserVideo": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserVideo", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UserBanned": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserBanned", "code_sample": "" }, "@roblox/enum/AvatarChatServiceFeature.UserVerifiedForVoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature#UserVerifiedForVoice", "code_sample": "" }, "@roblox/global/Enum.AvatarChatServiceFeature": { "documentation": "", "keys": { "None": "@roblox/enum/AvatarChatServiceFeature.None", "UniverseAudio": "@roblox/enum/AvatarChatServiceFeature.UniverseAudio", "UniverseVideo": "@roblox/enum/AvatarChatServiceFeature.UniverseVideo", "PlaceAudio": "@roblox/enum/AvatarChatServiceFeature.PlaceAudio", "PlaceVideo": "@roblox/enum/AvatarChatServiceFeature.PlaceVideo", "UserAudioEligible": "@roblox/enum/AvatarChatServiceFeature.UserAudioEligible", "UserAudio": "@roblox/enum/AvatarChatServiceFeature.UserAudio", "UserVideoEligible": "@roblox/enum/AvatarChatServiceFeature.UserVideoEligible", "UserVideo": "@roblox/enum/AvatarChatServiceFeature.UserVideo", "UserBanned": "@roblox/enum/AvatarChatServiceFeature.UserBanned", "UserVerifiedForVoice": "@roblox/enum/AvatarChatServiceFeature.UserVerifiedForVoice" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarChatServiceFeature", "code_sample": "" }, "@roblox/enum/ProximityPromptExclusivity.OnePerButton": { "documentation": "One prompt will be shown per input KeyCode.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptExclusivity#OnePerButton", "code_sample": "" }, "@roblox/enum/ProximityPromptExclusivity.OneGlobally": { "documentation": "Only one prompt will be shown with this setting.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptExclusivity#OneGlobally", "code_sample": "" }, "@roblox/enum/ProximityPromptExclusivity.AlwaysShow": { "documentation": "This prompt will always show when in range and visible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptExclusivity#AlwaysShow", "code_sample": "" }, "@roblox/global/Enum.ProximityPromptExclusivity": { "documentation": "", "keys": { "OnePerButton": "@roblox/enum/ProximityPromptExclusivity.OnePerButton", "OneGlobally": "@roblox/enum/ProximityPromptExclusivity.OneGlobally", "AlwaysShow": "@roblox/enum/ProximityPromptExclusivity.AlwaysShow" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptExclusivity", "code_sample": "" }, "@roblox/enum/ModelStreamingMode.Default": { "documentation": "Engine determines best behavior. Currently equivalent to Nonatomic.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#Default", "code_sample": "" }, "@roblox/enum/ModelStreamingMode.Atomic": { "documentation": "The Model and all of its descendants are streamed in/out together. For streaming in, this applies when any descendant BasePart is eligible for streaming in. For streaming out, this applies when all descendant BaseParts are eligible for streaming out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#Atomic", "code_sample": "" }, "@roblox/enum/ModelStreamingMode.Persistent": { "documentation": "Persistent models are sent as a complete atomic unit soon after the player joins and before the Workspace.PersistentLoaded event fires. Persistent models and their descendants are never streamed out.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#Persistent", "code_sample": "" }, "@roblox/enum/ModelStreamingMode.PersistentPerPlayer": { "documentation": "Behaves as a persistent model for players that have been added using Model:AddPersistentPlayer(). For other players, behavior is the same as Atomic. You can revert a model from player persistence via Model:RemovePersistentPlayer().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#PersistentPerPlayer", "code_sample": "" }, "@roblox/enum/ModelStreamingMode.Nonatomic": { "documentation": "When a nonatomic model is streamed, descendants are also sent, except for part descendants. Nonatomic models that are not descendants of parts are sent during experience loading.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#Nonatomic", "code_sample": "" }, "@roblox/global/Enum.ModelStreamingMode": { "documentation": "Controls stream in and out behavior of a model.", "keys": { "Default": "@roblox/enum/ModelStreamingMode.Default", "Atomic": "@roblox/enum/ModelStreamingMode.Atomic", "Persistent": "@roblox/enum/ModelStreamingMode.Persistent", "PersistentPerPlayer": "@roblox/enum/ModelStreamingMode.PersistentPerPlayer", "Nonatomic": "@roblox/enum/ModelStreamingMode.Nonatomic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode", "code_sample": "" }, "@roblox/enum/BundleType.BodyParts": { "documentation": "A bundle of body parts and accessories.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BundleType#BodyParts", "code_sample": "" }, "@roblox/enum/BundleType.Animations": { "documentation": "A bundle of just animations.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BundleType#Animations", "code_sample": "" }, "@roblox/enum/BundleType.Shoes": { "documentation": "A bundle of left shoe and right shoe.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BundleType#Shoes", "code_sample": "" }, "@roblox/enum/BundleType.DynamicHead": { "documentation": "A bundle consisting of dynamicHead and moodAnimation assets, optionally with eyebrowAccessory and eyelashAccessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BundleType#DynamicHead", "code_sample": "" }, "@roblox/enum/BundleType.DynamicHeadAvatar": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BundleType#DynamicHeadAvatar", "code_sample": "" }, "@roblox/global/Enum.BundleType": { "documentation": "The type of a bundle of assets.", "keys": { "BodyParts": "@roblox/enum/BundleType.BodyParts", "Animations": "@roblox/enum/BundleType.Animations", "Shoes": "@roblox/enum/BundleType.Shoes", "DynamicHead": "@roblox/enum/BundleType.DynamicHead", "DynamicHeadAvatar": "@roblox/enum/BundleType.DynamicHeadAvatar" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/BundleType", "code_sample": "" }, "@roblox/enum/NormalId.Right": { "documentation": "The right face of a Part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId#Right", "code_sample": "" }, "@roblox/enum/NormalId.Top": { "documentation": "The top face of a Part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId#Top", "code_sample": "" }, "@roblox/enum/NormalId.Back": { "documentation": "The back face of a Part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId#Back", "code_sample": "" }, "@roblox/enum/NormalId.Left": { "documentation": "The left face of a Part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId#Left", "code_sample": "" }, "@roblox/enum/NormalId.Bottom": { "documentation": "The bottom face of a Part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId#Bottom", "code_sample": "" }, "@roblox/enum/NormalId.Front": { "documentation": "The front face of a Part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId#Front", "code_sample": "" }, "@roblox/global/Enum.NormalId": { "documentation": "The NormalId Enum sets which side/face of a Part is used.", "keys": { "Right": "@roblox/enum/NormalId.Right", "Top": "@roblox/enum/NormalId.Top", "Back": "@roblox/enum/NormalId.Back", "Left": "@roblox/enum/NormalId.Left", "Bottom": "@roblox/enum/NormalId.Bottom", "Front": "@roblox/enum/NormalId.Front" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NormalId", "code_sample": "" }, "@roblox/enum/DevComputerCameraMovementMode.UserChoice": { "documentation": "The camera will move based on the player's settings.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#UserChoice", "code_sample": "" }, "@roblox/enum/DevComputerCameraMovementMode.Classic": { "documentation": "Camera tracks the player but will not automatically rotate if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#Classic", "code_sample": "" }, "@roblox/enum/DevComputerCameraMovementMode.Follow": { "documentation": "Camera tracks the player and automatically rotates if the player walks left or right.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#Follow", "code_sample": "" }, "@roblox/enum/DevComputerCameraMovementMode.Orbital": { "documentation": "The camera has a fixed Y position, but can be rotated around the player.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#Orbital", "code_sample": "" }, "@roblox/enum/DevComputerCameraMovementMode.CameraToggle": { "documentation": "The camera toggles between locked and free rotation with the right mouse button.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode#CameraToggle", "code_sample": "" }, "@roblox/global/Enum.DevComputerCameraMovementMode": { "documentation": "Overwrites the player's camera movement mode setting on a computer.", "keys": { "UserChoice": "@roblox/enum/DevComputerCameraMovementMode.UserChoice", "Classic": "@roblox/enum/DevComputerCameraMovementMode.Classic", "Follow": "@roblox/enum/DevComputerCameraMovementMode.Follow", "Orbital": "@roblox/enum/DevComputerCameraMovementMode.Orbital", "CameraToggle": "@roblox/enum/DevComputerCameraMovementMode.CameraToggle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevComputerCameraMovementMode", "code_sample": "" }, "@roblox/enum/DevCameraOcclusionMode.Zoom": { "documentation": "The camera zooms in until there is nothing between it and its subject.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevCameraOcclusionMode#Zoom", "code_sample": "" }, "@roblox/enum/DevCameraOcclusionMode.Invisicam": { "documentation": "Any objects between the camera and its subject become translucent locally.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevCameraOcclusionMode#Invisicam", "code_sample": "" }, "@roblox/global/Enum.DevCameraOcclusionMode": { "documentation": "Determines how the default camera handles objects that are in-between the camera and the camera subject.", "keys": { "Zoom": "@roblox/enum/DevCameraOcclusionMode.Zoom", "Invisicam": "@roblox/enum/DevCameraOcclusionMode.Invisicam" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DevCameraOcclusionMode", "code_sample": "" }, "@roblox/enum/DraggingScrollBar.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar#None", "code_sample": "" }, "@roblox/enum/DraggingScrollBar.Horizontal": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar#Horizontal", "code_sample": "" }, "@roblox/enum/DraggingScrollBar.Vertical": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar#Vertical", "code_sample": "" }, "@roblox/global/Enum.DraggingScrollBar": { "documentation": "", "keys": { "None": "@roblox/enum/DraggingScrollBar.None", "Horizontal": "@roblox/enum/DraggingScrollBar.Horizontal", "Vertical": "@roblox/enum/DraggingScrollBar.Vertical" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DraggingScrollBar", "code_sample": "" }, "@roblox/enum/MaterialPattern.Regular": { "documentation": "Material has ordered pattern, usually man-made, like brick or wood planks.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MaterialPattern#Regular", "code_sample": "" }, "@roblox/enum/MaterialPattern.Organic": { "documentation": "Material pattern has less repetition, like stone or dirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MaterialPattern#Organic", "code_sample": "" }, "@roblox/global/Enum.MaterialPattern": { "documentation": "Describes the pattern of material. Affects texture tiling method.", "keys": { "Regular": "@roblox/enum/MaterialPattern.Regular", "Organic": "@roblox/enum/MaterialPattern.Organic" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/MaterialPattern", "code_sample": "" }, "@roblox/enum/NetworkOwnership.Automatic": { "documentation": "Network ownership is determined automatically by the server.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkOwnership#Automatic", "code_sample": "" }, "@roblox/enum/NetworkOwnership.Manual": { "documentation": "Network ownership is set manually by the developer.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkOwnership#Manual", "code_sample": "" }, "@roblox/enum/NetworkOwnership.OnContact": { "documentation": "The first player to touch a part is given ownership of that part for the server (network). Ownership will not change if another player touches that part unless network ownership has been released by the owner.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkOwnership#OnContact", "code_sample": "" }, "@roblox/global/Enum.NetworkOwnership": { "documentation": "Defines how simulation authority is determined for the Network Ownership Unit/Mechanism this part is attached to.", "keys": { "Automatic": "@roblox/enum/NetworkOwnership.Automatic", "Manual": "@roblox/enum/NetworkOwnership.Manual", "OnContact": "@roblox/enum/NetworkOwnership.OnContact" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/NetworkOwnership", "code_sample": "" }, "@roblox/enum/HumanoidHealthDisplayType.DisplayWhenDamaged": { "documentation": "The humanoid's health bar is only visible when the humanoid is not at full health (assuming MaxHealth is greater than zero).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidHealthDisplayType#DisplayWhenDamaged", "code_sample": "" }, "@roblox/enum/HumanoidHealthDisplayType.AlwaysOn": { "documentation": "The humanoid's health bar is always visible (assuming MaxHealth is greater than zero).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidHealthDisplayType#AlwaysOn", "code_sample": "" }, "@roblox/enum/HumanoidHealthDisplayType.AlwaysOff": { "documentation": "The humanoid's health bar is never visible.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidHealthDisplayType#AlwaysOff", "code_sample": "" }, "@roblox/global/Enum.HumanoidHealthDisplayType": { "documentation": "Controls under what circumstances the Humanoid health bar is displayed.", "keys": { "DisplayWhenDamaged": "@roblox/enum/HumanoidHealthDisplayType.DisplayWhenDamaged", "AlwaysOn": "@roblox/enum/HumanoidHealthDisplayType.AlwaysOn", "AlwaysOff": "@roblox/enum/HumanoidHealthDisplayType.AlwaysOff" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidHealthDisplayType", "code_sample": "" }, "@roblox/enum/ProximityPromptStyle.Default": { "documentation": "The default prompt UI style.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptStyle#Default", "code_sample": "" }, "@roblox/enum/ProximityPromptStyle.Custom": { "documentation": "Custom prompt UI style as set by the developer. For more information, see ProximityPrompt.Style.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptStyle#Custom", "code_sample": "" }, "@roblox/global/Enum.ProximityPromptStyle": { "documentation": "", "keys": { "Default": "@roblox/enum/ProximityPromptStyle.Default", "Custom": "@roblox/enum/ProximityPromptStyle.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ProximityPromptStyle", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyAction.Default": { "documentation": "Default action. Used for an undefined Action.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction#Default", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyAction.Acquire": { "documentation": "Indicates the acquisition of an in game resource. For example, a player acquires virtual currency by completing a specific in game task.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction#Acquire", "code_sample": "" }, "@roblox/enum/AnalyticsEconomyAction.Spend": { "documentation": "Indicates the spending or loss of an in game resource. For example, a player spends virtual currency to acquire a new item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction#Spend", "code_sample": "" }, "@roblox/global/Enum.AnalyticsEconomyAction": { "documentation": "", "keys": { "Default": "@roblox/enum/AnalyticsEconomyAction.Default", "Acquire": "@roblox/enum/AnalyticsEconomyAction.Acquire", "Spend": "@roblox/enum/AnalyticsEconomyAction.Spend" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AnalyticsEconomyAction", "code_sample": "" }, "@roblox/enum/CurrencyType.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CurrencyType#Default", "code_sample": "" }, "@roblox/enum/CurrencyType.Robux": { "documentation": "Use Robux.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CurrencyType#Robux", "code_sample": "" }, "@roblox/enum/CurrencyType.Tix": { "documentation": "Use Tickets.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CurrencyType#Tix", "code_sample": "" }, "@roblox/global/Enum.CurrencyType": { "documentation": "The CurrencyType Enum is used with MarketplaceService to set the currency used.", "keys": { "Default": "@roblox/enum/CurrencyType.Default", "Robux": "@roblox/enum/CurrencyType.Robux", "Tix": "@roblox/enum/CurrencyType.Tix" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CurrencyType", "code_sample": "" }, "@roblox/enum/RestPose.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RestPose#Default", "code_sample": "" }, "@roblox/enum/RestPose.RotationsReset": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RestPose#RotationsReset", "code_sample": "" }, "@roblox/enum/RestPose.Custom": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RestPose#Custom", "code_sample": "" }, "@roblox/global/Enum.RestPose": { "documentation": "", "keys": { "Default": "@roblox/enum/RestPose.Default", "RotationsReset": "@roblox/enum/RestPose.RotationsReset", "Custom": "@roblox/enum/RestPose.Custom" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RestPose", "code_sample": "" }, "@roblox/enum/AvatarSettingsAccessoryLimitMethod.Scale": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#Scale", "code_sample": "" }, "@roblox/enum/AvatarSettingsAccessoryLimitMethod.Remove": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#Remove", "code_sample": "" }, "@roblox/enum/AvatarSettingsAccessoryLimitMethod.PreviewScale": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#PreviewScale", "code_sample": "" }, "@roblox/enum/AvatarSettingsAccessoryLimitMethod.PreviewRemove": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod#PreviewRemove", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsAccessoryLimitMethod": { "documentation": "", "keys": { "Scale": "@roblox/enum/AvatarSettingsAccessoryLimitMethod.Scale", "Remove": "@roblox/enum/AvatarSettingsAccessoryLimitMethod.Remove", "PreviewScale": "@roblox/enum/AvatarSettingsAccessoryLimitMethod.PreviewScale", "PreviewRemove": "@roblox/enum/AvatarSettingsAccessoryLimitMethod.PreviewRemove" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryLimitMethod", "code_sample": "" }, "@roblox/enum/ReplicateInstanceDestroySetting.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReplicateInstanceDestroySetting#Default", "code_sample": "" }, "@roblox/enum/ReplicateInstanceDestroySetting.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReplicateInstanceDestroySetting#Disabled", "code_sample": "" }, "@roblox/enum/ReplicateInstanceDestroySetting.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReplicateInstanceDestroySetting#Enabled", "code_sample": "" }, "@roblox/global/Enum.ReplicateInstanceDestroySetting": { "documentation": "", "keys": { "Default": "@roblox/enum/ReplicateInstanceDestroySetting.Default", "Disabled": "@roblox/enum/ReplicateInstanceDestroySetting.Disabled", "Enabled": "@roblox/enum/ReplicateInstanceDestroySetting.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReplicateInstanceDestroySetting", "code_sample": "" }, "@roblox/enum/CollaboratorStatus.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#None", "code_sample": "" }, "@roblox/enum/CollaboratorStatus.Editing3D": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#Editing3D", "code_sample": "" }, "@roblox/enum/CollaboratorStatus.Scripting": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#Scripting", "code_sample": "" }, "@roblox/enum/CollaboratorStatus.PrivateScripting": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus#PrivateScripting", "code_sample": "" }, "@roblox/global/Enum.CollaboratorStatus": { "documentation": "", "keys": { "None": "@roblox/enum/CollaboratorStatus.None", "Editing3D": "@roblox/enum/CollaboratorStatus.Editing3D", "Scripting": "@roblox/enum/CollaboratorStatus.Scripting", "PrivateScripting": "@roblox/enum/CollaboratorStatus.PrivateScripting" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CollaboratorStatus", "code_sample": "" }, "@roblox/enum/ChatColor.Blue": { "documentation": "Blue chat color.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatColor#Blue", "code_sample": "" }, "@roblox/enum/ChatColor.Green": { "documentation": "Green chat color.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatColor#Green", "code_sample": "" }, "@roblox/enum/ChatColor.Red": { "documentation": "Red chat color.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatColor#Red", "code_sample": "" }, "@roblox/enum/ChatColor.White": { "documentation": "White chat color.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatColor#White", "code_sample": "" }, "@roblox/global/Enum.ChatColor": { "documentation": "Describes the chat color.", "keys": { "Blue": "@roblox/enum/ChatColor.Blue", "Green": "@roblox/enum/ChatColor.Green", "Red": "@roblox/enum/ChatColor.Red", "White": "@roblox/enum/ChatColor.White" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ChatColor", "code_sample": "" }, "@roblox/enum/ListenerType.Camera": { "documentation": "Uses the world CFrame of CurrentCamera.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerType#Camera", "code_sample": "" }, "@roblox/enum/ListenerType.CFrame": { "documentation": "Uses a specified world CFrame.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerType#CFrame", "code_sample": "" }, "@roblox/enum/ListenerType.ObjectPosition": { "documentation": "Uses the world position of an instance and the rotation of CurrentCamera.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerType#ObjectPosition", "code_sample": "" }, "@roblox/enum/ListenerType.ObjectCFrame": { "documentation": "Uses the world CFrame from an instance.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerType#ObjectCFrame", "code_sample": "" }, "@roblox/global/Enum.ListenerType": { "documentation": "Defines where and how the listener is positioned when picking up spatial audio.", "keys": { "Camera": "@roblox/enum/ListenerType.Camera", "CFrame": "@roblox/enum/ListenerType.CFrame", "ObjectPosition": "@roblox/enum/ListenerType.ObjectPosition", "ObjectCFrame": "@roblox/enum/ListenerType.ObjectCFrame" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ListenerType", "code_sample": "" }, "@roblox/enum/FacsActionUnit.ChinRaiserUpperLip": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#ChinRaiserUpperLip", "code_sample": "" }, "@roblox/enum/FacsActionUnit.ChinRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#ChinRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.FlatPucker": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#FlatPucker", "code_sample": "" }, "@roblox/enum/FacsActionUnit.Funneler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#Funneler", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LowerLipSuck": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LowerLipSuck", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LipPresser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LipPresser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LipsTogether": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LipsTogether", "code_sample": "" }, "@roblox/enum/FacsActionUnit.MouthLeft": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#MouthLeft", "code_sample": "" }, "@roblox/enum/FacsActionUnit.MouthRight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#MouthRight", "code_sample": "" }, "@roblox/enum/FacsActionUnit.Pucker": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#Pucker", "code_sample": "" }, "@roblox/enum/FacsActionUnit.UpperLipSuck": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#UpperLipSuck", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftCheekPuff": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftCheekPuff", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftDimpler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftDimpler", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftLipCornerDown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLipCornerDown", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftLowerLipDepressor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLowerLipDepressor", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftLipCornerPuller": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLipCornerPuller", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftLipStretcher": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftLipStretcher", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftUpperLipRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftUpperLipRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightCheekPuff": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightCheekPuff", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightDimpler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightDimpler", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightLipCornerDown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLipCornerDown", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightLowerLipDepressor": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLowerLipDepressor", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightLipCornerPuller": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLipCornerPuller", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightLipStretcher": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightLipStretcher", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightUpperLipRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightUpperLipRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.JawDrop": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#JawDrop", "code_sample": "" }, "@roblox/enum/FacsActionUnit.JawLeft": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#JawLeft", "code_sample": "" }, "@roblox/enum/FacsActionUnit.JawRight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#JawRight", "code_sample": "" }, "@roblox/enum/FacsActionUnit.Corrugator": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#Corrugator", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftBrowLowerer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftBrowLowerer", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftOuterBrowRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftOuterBrowRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftNoseWrinkler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftNoseWrinkler", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftInnerBrowRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftInnerBrowRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightBrowLowerer": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightBrowLowerer", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightOuterBrowRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightOuterBrowRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightInnerBrowRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightInnerBrowRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightNoseWrinkler": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightNoseWrinkler", "code_sample": "" }, "@roblox/enum/FacsActionUnit.EyesLookDown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookDown", "code_sample": "" }, "@roblox/enum/FacsActionUnit.EyesLookLeft": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookLeft", "code_sample": "" }, "@roblox/enum/FacsActionUnit.EyesLookUp": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookUp", "code_sample": "" }, "@roblox/enum/FacsActionUnit.EyesLookRight": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#EyesLookRight", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftCheekRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftCheekRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftEyeUpperLidRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftEyeUpperLidRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.LeftEyeClosed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#LeftEyeClosed", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightCheekRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightCheekRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightEyeUpperLidRaiser": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightEyeUpperLidRaiser", "code_sample": "" }, "@roblox/enum/FacsActionUnit.RightEyeClosed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#RightEyeClosed", "code_sample": "" }, "@roblox/enum/FacsActionUnit.TongueDown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#TongueDown", "code_sample": "" }, "@roblox/enum/FacsActionUnit.TongueOut": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#TongueOut", "code_sample": "" }, "@roblox/enum/FacsActionUnit.TongueUp": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit#TongueUp", "code_sample": "" }, "@roblox/global/Enum.FacsActionUnit": { "documentation": "", "keys": { "ChinRaiserUpperLip": "@roblox/enum/FacsActionUnit.ChinRaiserUpperLip", "ChinRaiser": "@roblox/enum/FacsActionUnit.ChinRaiser", "FlatPucker": "@roblox/enum/FacsActionUnit.FlatPucker", "Funneler": "@roblox/enum/FacsActionUnit.Funneler", "LowerLipSuck": "@roblox/enum/FacsActionUnit.LowerLipSuck", "LipPresser": "@roblox/enum/FacsActionUnit.LipPresser", "LipsTogether": "@roblox/enum/FacsActionUnit.LipsTogether", "MouthLeft": "@roblox/enum/FacsActionUnit.MouthLeft", "MouthRight": "@roblox/enum/FacsActionUnit.MouthRight", "Pucker": "@roblox/enum/FacsActionUnit.Pucker", "UpperLipSuck": "@roblox/enum/FacsActionUnit.UpperLipSuck", "LeftCheekPuff": "@roblox/enum/FacsActionUnit.LeftCheekPuff", "LeftDimpler": "@roblox/enum/FacsActionUnit.LeftDimpler", "LeftLipCornerDown": "@roblox/enum/FacsActionUnit.LeftLipCornerDown", "LeftLowerLipDepressor": "@roblox/enum/FacsActionUnit.LeftLowerLipDepressor", "LeftLipCornerPuller": "@roblox/enum/FacsActionUnit.LeftLipCornerPuller", "LeftLipStretcher": "@roblox/enum/FacsActionUnit.LeftLipStretcher", "LeftUpperLipRaiser": "@roblox/enum/FacsActionUnit.LeftUpperLipRaiser", "RightCheekPuff": "@roblox/enum/FacsActionUnit.RightCheekPuff", "RightDimpler": "@roblox/enum/FacsActionUnit.RightDimpler", "RightLipCornerDown": "@roblox/enum/FacsActionUnit.RightLipCornerDown", "RightLowerLipDepressor": "@roblox/enum/FacsActionUnit.RightLowerLipDepressor", "RightLipCornerPuller": "@roblox/enum/FacsActionUnit.RightLipCornerPuller", "RightLipStretcher": "@roblox/enum/FacsActionUnit.RightLipStretcher", "RightUpperLipRaiser": "@roblox/enum/FacsActionUnit.RightUpperLipRaiser", "JawDrop": "@roblox/enum/FacsActionUnit.JawDrop", "JawLeft": "@roblox/enum/FacsActionUnit.JawLeft", "JawRight": "@roblox/enum/FacsActionUnit.JawRight", "Corrugator": "@roblox/enum/FacsActionUnit.Corrugator", "LeftBrowLowerer": "@roblox/enum/FacsActionUnit.LeftBrowLowerer", "LeftOuterBrowRaiser": "@roblox/enum/FacsActionUnit.LeftOuterBrowRaiser", "LeftNoseWrinkler": "@roblox/enum/FacsActionUnit.LeftNoseWrinkler", "LeftInnerBrowRaiser": "@roblox/enum/FacsActionUnit.LeftInnerBrowRaiser", "RightBrowLowerer": "@roblox/enum/FacsActionUnit.RightBrowLowerer", "RightOuterBrowRaiser": "@roblox/enum/FacsActionUnit.RightOuterBrowRaiser", "RightInnerBrowRaiser": "@roblox/enum/FacsActionUnit.RightInnerBrowRaiser", "RightNoseWrinkler": "@roblox/enum/FacsActionUnit.RightNoseWrinkler", "EyesLookDown": "@roblox/enum/FacsActionUnit.EyesLookDown", "EyesLookLeft": "@roblox/enum/FacsActionUnit.EyesLookLeft", "EyesLookUp": "@roblox/enum/FacsActionUnit.EyesLookUp", "EyesLookRight": "@roblox/enum/FacsActionUnit.EyesLookRight", "LeftCheekRaiser": "@roblox/enum/FacsActionUnit.LeftCheekRaiser", "LeftEyeUpperLidRaiser": "@roblox/enum/FacsActionUnit.LeftEyeUpperLidRaiser", "LeftEyeClosed": "@roblox/enum/FacsActionUnit.LeftEyeClosed", "RightCheekRaiser": "@roblox/enum/FacsActionUnit.RightCheekRaiser", "RightEyeUpperLidRaiser": "@roblox/enum/FacsActionUnit.RightEyeUpperLidRaiser", "RightEyeClosed": "@roblox/enum/FacsActionUnit.RightEyeClosed", "TongueDown": "@roblox/enum/FacsActionUnit.TongueDown", "TongueOut": "@roblox/enum/FacsActionUnit.TongueOut", "TongueUp": "@roblox/enum/FacsActionUnit.TongueUp" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacsActionUnit", "code_sample": "" }, "@roblox/enum/EasingDirection.In": { "documentation": "The easing style is applied in a forward direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingDirection#In", "code_sample": "" }, "@roblox/enum/EasingDirection.Out": { "documentation": "The easing style is applied in a reverse direction.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingDirection#Out", "code_sample": "" }, "@roblox/enum/EasingDirection.InOut": { "documentation": "The easing style is applied forward for the first half and in reverse for the second half.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingDirection#InOut", "code_sample": "" }, "@roblox/global/Enum.EasingDirection": { "documentation": "Enum used with TweenInfo.new() to control the direction Tweens play in.", "keys": { "In": "@roblox/enum/EasingDirection.In", "Out": "@roblox/enum/EasingDirection.Out", "InOut": "@roblox/enum/EasingDirection.InOut" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/EasingDirection", "code_sample": "" }, "@roblox/enum/WrapLayerAutoSkin.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerAutoSkin#Disabled", "code_sample": "" }, "@roblox/enum/WrapLayerAutoSkin.EnabledPreserve": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerAutoSkin#EnabledPreserve", "code_sample": "" }, "@roblox/enum/WrapLayerAutoSkin.EnabledOverride": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerAutoSkin#EnabledOverride", "code_sample": "" }, "@roblox/global/Enum.WrapLayerAutoSkin": { "documentation": "", "keys": { "Disabled": "@roblox/enum/WrapLayerAutoSkin.Disabled", "EnabledPreserve": "@roblox/enum/WrapLayerAutoSkin.EnabledPreserve", "EnabledOverride": "@roblox/enum/WrapLayerAutoSkin.EnabledOverride" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WrapLayerAutoSkin", "code_sample": "" }, "@roblox/enum/AdEventType.VideoLoaded": { "documentation": "Deprecated: This option should not be used for new work.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType#VideoLoaded", "code_sample": "" }, "@roblox/enum/AdEventType.VideoRemoved": { "documentation": "Deprecated: This option should not be used for new work.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType#VideoRemoved", "code_sample": "" }, "@roblox/enum/AdEventType.UserCompletedVideo": { "documentation": "Deprecated: This option should not be used for new work.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType#UserCompletedVideo", "code_sample": "" }, "@roblox/enum/AdEventType.RewardedAdLoaded": { "documentation": "The event is fired when a click-to-play video ad is being served. This can be used to communicate and promote the reward to users through the UI or signage.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdLoaded", "code_sample": "" }, "@roblox/enum/AdEventType.RewardedAdGrant": { "documentation": "The event is fired when a user has watched the click-to-play video ad for a certain time. This can be used to grant the player a reward such as an in-game item or in-game currency. The RewardedAdGrant enum will only be triggered once per ad rotation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdGrant", "code_sample": "" }, "@roblox/enum/AdEventType.RewardedAdUnloaded": { "documentation": "The event is fired when a click-to-play video ad is rotated out. This can be used to remove any UI or signage that is promoting the reward.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType#RewardedAdUnloaded", "code_sample": "" }, "@roblox/global/Enum.AdEventType": { "documentation": "", "keys": { "VideoLoaded": "@roblox/enum/AdEventType.VideoLoaded", "VideoRemoved": "@roblox/enum/AdEventType.VideoRemoved", "UserCompletedVideo": "@roblox/enum/AdEventType.UserCompletedVideo", "RewardedAdLoaded": "@roblox/enum/AdEventType.RewardedAdLoaded", "RewardedAdGrant": "@roblox/enum/AdEventType.RewardedAdGrant", "RewardedAdUnloaded": "@roblox/enum/AdEventType.RewardedAdUnloaded" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdEventType", "code_sample": "" }, "@roblox/enum/RenderingCacheOptimizationMode.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingCacheOptimizationMode#Default", "code_sample": "" }, "@roblox/enum/RenderingCacheOptimizationMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingCacheOptimizationMode#Disabled", "code_sample": "" }, "@roblox/enum/RenderingCacheOptimizationMode.Enabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingCacheOptimizationMode#Enabled", "code_sample": "" }, "@roblox/global/Enum.RenderingCacheOptimizationMode": { "documentation": "", "keys": { "Default": "@roblox/enum/RenderingCacheOptimizationMode.Default", "Disabled": "@roblox/enum/RenderingCacheOptimizationMode.Disabled", "Enabled": "@roblox/enum/RenderingCacheOptimizationMode.Enabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/RenderingCacheOptimizationMode", "code_sample": "" }, "@roblox/enum/PrimitiveType.Null": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType#Null", "code_sample": "" }, "@roblox/enum/PrimitiveType.Ball": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType#Ball", "code_sample": "" }, "@roblox/enum/PrimitiveType.Cylinder": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType#Cylinder", "code_sample": "" }, "@roblox/enum/PrimitiveType.Block": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType#Block", "code_sample": "" }, "@roblox/enum/PrimitiveType.Wedge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType#Wedge", "code_sample": "" }, "@roblox/enum/PrimitiveType.CornerWedge": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType#CornerWedge", "code_sample": "" }, "@roblox/global/Enum.PrimitiveType": { "documentation": "", "keys": { "Null": "@roblox/enum/PrimitiveType.Null", "Ball": "@roblox/enum/PrimitiveType.Ball", "Cylinder": "@roblox/enum/PrimitiveType.Cylinder", "Block": "@roblox/enum/PrimitiveType.Block", "Wedge": "@roblox/enum/PrimitiveType.Wedge", "CornerWedge": "@roblox/enum/PrimitiveType.CornerWedge" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimitiveType", "code_sample": "" }, "@roblox/enum/ThrottlingPriority.Default": { "documentation": "Standard throttling.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThrottlingPriority#Default", "code_sample": "" }, "@roblox/enum/ThrottlingPriority.ElevatedOnServer": { "documentation": "Less throttling if on the server.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThrottlingPriority#ElevatedOnServer", "code_sample": "" }, "@roblox/enum/ThrottlingPriority.Extreme": { "documentation": "No throttling, absolutely no exceptions.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThrottlingPriority#Extreme", "code_sample": "" }, "@roblox/global/Enum.ThrottlingPriority": { "documentation": "Amount of throttling to apply.", "keys": { "Default": "@roblox/enum/ThrottlingPriority.Default", "ElevatedOnServer": "@roblox/enum/ThrottlingPriority.ElevatedOnServer", "Extreme": "@roblox/enum/ThrottlingPriority.Extreme" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ThrottlingPriority", "code_sample": "" }, "@roblox/enum/FluidForces.Default": { "documentation": "Aerodynamic forces will not be calculated on any BaseParts.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidForces#Default", "code_sample": "" }, "@roblox/enum/FluidForces.Experimental": { "documentation": "Aerodynamic forces will be calculated on BaseParts with EnableFluidForces set to true. During the beta phase, the behavior of the aerodynamic force model may change as the model improves.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidForces#Experimental", "code_sample": "" }, "@roblox/global/Enum.FluidForces": { "documentation": "Controls the enablement of aerodynamic forces on parts and assemblies in the workspace.", "keys": { "Default": "@roblox/enum/FluidForces.Default", "Experimental": "@roblox/enum/FluidForces.Experimental" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FluidForces", "code_sample": "" }, "@roblox/enum/PreferredInput.KeyboardAndMouse": { "documentation": "The player has connected or most recently interacted with a keyboard or mouse.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredInput#KeyboardAndMouse", "code_sample": "" }, "@roblox/enum/PreferredInput.Gamepad": { "documentation": "The player has connected or most recently interacted with a gamepad.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredInput#Gamepad", "code_sample": "" }, "@roblox/enum/PreferredInput.Touch": { "documentation": "The player's device has touch capability and no other input method is available or was recently interacted with.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredInput#Touch", "code_sample": "" }, "@roblox/global/Enum.PreferredInput": { "documentation": "This enum is used with UserInputService.PreferredInput to indicate the primary input type a player is likely using.", "keys": { "KeyboardAndMouse": "@roblox/enum/PreferredInput.KeyboardAndMouse", "Gamepad": "@roblox/enum/PreferredInput.Gamepad", "Touch": "@roblox/enum/PreferredInput.Touch" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PreferredInput", "code_sample": "" }, "@roblox/enum/AvatarItemType.Asset": { "documentation": "Avatar assets.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarItemType#Asset", "code_sample": "" }, "@roblox/enum/AvatarItemType.Bundle": { "documentation": "Avatar bundles.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarItemType#Bundle", "code_sample": "" }, "@roblox/global/Enum.AvatarItemType": { "documentation": "The type (Asset or Bundle) of avatar items.", "keys": { "Asset": "@roblox/enum/AvatarItemType.Asset", "Bundle": "@roblox/enum/AvatarItemType.Bundle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarItemType", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.Automatic": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#Automatic", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel1": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel1", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel2": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel2", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel3": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel3", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel4": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel4", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel5": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel5", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel6": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel6", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel7": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel7", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel8": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel8", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel9": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel9", "code_sample": "" }, "@roblox/enum/SavedQualitySetting.QualityLevel10": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting#QualityLevel10", "code_sample": "" }, "@roblox/global/Enum.SavedQualitySetting": { "documentation": "", "keys": { "Automatic": "@roblox/enum/SavedQualitySetting.Automatic", "QualityLevel1": "@roblox/enum/SavedQualitySetting.QualityLevel1", "QualityLevel2": "@roblox/enum/SavedQualitySetting.QualityLevel2", "QualityLevel3": "@roblox/enum/SavedQualitySetting.QualityLevel3", "QualityLevel4": "@roblox/enum/SavedQualitySetting.QualityLevel4", "QualityLevel5": "@roblox/enum/SavedQualitySetting.QualityLevel5", "QualityLevel6": "@roblox/enum/SavedQualitySetting.QualityLevel6", "QualityLevel7": "@roblox/enum/SavedQualitySetting.QualityLevel7", "QualityLevel8": "@roblox/enum/SavedQualitySetting.QualityLevel8", "QualityLevel9": "@roblox/enum/SavedQualitySetting.QualityLevel9", "QualityLevel10": "@roblox/enum/SavedQualitySetting.QualityLevel10" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SavedQualitySetting", "code_sample": "" }, "@roblox/enum/VRControllerModelMode.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRControllerModelMode#Disabled", "code_sample": "" }, "@roblox/enum/VRControllerModelMode.Transparent": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRControllerModelMode#Transparent", "code_sample": "" }, "@roblox/global/Enum.VRControllerModelMode": { "documentation": "", "keys": { "Disabled": "@roblox/enum/VRControllerModelMode.Disabled", "Transparent": "@roblox/enum/VRControllerModelMode.Transparent" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VRControllerModelMode", "code_sample": "" }, "@roblox/enum/InviteState.Placed": { "documentation": "Call invite was placed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InviteState#Placed", "code_sample": "" }, "@roblox/enum/InviteState.Accepted": { "documentation": "Call invite was accepted.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InviteState#Accepted", "code_sample": "" }, "@roblox/enum/InviteState.Declined": { "documentation": "Call invite was declined.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InviteState#Declined", "code_sample": "" }, "@roblox/enum/InviteState.Missed": { "documentation": "Call invite was missed.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InviteState#Missed", "code_sample": "" }, "@roblox/global/Enum.InviteState": { "documentation": "Describes a player's call invite state.", "keys": { "Placed": "@roblox/enum/InviteState.Placed", "Accepted": "@roblox/enum/InviteState.Accepted", "Declined": "@roblox/enum/InviteState.Declined", "Missed": "@roblox/enum/InviteState.Missed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InviteState", "code_sample": "" }, "@roblox/enum/AccessModifierType.Allow": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessModifierType#Allow", "code_sample": "" }, "@roblox/enum/AccessModifierType.Deny": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessModifierType#Deny", "code_sample": "" }, "@roblox/global/Enum.AccessModifierType": { "documentation": "", "keys": { "Allow": "@roblox/enum/AccessModifierType.Allow", "Deny": "@roblox/enum/AccessModifierType.Deny" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AccessModifierType", "code_sample": "" }, "@roblox/enum/HumanoidRigType.R6": { "documentation": "Indicates that a character is using the legacy R6 rig.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidRigType#R6", "code_sample": "" }, "@roblox/enum/HumanoidRigType.R15": { "documentation": "Indicates that a character is using the new R15 rig.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidRigType#R15", "code_sample": "" }, "@roblox/global/Enum.HumanoidRigType": { "documentation": "Describes whether or not a character is using the new R15 rig, or the legacy R6 rig.", "keys": { "R6": "@roblox/enum/HumanoidRigType.R6", "R15": "@roblox/enum/HumanoidRigType.R15" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidRigType", "code_sample": "" }, "@roblox/enum/CatalogCategoryFilter.None": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#None", "code_sample": "" }, "@roblox/enum/CatalogCategoryFilter.Featured": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Featured", "code_sample": "" }, "@roblox/enum/CatalogCategoryFilter.Collectibles": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Collectibles", "code_sample": "" }, "@roblox/enum/CatalogCategoryFilter.CommunityCreations": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#CommunityCreations", "code_sample": "" }, "@roblox/enum/CatalogCategoryFilter.Premium": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Premium", "code_sample": "" }, "@roblox/enum/CatalogCategoryFilter.Recommended": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter#Recommended", "code_sample": "" }, "@roblox/global/Enum.CatalogCategoryFilter": { "documentation": "", "keys": { "None": "@roblox/enum/CatalogCategoryFilter.None", "Featured": "@roblox/enum/CatalogCategoryFilter.Featured", "Collectibles": "@roblox/enum/CatalogCategoryFilter.Collectibles", "CommunityCreations": "@roblox/enum/CatalogCategoryFilter.CommunityCreations", "Premium": "@roblox/enum/CatalogCategoryFilter.Premium", "Recommended": "@roblox/enum/CatalogCategoryFilter.Recommended" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CatalogCategoryFilter", "code_sample": "" }, "@roblox/enum/AdTeleportMethod.Undefined": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#Undefined", "code_sample": "" }, "@roblox/enum/AdTeleportMethod.PortalForward": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#PortalForward", "code_sample": "" }, "@roblox/enum/AdTeleportMethod.InGameMenuBackButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#InGameMenuBackButton", "code_sample": "" }, "@roblox/enum/AdTeleportMethod.UIBackButton": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod#UIBackButton", "code_sample": "" }, "@roblox/global/Enum.AdTeleportMethod": { "documentation": "", "keys": { "Undefined": "@roblox/enum/AdTeleportMethod.Undefined", "PortalForward": "@roblox/enum/AdTeleportMethod.PortalForward", "InGameMenuBackButton": "@roblox/enum/AdTeleportMethod.InGameMenuBackButton", "UIBackButton": "@roblox/enum/AdTeleportMethod.UIBackButton" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AdTeleportMethod", "code_sample": "" }, "@roblox/enum/AvatarContextMenuOption.Friend": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#Friend", "code_sample": "" }, "@roblox/enum/AvatarContextMenuOption.Chat": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#Chat", "code_sample": "" }, "@roblox/enum/AvatarContextMenuOption.Emote": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#Emote", "code_sample": "" }, "@roblox/enum/AvatarContextMenuOption.InspectMenu": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption#InspectMenu", "code_sample": "" }, "@roblox/global/Enum.AvatarContextMenuOption": { "documentation": "", "keys": { "Friend": "@roblox/enum/AvatarContextMenuOption.Friend", "Chat": "@roblox/enum/AvatarContextMenuOption.Chat", "Emote": "@roblox/enum/AvatarContextMenuOption.Emote", "InspectMenu": "@roblox/enum/AvatarContextMenuOption.InspectMenu" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarContextMenuOption", "code_sample": "" }, "@roblox/enum/Material.Plastic": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Plastic", "code_sample": "" }, "@roblox/enum/Material.SmoothPlastic": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#SmoothPlastic", "code_sample": "" }, "@roblox/enum/Material.Neon": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Neon", "code_sample": "" }, "@roblox/enum/Material.Wood": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Wood", "code_sample": "" }, "@roblox/enum/Material.WoodPlanks": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#WoodPlanks", "code_sample": "" }, "@roblox/enum/Material.Marble": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Marble", "code_sample": "" }, "@roblox/enum/Material.Basalt": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Basalt", "code_sample": "" }, "@roblox/enum/Material.Slate": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Slate", "code_sample": "" }, "@roblox/enum/Material.CrackedLava": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#CrackedLava", "code_sample": "" }, "@roblox/enum/Material.Concrete": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Concrete", "code_sample": "" }, "@roblox/enum/Material.Limestone": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Limestone", "code_sample": "" }, "@roblox/enum/Material.Granite": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Granite", "code_sample": "" }, "@roblox/enum/Material.Pavement": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Pavement", "code_sample": "" }, "@roblox/enum/Material.Brick": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Brick", "code_sample": "" }, "@roblox/enum/Material.Pebble": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Pebble", "code_sample": "" }, "@roblox/enum/Material.Cobblestone": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Cobblestone", "code_sample": "" }, "@roblox/enum/Material.Rock": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Rock", "code_sample": "" }, "@roblox/enum/Material.Sandstone": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Sandstone", "code_sample": "" }, "@roblox/enum/Material.CorrodedMetal": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#CorrodedMetal", "code_sample": "" }, "@roblox/enum/Material.DiamondPlate": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#DiamondPlate", "code_sample": "" }, "@roblox/enum/Material.Foil": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Foil", "code_sample": "" }, "@roblox/enum/Material.Metal": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Metal", "code_sample": "" }, "@roblox/enum/Material.Grass": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Grass", "code_sample": "" }, "@roblox/enum/Material.LeafyGrass": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#LeafyGrass", "code_sample": "" }, "@roblox/enum/Material.Sand": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Sand", "code_sample": "" }, "@roblox/enum/Material.Fabric": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Fabric", "code_sample": "" }, "@roblox/enum/Material.Snow": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Snow", "code_sample": "" }, "@roblox/enum/Material.Mud": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Mud", "code_sample": "" }, "@roblox/enum/Material.Ground": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Ground", "code_sample": "" }, "@roblox/enum/Material.Asphalt": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Asphalt", "code_sample": "" }, "@roblox/enum/Material.Salt": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Salt", "code_sample": "" }, "@roblox/enum/Material.Ice": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Ice", "code_sample": "" }, "@roblox/enum/Material.Glacier": { "documentation": "Applies to BasePart and Terrain.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Glacier", "code_sample": "" }, "@roblox/enum/Material.Glass": { "documentation": "Applies to BasePart only. Note that refraction of light through this material is not supported on mobile devices due to computational limitations.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Glass", "code_sample": "" }, "@roblox/enum/Material.ForceField": { "documentation": "Must be used on a MeshPart with UVs laid out to cover much of the 0:1 UV space or more (larger is better). The MeshPart must also have a texture applied to its TextureID, and that texture image must have a wide value range since the material displays the range from dark/black to light/white values. Obtain this model for a functional example.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#ForceField", "code_sample": "" }, "@roblox/enum/Material.Air": { "documentation": "Applies to Terrain only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Air", "code_sample": "" }, "@roblox/enum/Material.Water": { "documentation": "Applies to Terrain only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Water", "code_sample": "" }, "@roblox/enum/Material.Cardboard": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Cardboard", "code_sample": "" }, "@roblox/enum/Material.Carpet": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Carpet", "code_sample": "" }, "@roblox/enum/Material.CeramicTiles": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#CeramicTiles", "code_sample": "" }, "@roblox/enum/Material.ClayRoofTiles": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#ClayRoofTiles", "code_sample": "" }, "@roblox/enum/Material.RoofShingles": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#RoofShingles", "code_sample": "" }, "@roblox/enum/Material.Leather": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Leather", "code_sample": "" }, "@roblox/enum/Material.Plaster": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Plaster", "code_sample": "" }, "@roblox/enum/Material.Rubber": { "documentation": "Applies to BasePart only.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material#Rubber", "code_sample": "" }, "@roblox/global/Enum.Material": { "documentation": "Materials used for parts and/or terrain.", "keys": { "Plastic": "@roblox/enum/Material.Plastic", "SmoothPlastic": "@roblox/enum/Material.SmoothPlastic", "Neon": "@roblox/enum/Material.Neon", "Wood": "@roblox/enum/Material.Wood", "WoodPlanks": "@roblox/enum/Material.WoodPlanks", "Marble": "@roblox/enum/Material.Marble", "Basalt": "@roblox/enum/Material.Basalt", "Slate": "@roblox/enum/Material.Slate", "CrackedLava": "@roblox/enum/Material.CrackedLava", "Concrete": "@roblox/enum/Material.Concrete", "Limestone": "@roblox/enum/Material.Limestone", "Granite": "@roblox/enum/Material.Granite", "Pavement": "@roblox/enum/Material.Pavement", "Brick": "@roblox/enum/Material.Brick", "Pebble": "@roblox/enum/Material.Pebble", "Cobblestone": "@roblox/enum/Material.Cobblestone", "Rock": "@roblox/enum/Material.Rock", "Sandstone": "@roblox/enum/Material.Sandstone", "CorrodedMetal": "@roblox/enum/Material.CorrodedMetal", "DiamondPlate": "@roblox/enum/Material.DiamondPlate", "Foil": "@roblox/enum/Material.Foil", "Metal": "@roblox/enum/Material.Metal", "Grass": "@roblox/enum/Material.Grass", "LeafyGrass": "@roblox/enum/Material.LeafyGrass", "Sand": "@roblox/enum/Material.Sand", "Fabric": "@roblox/enum/Material.Fabric", "Snow": "@roblox/enum/Material.Snow", "Mud": "@roblox/enum/Material.Mud", "Ground": "@roblox/enum/Material.Ground", "Asphalt": "@roblox/enum/Material.Asphalt", "Salt": "@roblox/enum/Material.Salt", "Ice": "@roblox/enum/Material.Ice", "Glacier": "@roblox/enum/Material.Glacier", "Glass": "@roblox/enum/Material.Glass", "ForceField": "@roblox/enum/Material.ForceField", "Air": "@roblox/enum/Material.Air", "Water": "@roblox/enum/Material.Water", "Cardboard": "@roblox/enum/Material.Cardboard", "Carpet": "@roblox/enum/Material.Carpet", "CeramicTiles": "@roblox/enum/Material.CeramicTiles", "ClayRoofTiles": "@roblox/enum/Material.ClayRoofTiles", "RoofShingles": "@roblox/enum/Material.RoofShingles", "Leather": "@roblox/enum/Material.Leather", "Plaster": "@roblox/enum/Material.Plaster", "Rubber": "@roblox/enum/Material.Rubber" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/Material", "code_sample": "" }, "@roblox/enum/InfoType.Asset": { "documentation": "The product is an asset.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InfoType#Asset", "code_sample": "" }, "@roblox/enum/InfoType.Product": { "documentation": "Product such as a Developer Product.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InfoType#Product", "code_sample": "" }, "@roblox/enum/InfoType.GamePass": { "documentation": "The product is a game pass.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InfoType#GamePass", "code_sample": "" }, "@roblox/enum/InfoType.Subscription": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InfoType#Subscription", "code_sample": "" }, "@roblox/enum/InfoType.Bundle": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InfoType#Bundle", "code_sample": "" }, "@roblox/global/Enum.InfoType": { "documentation": "", "keys": { "Asset": "@roblox/enum/InfoType.Asset", "Product": "@roblox/enum/InfoType.Product", "GamePass": "@roblox/enum/InfoType.GamePass", "Subscription": "@roblox/enum/InfoType.Subscription", "Bundle": "@roblox/enum/InfoType.Bundle" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/InfoType", "code_sample": "" }, "@roblox/enum/VideoCaptureResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureResult#Success", "code_sample": "" }, "@roblox/enum/VideoCaptureResult.OtherError": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureResult#OtherError", "code_sample": "" }, "@roblox/enum/VideoCaptureResult.ScreenSizeChanged": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureResult#ScreenSizeChanged", "code_sample": "" }, "@roblox/enum/VideoCaptureResult.TimeLimitReached": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureResult#TimeLimitReached", "code_sample": "" }, "@roblox/global/Enum.VideoCaptureResult": { "documentation": "", "keys": { "Success": "@roblox/enum/VideoCaptureResult.Success", "OtherError": "@roblox/enum/VideoCaptureResult.OtherError", "ScreenSizeChanged": "@roblox/enum/VideoCaptureResult.ScreenSizeChanged", "TimeLimitReached": "@roblox/enum/VideoCaptureResult.TimeLimitReached" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/VideoCaptureResult", "code_sample": "" }, "@roblox/enum/AvatarSettingsLegacyCollisionMode.R6Colliders": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsLegacyCollisionMode#R6Colliders", "code_sample": "" }, "@roblox/enum/AvatarSettingsLegacyCollisionMode.InnerBoxColliders": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsLegacyCollisionMode#InnerBoxColliders", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsLegacyCollisionMode": { "documentation": "", "keys": { "R6Colliders": "@roblox/enum/AvatarSettingsLegacyCollisionMode.R6Colliders", "InnerBoxColliders": "@roblox/enum/AvatarSettingsLegacyCollisionMode.InnerBoxColliders" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsLegacyCollisionMode", "code_sample": "" }, "@roblox/enum/DeviceForm.Console": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Console", "code_sample": "" }, "@roblox/enum/DeviceForm.Phone": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Phone", "code_sample": "" }, "@roblox/enum/DeviceForm.Tablet": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Tablet", "code_sample": "" }, "@roblox/enum/DeviceForm.Desktop": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceForm#Desktop", "code_sample": "" }, "@roblox/enum/DeviceForm.VR": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceForm#VR", "code_sample": "" }, "@roblox/global/Enum.DeviceForm": { "documentation": "", "keys": { "Console": "@roblox/enum/DeviceForm.Console", "Phone": "@roblox/enum/DeviceForm.Phone", "Tablet": "@roblox/enum/DeviceForm.Tablet", "Desktop": "@roblox/enum/DeviceForm.Desktop", "VR": "@roblox/enum/DeviceForm.VR" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DeviceForm", "code_sample": "" }, "@roblox/enum/SandboxedInstanceMode.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SandboxedInstanceMode#Default", "code_sample": "" }, "@roblox/enum/SandboxedInstanceMode.Experimental": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SandboxedInstanceMode#Experimental", "code_sample": "" }, "@roblox/global/Enum.SandboxedInstanceMode": { "documentation": "", "keys": { "Default": "@roblox/enum/SandboxedInstanceMode.Default", "Experimental": "@roblox/enum/SandboxedInstanceMode.Experimental" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/SandboxedInstanceMode", "code_sample": "" }, "@roblox/enum/OutputLayoutMode.Horizontal": { "documentation": "The output layout is horizontal (x-axis).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutputLayoutMode#Horizontal", "code_sample": "" }, "@roblox/enum/OutputLayoutMode.Vertical": { "documentation": "The output layout is vertical (y-axis).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutputLayoutMode#Vertical", "code_sample": "" }, "@roblox/global/Enum.OutputLayoutMode": { "documentation": "Sets the layout mode of the output.", "keys": { "Horizontal": "@roblox/enum/OutputLayoutMode.Horizontal", "Vertical": "@roblox/enum/OutputLayoutMode.Vertical" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/OutputLayoutMode", "code_sample": "" }, "@roblox/enum/WebStreamClientState.Connecting": { "documentation": "The client has sent a request to connect with the server and is waiting for a response.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Connecting", "code_sample": "" }, "@roblox/enum/WebStreamClientState.Open": { "documentation": "The client is connected to the server, allowing for data to be streamed between the server and client.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Open", "code_sample": "" }, "@roblox/enum/WebStreamClientState.Error": { "documentation": "An unrecoverable error has occured while setting up the connection orduring the connection lifetime, cutting off the stream.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Error", "code_sample": "" }, "@roblox/enum/WebStreamClientState.Closed": { "documentation": "The connection has run to completion without issues, either closed naturally by the server or manually by the user.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState#Closed", "code_sample": "" }, "@roblox/global/Enum.WebStreamClientState": { "documentation": "WebStreamClientState indicates the current state of a WebStreamClient object.", "keys": { "Connecting": "@roblox/enum/WebStreamClientState.Connecting", "Open": "@roblox/enum/WebStreamClientState.Open", "Error": "@roblox/enum/WebStreamClientState.Error", "Closed": "@roblox/enum/WebStreamClientState.Closed" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/WebStreamClientState", "code_sample": "" }, "@roblox/enum/DebuggerFrameType.C": { "documentation": "Call stack frame belongs to a C (native) function.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerFrameType#C", "code_sample": "" }, "@roblox/enum/DebuggerFrameType.Lua": { "documentation": "Call stack frame belongs to a Luau function.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerFrameType#Lua", "code_sample": "" }, "@roblox/global/Enum.DebuggerFrameType": { "documentation": "Call stack frame type.", "keys": { "C": "@roblox/enum/DebuggerFrameType.C", "Lua": "@roblox/enum/DebuggerFrameType.Lua" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DebuggerFrameType", "code_sample": "" }, "@roblox/enum/CreateAssetResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#Success", "code_sample": "" }, "@roblox/enum/CreateAssetResult.PermissionDenied": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#PermissionDenied", "code_sample": "" }, "@roblox/enum/CreateAssetResult.UploadFailed": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#UploadFailed", "code_sample": "" }, "@roblox/enum/CreateAssetResult.Unknown": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult#Unknown", "code_sample": "" }, "@roblox/global/Enum.CreateAssetResult": { "documentation": "", "keys": { "Success": "@roblox/enum/CreateAssetResult.Success", "PermissionDenied": "@roblox/enum/CreateAssetResult.PermissionDenied", "UploadFailed": "@roblox/enum/CreateAssetResult.UploadFailed", "Unknown": "@roblox/enum/CreateAssetResult.Unknown" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/CreateAssetResult", "code_sample": "" }, "@roblox/enum/DialogPurpose.Quest": { "documentation": "Shows an exclamation point ('''!''').", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogPurpose#Quest", "code_sample": "" }, "@roblox/enum/DialogPurpose.Help": { "documentation": "Shows a question mark ('''?''').", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogPurpose#Help", "code_sample": "" }, "@roblox/enum/DialogPurpose.Shop": { "documentation": "Shows a dollar sign ('''$''').", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogPurpose#Shop", "code_sample": "" }, "@roblox/global/Enum.DialogPurpose": { "documentation": "The DialogPurpose enum is used to set the icon of a Dialog.", "keys": { "Quest": "@roblox/enum/DialogPurpose.Quest", "Help": "@roblox/enum/DialogPurpose.Help", "Shop": "@roblox/enum/DialogPurpose.Shop" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/DialogPurpose", "code_sample": "" }, "@roblox/enum/PrimalPhysicsSolver.Default": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimalPhysicsSolver#Default", "code_sample": "" }, "@roblox/enum/PrimalPhysicsSolver.Experimental": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimalPhysicsSolver#Experimental", "code_sample": "" }, "@roblox/enum/PrimalPhysicsSolver.Disabled": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimalPhysicsSolver#Disabled", "code_sample": "" }, "@roblox/global/Enum.PrimalPhysicsSolver": { "documentation": "", "keys": { "Default": "@roblox/enum/PrimalPhysicsSolver.Default", "Experimental": "@roblox/enum/PrimalPhysicsSolver.Experimental", "Disabled": "@roblox/enum/PrimalPhysicsSolver.Disabled" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PrimalPhysicsSolver", "code_sample": "" }, "@roblox/enum/ContentSourceType.None": { "documentation": "Empty value with no source type. Does not reference any content or hold any non‑nil value.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#None", "code_sample": "" }, "@roblox/enum/ContentSourceType.Uri": { "documentation": "An asset URI string value contained in Content.Uri.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#Uri", "code_sample": "" }, "@roblox/enum/ContentSourceType.Object": { "documentation": "A non-nil Object reference contained in Content.Object.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#Object", "code_sample": "" }, "@roblox/enum/ContentSourceType.Opaque": { "documentation": "A non-nil Opaque reference contained in Content.Opaque.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContentSourceType#Opaque", "code_sample": "" }, "@roblox/global/Enum.ContentSourceType": { "documentation": "The source type of a Content value.", "keys": { "None": "@roblox/enum/ContentSourceType.None", "Uri": "@roblox/enum/ContentSourceType.Uri", "Object": "@roblox/enum/ContentSourceType.Object", "Opaque": "@roblox/enum/ContentSourceType.Opaque" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContentSourceType", "code_sample": "" }, "@roblox/enum/AssetType.Image": { "documentation": "The asset is an image.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Image", "code_sample": "" }, "@roblox/enum/AssetType.TShirt": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#TShirt", "code_sample": "" }, "@roblox/enum/AssetType.Audio": { "documentation": "The asset is an audio clip.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Audio", "code_sample": "" }, "@roblox/enum/AssetType.Mesh": { "documentation": "The asset is a mesh.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Mesh", "code_sample": "" }, "@roblox/enum/AssetType.Lua": { "documentation": "The asset is Luau code, for example a ModuleScript.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Lua", "code_sample": "" }, "@roblox/enum/AssetType.Hat": { "documentation": "The asset is a hat.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Hat", "code_sample": "" }, "@roblox/enum/AssetType.Place": { "documentation": "The asset is a place.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Place", "code_sample": "" }, "@roblox/enum/AssetType.Model": { "documentation": "The asset is a model.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Model", "code_sample": "" }, "@roblox/enum/AssetType.Shirt": { "documentation": "The asset is a shirt.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Shirt", "code_sample": "" }, "@roblox/enum/AssetType.Pants": { "documentation": "The asset is a pants item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Pants", "code_sample": "" }, "@roblox/enum/AssetType.Decal": { "documentation": "The asset is a decal (image).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Decal", "code_sample": "" }, "@roblox/enum/AssetType.Head": { "documentation": "The asset is a head.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Head", "code_sample": "" }, "@roblox/enum/AssetType.Face": { "documentation": "The asset is a face.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Face", "code_sample": "" }, "@roblox/enum/AssetType.Gear": { "documentation": "The asset is a gear item.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Gear", "code_sample": "" }, "@roblox/enum/AssetType.Badge": { "documentation": "The asset is a badge.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Badge", "code_sample": "" }, "@roblox/enum/AssetType.Animation": { "documentation": "The asset is an animation; also see the more specific animation type enums below.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Animation", "code_sample": "" }, "@roblox/enum/AssetType.Torso": { "documentation": "The asset is a torso.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Torso", "code_sample": "" }, "@roblox/enum/AssetType.RightArm": { "documentation": "The asset is a right arm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#RightArm", "code_sample": "" }, "@roblox/enum/AssetType.LeftArm": { "documentation": "The asset is a left arm.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#LeftArm", "code_sample": "" }, "@roblox/enum/AssetType.LeftLeg": { "documentation": "The asset is a left leg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#LeftLeg", "code_sample": "" }, "@roblox/enum/AssetType.RightLeg": { "documentation": "The asset is a right leg.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#RightLeg", "code_sample": "" }, "@roblox/enum/AssetType.Package": { "documentation": "The asset is a pack, for example an animation package.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Package", "code_sample": "" }, "@roblox/enum/AssetType.GamePass": { "documentation": "The asset is a GamePass.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#GamePass", "code_sample": "" }, "@roblox/enum/AssetType.Plugin": { "documentation": "The asset is a plugin.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Plugin", "code_sample": "" }, "@roblox/enum/AssetType.MeshPart": { "documentation": "The asset is a mesh part.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#MeshPart", "code_sample": "" }, "@roblox/enum/AssetType.HairAccessory": { "documentation": "The asset is a hair accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#HairAccessory", "code_sample": "" }, "@roblox/enum/AssetType.FaceAccessory": { "documentation": "The asset is a face accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#FaceAccessory", "code_sample": "" }, "@roblox/enum/AssetType.NeckAccessory": { "documentation": "The asset is a neck accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#NeckAccessory", "code_sample": "" }, "@roblox/enum/AssetType.ShoulderAccessory": { "documentation": "The asset is a shoulder accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#ShoulderAccessory", "code_sample": "" }, "@roblox/enum/AssetType.FrontAccessory": { "documentation": "The asset is a front accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#FrontAccessory", "code_sample": "" }, "@roblox/enum/AssetType.BackAccessory": { "documentation": "The asset is a back accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#BackAccessory", "code_sample": "" }, "@roblox/enum/AssetType.WaistAccessory": { "documentation": "The asset is a waist accessory.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#WaistAccessory", "code_sample": "" }, "@roblox/enum/AssetType.ClimbAnimation": { "documentation": "The asset is a climb animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#ClimbAnimation", "code_sample": "" }, "@roblox/enum/AssetType.DeathAnimation": { "documentation": "The asset is a death animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#DeathAnimation", "code_sample": "" }, "@roblox/enum/AssetType.FallAnimation": { "documentation": "The asset is a fall animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#FallAnimation", "code_sample": "" }, "@roblox/enum/AssetType.IdleAnimation": { "documentation": "The asset is an idle animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#IdleAnimation", "code_sample": "" }, "@roblox/enum/AssetType.JumpAnimation": { "documentation": "The asset is a jump animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#JumpAnimation", "code_sample": "" }, "@roblox/enum/AssetType.RunAnimation": { "documentation": "The asset is a run animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#RunAnimation", "code_sample": "" }, "@roblox/enum/AssetType.SwimAnimation": { "documentation": "The asset is a swim animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#SwimAnimation", "code_sample": "" }, "@roblox/enum/AssetType.WalkAnimation": { "documentation": "The asset is a walk animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#WalkAnimation", "code_sample": "" }, "@roblox/enum/AssetType.PoseAnimation": { "documentation": "The asset is a pose animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#PoseAnimation", "code_sample": "" }, "@roblox/enum/AssetType.EarAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#EarAccessory", "code_sample": "" }, "@roblox/enum/AssetType.EyeAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#EyeAccessory", "code_sample": "" }, "@roblox/enum/AssetType.EmoteAnimation": { "documentation": "The asset is an emote animation.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#EmoteAnimation", "code_sample": "" }, "@roblox/enum/AssetType.Video": { "documentation": "The asset is a video.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#Video", "code_sample": "" }, "@roblox/enum/AssetType.TShirtAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#TShirtAccessory", "code_sample": "" }, "@roblox/enum/AssetType.ShirtAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#ShirtAccessory", "code_sample": "" }, "@roblox/enum/AssetType.PantsAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#PantsAccessory", "code_sample": "" }, "@roblox/enum/AssetType.JacketAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#JacketAccessory", "code_sample": "" }, "@roblox/enum/AssetType.SweaterAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#SweaterAccessory", "code_sample": "" }, "@roblox/enum/AssetType.ShortsAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#ShortsAccessory", "code_sample": "" }, "@roblox/enum/AssetType.LeftShoeAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#LeftShoeAccessory", "code_sample": "" }, "@roblox/enum/AssetType.RightShoeAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#RightShoeAccessory", "code_sample": "" }, "@roblox/enum/AssetType.DressSkirtAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#DressSkirtAccessory", "code_sample": "" }, "@roblox/enum/AssetType.FontFamily": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#FontFamily", "code_sample": "" }, "@roblox/enum/AssetType.EyebrowAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#EyebrowAccessory", "code_sample": "" }, "@roblox/enum/AssetType.EyelashAccessory": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#EyelashAccessory", "code_sample": "" }, "@roblox/enum/AssetType.MoodAnimation": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#MoodAnimation", "code_sample": "" }, "@roblox/enum/AssetType.DynamicHead": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#DynamicHead", "code_sample": "" }, "@roblox/enum/AssetType.FaceMakeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#FaceMakeup", "code_sample": "" }, "@roblox/enum/AssetType.LipMakeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#LipMakeup", "code_sample": "" }, "@roblox/enum/AssetType.EyeMakeup": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType#EyeMakeup", "code_sample": "" }, "@roblox/global/Enum.AssetType": { "documentation": "This Enum can be used to match the AssetTypeId from MarketplaceService:GetProductInfoAsync() to an asset type.", "keys": { "Image": "@roblox/enum/AssetType.Image", "TShirt": "@roblox/enum/AssetType.TShirt", "Audio": "@roblox/enum/AssetType.Audio", "Mesh": "@roblox/enum/AssetType.Mesh", "Lua": "@roblox/enum/AssetType.Lua", "Hat": "@roblox/enum/AssetType.Hat", "Place": "@roblox/enum/AssetType.Place", "Model": "@roblox/enum/AssetType.Model", "Shirt": "@roblox/enum/AssetType.Shirt", "Pants": "@roblox/enum/AssetType.Pants", "Decal": "@roblox/enum/AssetType.Decal", "Head": "@roblox/enum/AssetType.Head", "Face": "@roblox/enum/AssetType.Face", "Gear": "@roblox/enum/AssetType.Gear", "Badge": "@roblox/enum/AssetType.Badge", "Animation": "@roblox/enum/AssetType.Animation", "Torso": "@roblox/enum/AssetType.Torso", "RightArm": "@roblox/enum/AssetType.RightArm", "LeftArm": "@roblox/enum/AssetType.LeftArm", "LeftLeg": "@roblox/enum/AssetType.LeftLeg", "RightLeg": "@roblox/enum/AssetType.RightLeg", "Package": "@roblox/enum/AssetType.Package", "GamePass": "@roblox/enum/AssetType.GamePass", "Plugin": "@roblox/enum/AssetType.Plugin", "MeshPart": "@roblox/enum/AssetType.MeshPart", "HairAccessory": "@roblox/enum/AssetType.HairAccessory", "FaceAccessory": "@roblox/enum/AssetType.FaceAccessory", "NeckAccessory": "@roblox/enum/AssetType.NeckAccessory", "ShoulderAccessory": "@roblox/enum/AssetType.ShoulderAccessory", "FrontAccessory": "@roblox/enum/AssetType.FrontAccessory", "BackAccessory": "@roblox/enum/AssetType.BackAccessory", "WaistAccessory": "@roblox/enum/AssetType.WaistAccessory", "ClimbAnimation": "@roblox/enum/AssetType.ClimbAnimation", "DeathAnimation": "@roblox/enum/AssetType.DeathAnimation", "FallAnimation": "@roblox/enum/AssetType.FallAnimation", "IdleAnimation": "@roblox/enum/AssetType.IdleAnimation", "JumpAnimation": "@roblox/enum/AssetType.JumpAnimation", "RunAnimation": "@roblox/enum/AssetType.RunAnimation", "SwimAnimation": "@roblox/enum/AssetType.SwimAnimation", "WalkAnimation": "@roblox/enum/AssetType.WalkAnimation", "PoseAnimation": "@roblox/enum/AssetType.PoseAnimation", "EarAccessory": "@roblox/enum/AssetType.EarAccessory", "EyeAccessory": "@roblox/enum/AssetType.EyeAccessory", "EmoteAnimation": "@roblox/enum/AssetType.EmoteAnimation", "Video": "@roblox/enum/AssetType.Video", "TShirtAccessory": "@roblox/enum/AssetType.TShirtAccessory", "ShirtAccessory": "@roblox/enum/AssetType.ShirtAccessory", "PantsAccessory": "@roblox/enum/AssetType.PantsAccessory", "JacketAccessory": "@roblox/enum/AssetType.JacketAccessory", "SweaterAccessory": "@roblox/enum/AssetType.SweaterAccessory", "ShortsAccessory": "@roblox/enum/AssetType.ShortsAccessory", "LeftShoeAccessory": "@roblox/enum/AssetType.LeftShoeAccessory", "RightShoeAccessory": "@roblox/enum/AssetType.RightShoeAccessory", "DressSkirtAccessory": "@roblox/enum/AssetType.DressSkirtAccessory", "FontFamily": "@roblox/enum/AssetType.FontFamily", "EyebrowAccessory": "@roblox/enum/AssetType.EyebrowAccessory", "EyelashAccessory": "@roblox/enum/AssetType.EyelashAccessory", "MoodAnimation": "@roblox/enum/AssetType.MoodAnimation", "DynamicHead": "@roblox/enum/AssetType.DynamicHead", "FaceMakeup": "@roblox/enum/AssetType.FaceMakeup", "LipMakeup": "@roblox/enum/AssetType.LipMakeup", "EyeMakeup": "@roblox/enum/AssetType.EyeMakeup" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AssetType", "code_sample": "" }, "@roblox/enum/HumanoidStateType.FallingDown": { "documentation": "The Humanoid has been tripped, and will attempt to get up in a few moments.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#FallingDown", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Ragdoll": { "documentation": "(Deprecated) The Humanoid has been hit by a fast moving object (uncontrolled falling). The Humanoid can recover from this. This state has to be set and unset manually using Humanoid:ChangeState().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Ragdoll", "code_sample": "" }, "@roblox/enum/HumanoidStateType.GettingUp": { "documentation": "The Humanoid is getting back on their feet after FallingDown or Ragdoll.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#GettingUp", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Jumping": { "documentation": "The Humanoid just jumped. (Check Humanoid.Jump). This state lasts only briefly. This state normally transitions into either Landed, if on the ground, or Freefall, if still in the air.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Jumping", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Swimming": { "documentation": "The Humanoid is currently swimming in Terrain water.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Swimming", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Freefall": { "documentation": "The Humanoid is currently freefalling (jumped from a height or fell off a ledge).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Freefall", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Flying": { "documentation": "When set, the Humanoid won't be animated, as with the Humanoid.PlatformStand property. This state lasts as long as the player flies.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Flying", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Landed": { "documentation": "The Humanoid touched the ground after a Freefall. This state lasts only briefly.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Landed", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Running": { "documentation": "Currently running while on the ground.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Running", "code_sample": "" }, "@roblox/enum/HumanoidStateType.RunningNoPhysics": { "documentation": "(Deprecated) Currently running and not near other physical objects.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#RunningNoPhysics", "code_sample": "" }, "@roblox/enum/HumanoidStateType.StrafingNoPhysics": { "documentation": "Not currently used with default Humanoid. Cannot be set with Humanoid:ChangeState().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#StrafingNoPhysics", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Climbing": { "documentation": "The Humanoid is climbing (e.g. up a TrussPart or ladder).", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Climbing", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Seated": { "documentation": "The Humanoid is currently sitting in a Seat or VehicleSeat. Check the Humanoid.Sit property.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Seated", "code_sample": "" }, "@roblox/enum/HumanoidStateType.PlatformStanding": { "documentation": "The Humanoid is platformstanding. Check the Humanoid.PlatformStand property.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#PlatformStanding", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Dead": { "documentation": "The Humanoid died. Changing a Humanoid's state to this state will kill it.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Dead", "code_sample": "" }, "@roblox/enum/HumanoidStateType.Physics": { "documentation": "The Humanoid doesn't apply any force on its own and will not automatically transition to any other state. This state has to be set and unset manually using Humanoid:ChangeState().", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#Physics", "code_sample": "" }, "@roblox/enum/HumanoidStateType.None": { "documentation": "Unusable placeholder in case an unknown state gets triggered internally.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType#None", "code_sample": "" }, "@roblox/global/Enum.HumanoidStateType": { "documentation": "Describes the physics control states within the Humanoid.", "keys": { "FallingDown": "@roblox/enum/HumanoidStateType.FallingDown", "Ragdoll": "@roblox/enum/HumanoidStateType.Ragdoll", "GettingUp": "@roblox/enum/HumanoidStateType.GettingUp", "Jumping": "@roblox/enum/HumanoidStateType.Jumping", "Swimming": "@roblox/enum/HumanoidStateType.Swimming", "Freefall": "@roblox/enum/HumanoidStateType.Freefall", "Flying": "@roblox/enum/HumanoidStateType.Flying", "Landed": "@roblox/enum/HumanoidStateType.Landed", "Running": "@roblox/enum/HumanoidStateType.Running", "RunningNoPhysics": "@roblox/enum/HumanoidStateType.RunningNoPhysics", "StrafingNoPhysics": "@roblox/enum/HumanoidStateType.StrafingNoPhysics", "Climbing": "@roblox/enum/HumanoidStateType.Climbing", "Seated": "@roblox/enum/HumanoidStateType.Seated", "PlatformStanding": "@roblox/enum/HumanoidStateType.PlatformStanding", "Dead": "@roblox/enum/HumanoidStateType.Dead", "Physics": "@roblox/enum/HumanoidStateType.Physics", "None": "@roblox/enum/HumanoidStateType.None" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType", "code_sample": "" }, "@roblox/enum/ServiceVisibility.Always": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServiceVisibility#Always", "code_sample": "" }, "@roblox/enum/ServiceVisibility.Off": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServiceVisibility#Off", "code_sample": "" }, "@roblox/enum/ServiceVisibility.WithChildren": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServiceVisibility#WithChildren", "code_sample": "" }, "@roblox/global/Enum.ServiceVisibility": { "documentation": "", "keys": { "Always": "@roblox/enum/ServiceVisibility.Always", "Off": "@roblox/enum/ServiceVisibility.Off", "WithChildren": "@roblox/enum/ServiceVisibility.WithChildren" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ServiceVisibility", "code_sample": "" }, "@roblox/enum/FacialAgeEstimationResultType.Complete": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType#Complete", "code_sample": "" }, "@roblox/enum/FacialAgeEstimationResultType.Cancel": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType#Cancel", "code_sample": "" }, "@roblox/enum/FacialAgeEstimationResultType.Error": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType#Error", "code_sample": "" }, "@roblox/global/Enum.FacialAgeEstimationResultType": { "documentation": "", "keys": { "Complete": "@roblox/enum/FacialAgeEstimationResultType.Complete", "Cancel": "@roblox/enum/FacialAgeEstimationResultType.Cancel", "Error": "@roblox/enum/FacialAgeEstimationResultType.Error" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/FacialAgeEstimationResultType", "code_sample": "" }, "@roblox/enum/PredictionMode.Automatic": { "documentation": "The engine will automatically decide if this instance should be predicted or not. Currently, only BaseParts near the local player character's Humanoid will be predicted within a dynamic radius that grows and shrinks based on the device's capability to handle the simulation load.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Automatic", "code_sample": "" }, "@roblox/enum/PredictionMode.On": { "documentation": "The instance will be predicted. Mismatches in the attributes of this instance between the client and server will cause a rollback and resimulation. If the instance is a BasePart, its physics properties will be predicted ahead of the replicated authoritative server state.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionMode#On", "code_sample": "" }, "@roblox/enum/PredictionMode.Off": { "documentation": "The instance will not be predicted. Regular network ownership semantics apply.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionMode#Off", "code_sample": "" }, "@roblox/global/Enum.PredictionMode": { "documentation": "Enum used with RunService:SetPredictionMode() to define the prediction mode for the instance.", "keys": { "Automatic": "@roblox/enum/PredictionMode.Automatic", "On": "@roblox/enum/PredictionMode.On", "Off": "@roblox/enum/PredictionMode.Off" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/PredictionMode", "code_sample": "" }, "@roblox/enum/ReadCapturesFromGalleryResult.Success": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReadCapturesFromGalleryResult#Success", "code_sample": "" }, "@roblox/enum/ReadCapturesFromGalleryResult.NeedPermission": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReadCapturesFromGalleryResult#NeedPermission", "code_sample": "" }, "@roblox/global/Enum.ReadCapturesFromGalleryResult": { "documentation": "", "keys": { "Success": "@roblox/enum/ReadCapturesFromGalleryResult.Success", "NeedPermission": "@roblox/enum/ReadCapturesFromGalleryResult.NeedPermission" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ReadCapturesFromGalleryResult", "code_sample": "" }, "@roblox/enum/ContextActionResult.Sink": { "documentation": "If functionToBind from ContextActionService:BindAction() returns ContextActionResult.Sink, the input event will stop at that function and no other bound actions under it will be processed. This is the default behavior if functionToBind does not return anything or yields in any way.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionResult#Sink", "code_sample": "" }, "@roblox/enum/ContextActionResult.Pass": { "documentation": "If functionToBind from ContextActionService:BindAction() returns ContextActionResult.Pass, the input event is considered to have not been handled by functionToBind and will continue being passed to actions bound to the same input type.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionResult#Pass", "code_sample": "" }, "@roblox/global/Enum.ContextActionResult": { "documentation": "Describes whether a contextual action should sink or pass input events.", "keys": { "Sink": "@roblox/enum/ContextActionResult.Sink", "Pass": "@roblox/enum/ContextActionResult.Pass" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/ContextActionResult", "code_sample": "" }, "@roblox/enum/AvatarSettingsAccessoryMode.PlayerChoice": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode#PlayerChoice", "code_sample": "" }, "@roblox/enum/AvatarSettingsAccessoryMode.CustomLimit": { "documentation": "", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode#CustomLimit", "code_sample": "" }, "@roblox/global/Enum.AvatarSettingsAccessoryMode": { "documentation": "", "keys": { "PlayerChoice": "@roblox/enum/AvatarSettingsAccessoryMode.PlayerChoice", "CustomLimit": "@roblox/enum/AvatarSettingsAccessoryMode.CustomLimit" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/AvatarSettingsAccessoryMode", "code_sample": "" }, "@roblox/enum/IKCollisionsMode.NoCollisions": { "documentation": "Only the part and any parts directly joined to it via joints/constraints be involved in the resolution, everything else in the workspace will be treated as though it doesn't exist.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKCollisionsMode#NoCollisions", "code_sample": "" }, "@roblox/enum/IKCollisionsMode.OtherMechanismsAnchored": { "documentation": "Only the part and any parts directly jointed to it via joints/constraints will be moved during resolution, but they will collide with other objects in the workspace.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKCollisionsMode#OtherMechanismsAnchored", "code_sample": "" }, "@roblox/enum/IKCollisionsMode.IncludeContactedMechanisms": { "documentation": "The part, any parts directly joined to it via joints/constraints, and any parts which it comes into contact with during the solve will be moved during the resolution. That is, the moved parts will be allowed to \"push\" other unanchored parts in the workspace out of the way in order to get to the target position.", "keys": { "Name": "@roblox/globaltype/EnumItem.Name", "Value": "@roblox/globaltype/EnumItem.Value", "EnumType": "@roblox/globaltype/EnumItem.EnumType" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKCollisionsMode#IncludeContactedMechanisms", "code_sample": "" }, "@roblox/global/Enum.IKCollisionsMode": { "documentation": "", "keys": { "NoCollisions": "@roblox/enum/IKCollisionsMode.NoCollisions", "OtherMechanismsAnchored": "@roblox/enum/IKCollisionsMode.OtherMechanismsAnchored", "IncludeContactedMechanisms": "@roblox/enum/IKCollisionsMode.IncludeContactedMechanisms" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/enums/IKCollisionsMode", "code_sample": "" }, "@luau/global/math": { "documentation": "A library of math functions.", "keys": { "abs": "@luau/global/math.abs", "acos": "@luau/global/math.acos", "asin": "@luau/global/math.asin", "atan": "@luau/global/math.atan", "atan2": "@luau/global/math.atan2", "ceil": "@luau/global/math.ceil", "clamp": "@luau/global/math.clamp", "cos": "@luau/global/math.cos", "cosh": "@luau/global/math.cosh", "deg": "@luau/global/math.deg", "exp": "@luau/global/math.exp", "floor": "@luau/global/math.floor", "fmod": "@luau/global/math.fmod", "frexp": "@luau/global/math.frexp", "ldexp": "@luau/global/math.ldexp", "lerp": "@luau/global/math.lerp", "log": "@luau/global/math.log", "log10": "@luau/global/math.log10", "map": "@luau/global/math.map", "max": "@luau/global/math.max", "min": "@luau/global/math.min", "modf": "@luau/global/math.modf", "noise": "@luau/global/math.noise", "pow": "@luau/global/math.pow", "rad": "@luau/global/math.rad", "random": "@luau/global/math.random", "randomseed": "@luau/global/math.randomseed", "round": "@luau/global/math.round", "sign": "@luau/global/math.sign", "sin": "@luau/global/math.sin", "sinh": "@luau/global/math.sinh", "sqrt": "@luau/global/math.sqrt", "tan": "@luau/global/math.tan", "tanh": "@luau/global/math.tanh", "huge": "@luau/global/math.huge", "pi": "@luau/global/math.pi" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math", "code_sample": "" }, "@luau/global/math.abs/param/0": { "documentation": "" }, "@luau/global/math.abs/return/0": { "documentation": "" }, "@luau/global/math.abs": { "documentation": "Returns the absolute value of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.abs/param/0" } ], "returns": [ "@luau/global/math.abs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#abs", "code_sample": "" }, "@luau/global/math.acos/param/0": { "documentation": "" }, "@luau/global/math.acos/return/0": { "documentation": "" }, "@luau/global/math.acos": { "documentation": "Returns the arc cosine of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.acos/param/0" } ], "returns": [ "@luau/global/math.acos/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#acos", "code_sample": "" }, "@luau/global/math.asin/param/0": { "documentation": "" }, "@luau/global/math.asin/return/0": { "documentation": "" }, "@luau/global/math.asin": { "documentation": "Returns the arc sine of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.asin/param/0" } ], "returns": [ "@luau/global/math.asin/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#asin", "code_sample": "" }, "@luau/global/math.atan/param/0": { "documentation": "" }, "@luau/global/math.atan/return/0": { "documentation": "" }, "@luau/global/math.atan": { "documentation": "Returns the arc tangent of x in radians.", "params": [ { "name": "x", "documentation": "@luau/global/math.atan/param/0" } ], "returns": [ "@luau/global/math.atan/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#atan", "code_sample": "" }, "@luau/global/math.atan2/param/0": { "documentation": "" }, "@luau/global/math.atan2/param/1": { "documentation": "" }, "@luau/global/math.atan2/return/0": { "documentation": "" }, "@luau/global/math.atan2": { "documentation": "Returns the arc tangent of y/x (in radians) while using the signs of both parameters to find the quadrant of the result.", "params": [ { "name": "y", "documentation": "@luau/global/math.atan2/param/0" }, { "name": "x", "documentation": "@luau/global/math.atan2/param/1" } ], "returns": [ "@luau/global/math.atan2/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#atan2", "code_sample": "" }, "@luau/global/math.ceil/param/0": { "documentation": "" }, "@luau/global/math.ceil/return/0": { "documentation": "" }, "@luau/global/math.ceil": { "documentation": "Returns the smallest integer larger than or equal to x.", "params": [ { "name": "x", "documentation": "@luau/global/math.ceil/param/0" } ], "returns": [ "@luau/global/math.ceil/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#ceil", "code_sample": "" }, "@luau/global/math.clamp/param/0": { "documentation": "" }, "@luau/global/math.clamp/param/1": { "documentation": "" }, "@luau/global/math.clamp/param/2": { "documentation": "" }, "@luau/global/math.clamp/return/0": { "documentation": "" }, "@luau/global/math.clamp": { "documentation": "Returns a number between min and max, inclusive.", "params": [ { "name": "x", "documentation": "@luau/global/math.clamp/param/0" }, { "name": "min", "documentation": "@luau/global/math.clamp/param/1" }, { "name": "max", "documentation": "@luau/global/math.clamp/param/2" } ], "returns": [ "@luau/global/math.clamp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#clamp", "code_sample": "" }, "@luau/global/math.cos/param/0": { "documentation": "" }, "@luau/global/math.cos/return/0": { "documentation": "" }, "@luau/global/math.cos": { "documentation": "Returns the cosine of x, assumed to be in radians.", "params": [ { "name": "x", "documentation": "@luau/global/math.cos/param/0" } ], "returns": [ "@luau/global/math.cos/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#cos", "code_sample": "" }, "@luau/global/math.cosh/param/0": { "documentation": "" }, "@luau/global/math.cosh/return/0": { "documentation": "" }, "@luau/global/math.cosh": { "documentation": "Returns the hyperbolic cosine of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.cosh/param/0" } ], "returns": [ "@luau/global/math.cosh/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#cosh", "code_sample": "" }, "@luau/global/math.deg/param/0": { "documentation": "" }, "@luau/global/math.deg/return/0": { "documentation": "" }, "@luau/global/math.deg": { "documentation": "Returns the angle x (given in radians) in degrees.", "params": [ { "name": "x", "documentation": "@luau/global/math.deg/param/0" } ], "returns": [ "@luau/global/math.deg/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#deg", "code_sample": "" }, "@luau/global/math.exp/param/0": { "documentation": "" }, "@luau/global/math.exp/return/0": { "documentation": "" }, "@luau/global/math.exp": { "documentation": "Returns the value e^x.", "params": [ { "name": "x", "documentation": "@luau/global/math.exp/param/0" } ], "returns": [ "@luau/global/math.exp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#exp", "code_sample": "" }, "@luau/global/math.floor/param/0": { "documentation": "" }, "@luau/global/math.floor/return/0": { "documentation": "" }, "@luau/global/math.floor": { "documentation": "Returns the largest integer smaller than or equal to x.", "params": [ { "name": "x", "documentation": "@luau/global/math.floor/param/0" } ], "returns": [ "@luau/global/math.floor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#floor", "code_sample": "" }, "@luau/global/math.fmod/param/0": { "documentation": "" }, "@luau/global/math.fmod/param/1": { "documentation": "" }, "@luau/global/math.fmod/return/0": { "documentation": "" }, "@luau/global/math.fmod": { "documentation": "Returns the remainder of the division of x by y that rounds the quotient towards zero.", "params": [ { "name": "x", "documentation": "@luau/global/math.fmod/param/0" }, { "name": "y", "documentation": "@luau/global/math.fmod/param/1" } ], "returns": [ "@luau/global/math.fmod/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#fmod", "code_sample": "" }, "@luau/global/math.frexp/param/0": { "documentation": "" }, "@luau/global/math.frexp/return/0": { "documentation": "" }, "@luau/global/math.frexp/return/1": { "documentation": "" }, "@luau/global/math.frexp": { "documentation": "Returns m and e such that x = m*2^e.", "params": [ { "name": "x", "documentation": "@luau/global/math.frexp/param/0" } ], "returns": [ "@luau/global/math.frexp/return/0", "@luau/global/math.frexp/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#frexp", "code_sample": "" }, "@luau/global/math.ldexp/param/0": { "documentation": "" }, "@luau/global/math.ldexp/param/1": { "documentation": "" }, "@luau/global/math.ldexp/return/0": { "documentation": "" }, "@luau/global/math.ldexp": { "documentation": "Returns x*2^e (e should be an integer).", "params": [ { "name": "x", "documentation": "@luau/global/math.ldexp/param/0" }, { "name": "e", "documentation": "@luau/global/math.ldexp/param/1" } ], "returns": [ "@luau/global/math.ldexp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#ldexp", "code_sample": "" }, "@luau/global/math.lerp/param/0": { "documentation": "The starting value." }, "@luau/global/math.lerp/param/1": { "documentation": "The ending value." }, "@luau/global/math.lerp/param/2": { "documentation": "The interpolation factor, typically between 0 and 1." }, "@luau/global/math.lerp/return/0": { "documentation": "The interpolated value between a and b." }, "@luau/global/math.lerp": { "documentation": "Returns the linear interpolation between a and b.", "params": [ { "name": "a", "documentation": "@luau/global/math.lerp/param/0" }, { "name": "b", "documentation": "@luau/global/math.lerp/param/1" }, { "name": "t", "documentation": "@luau/global/math.lerp/param/2" } ], "returns": [ "@luau/global/math.lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#lerp", "code_sample": "" }, "@luau/global/math.log/param/0": { "documentation": "" }, "@luau/global/math.log/param/1": { "documentation": "The base of the logarithm, the constant e by default." }, "@luau/global/math.log/return/0": { "documentation": "" }, "@luau/global/math.log": { "documentation": "Returns the logarithm of x using the given base.", "params": [ { "name": "x", "documentation": "@luau/global/math.log/param/0" }, { "name": "base", "documentation": "@luau/global/math.log/param/1" } ], "returns": [ "@luau/global/math.log/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#log", "code_sample": "" }, "@luau/global/math.log10/param/0": { "documentation": "" }, "@luau/global/math.log10/return/0": { "documentation": "" }, "@luau/global/math.log10": { "documentation": "Returns the base-10 logarithm of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.log10/param/0" } ], "returns": [ "@luau/global/math.log10/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#log10", "code_sample": "" }, "@luau/global/math.map/param/0": { "documentation": "The number to be mapped." }, "@luau/global/math.map/param/1": { "documentation": "The lower bound of the input range." }, "@luau/global/math.map/param/2": { "documentation": "The upper bound of the input range." }, "@luau/global/math.map/param/3": { "documentation": "The lower bound of the output range." }, "@luau/global/math.map/param/4": { "documentation": "The upper bound of the output range." }, "@luau/global/math.map/return/0": { "documentation": "The value of x mapped to the output range." }, "@luau/global/math.map": { "documentation": "Returns the value of x mapped from one range to another.", "params": [ { "name": "x", "documentation": "@luau/global/math.map/param/0" }, { "name": "inmin", "documentation": "@luau/global/math.map/param/1" }, { "name": "inmax", "documentation": "@luau/global/math.map/param/2" }, { "name": "outmin", "documentation": "@luau/global/math.map/param/3" }, { "name": "outmax", "documentation": "@luau/global/math.map/param/4" } ], "returns": [ "@luau/global/math.map/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#map", "code_sample": "" }, "@luau/global/math.max/param/0": { "documentation": "" }, "@luau/global/math.max/param/1": { "documentation": "" }, "@luau/global/math.max/return/0": { "documentation": "" }, "@luau/global/math.max": { "documentation": "Returns the maximum value among the numbers passed to the function.", "params": [ { "name": "x", "documentation": "@luau/global/math.max/param/0" }, { "name": "...", "documentation": "@luau/global/math.max/param/1" } ], "returns": [ "@luau/global/math.max/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#max", "code_sample": "" }, "@luau/global/math.min/param/0": { "documentation": "" }, "@luau/global/math.min/param/1": { "documentation": "" }, "@luau/global/math.min/return/0": { "documentation": "" }, "@luau/global/math.min": { "documentation": "Returns the minimum value among the numbers passed to the function.", "params": [ { "name": "x", "documentation": "@luau/global/math.min/param/0" }, { "name": "...", "documentation": "@luau/global/math.min/param/1" } ], "returns": [ "@luau/global/math.min/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#min", "code_sample": "" }, "@luau/global/math.modf/param/0": { "documentation": "" }, "@luau/global/math.modf/return/0": { "documentation": "" }, "@luau/global/math.modf/return/1": { "documentation": "" }, "@luau/global/math.modf": { "documentation": "Returns two numbers: the integral part of x and the fractional part of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.modf/param/0" } ], "returns": [ "@luau/global/math.modf/return/0", "@luau/global/math.modf/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#modf", "code_sample": "" }, "@luau/global/math.noise/param/0": { "documentation": "" }, "@luau/global/math.noise/param/1": { "documentation": "" }, "@luau/global/math.noise/param/2": { "documentation": "" }, "@luau/global/math.noise/return/0": { "documentation": "" }, "@luau/global/math.noise": { "documentation": "Returns a Perlin noise value.", "params": [ { "name": "x", "documentation": "@luau/global/math.noise/param/0" }, { "name": "y", "documentation": "@luau/global/math.noise/param/1" }, { "name": "z", "documentation": "@luau/global/math.noise/param/2" } ], "returns": [ "@luau/global/math.noise/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#noise", "code_sample": "" }, "@luau/global/math.pow/param/0": { "documentation": "" }, "@luau/global/math.pow/param/1": { "documentation": "" }, "@luau/global/math.pow/return/0": { "documentation": "" }, "@luau/global/math.pow": { "documentation": "Returns x^y.", "params": [ { "name": "x", "documentation": "@luau/global/math.pow/param/0" }, { "name": "y", "documentation": "@luau/global/math.pow/param/1" } ], "returns": [ "@luau/global/math.pow/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#pow", "code_sample": "" }, "@luau/global/math.rad/param/0": { "documentation": "" }, "@luau/global/math.rad/return/0": { "documentation": "" }, "@luau/global/math.rad": { "documentation": "Returns the angle x (given in degrees) in radians.", "params": [ { "name": "x", "documentation": "@luau/global/math.rad/param/0" } ], "returns": [ "@luau/global/math.rad/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#rad", "code_sample": "" }, "@luau/global/math.random/param/0": { "documentation": "" }, "@luau/global/math.random/param/1": { "documentation": "" }, "@luau/global/math.random/return/0": { "documentation": "" }, "@luau/global/math.random": { "documentation": "Returns a random number within the range provided.", "params": [ { "name": "m", "documentation": "@luau/global/math.random/param/0" }, { "name": "n", "documentation": "@luau/global/math.random/param/1" } ], "returns": [ "@luau/global/math.random/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#random", "code_sample": "" }, "@luau/global/math.randomseed/param/0": { "documentation": "" }, "@luau/global/math.randomseed": { "documentation": "Sets x as the seed for the pseudo-random generator.", "params": [ { "name": "x", "documentation": "@luau/global/math.randomseed/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#randomseed", "code_sample": "" }, "@luau/global/math.round/param/0": { "documentation": "The value to be rounded." }, "@luau/global/math.round/return/0": { "documentation": "" }, "@luau/global/math.round": { "documentation": "Returns the integer with the smallest difference between it and the given number.", "params": [ { "name": "x", "documentation": "@luau/global/math.round/param/0" } ], "returns": [ "@luau/global/math.round/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#round", "code_sample": "" }, "@luau/global/math.sign/param/0": { "documentation": "" }, "@luau/global/math.sign/return/0": { "documentation": "" }, "@luau/global/math.sign": { "documentation": "Returns -1 if x is less than 0, 0 if x equals 0, or 1 if x is greater than 0.", "params": [ { "name": "x", "documentation": "@luau/global/math.sign/param/0" } ], "returns": [ "@luau/global/math.sign/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sign", "code_sample": "" }, "@luau/global/math.sin/param/0": { "documentation": "" }, "@luau/global/math.sin/return/0": { "documentation": "" }, "@luau/global/math.sin": { "documentation": "Returns the sine of x, assumed to be in radians.", "params": [ { "name": "x", "documentation": "@luau/global/math.sin/param/0" } ], "returns": [ "@luau/global/math.sin/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sin", "code_sample": "" }, "@luau/global/math.sinh/param/0": { "documentation": "" }, "@luau/global/math.sinh/return/0": { "documentation": "" }, "@luau/global/math.sinh": { "documentation": "Returns the hyperbolic sine of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.sinh/param/0" } ], "returns": [ "@luau/global/math.sinh/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sinh", "code_sample": "" }, "@luau/global/math.sqrt/param/0": { "documentation": "" }, "@luau/global/math.sqrt/return/0": { "documentation": "" }, "@luau/global/math.sqrt": { "documentation": "Returns the square root of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.sqrt/param/0" } ], "returns": [ "@luau/global/math.sqrt/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#sqrt", "code_sample": "" }, "@luau/global/math.tan/param/0": { "documentation": "" }, "@luau/global/math.tan/return/0": { "documentation": "" }, "@luau/global/math.tan": { "documentation": "Returns the tangent of x, assumed to be in radians.", "params": [ { "name": "x", "documentation": "@luau/global/math.tan/param/0" } ], "returns": [ "@luau/global/math.tan/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#tan", "code_sample": "" }, "@luau/global/math.tanh/param/0": { "documentation": "" }, "@luau/global/math.tanh/return/0": { "documentation": "" }, "@luau/global/math.tanh": { "documentation": "Returns the hyperbolic tangent of x.", "params": [ { "name": "x", "documentation": "@luau/global/math.tanh/param/0" } ], "returns": [ "@luau/global/math.tanh/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#tanh", "code_sample": "" }, "@luau/global/math.huge": { "documentation": "Returns a value larger than or equal to any other numerical value (about 21024).", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#huge", "code_sample": "" }, "@luau/global/math.pi": { "documentation": "The value of pi.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/math#pi", "code_sample": "" }, "@luau/global/bit32": { "documentation": "A library of functions to perform bitwise operations.", "keys": { "arshift": "@luau/global/bit32.arshift", "band": "@luau/global/bit32.band", "bnot": "@luau/global/bit32.bnot", "bor": "@luau/global/bit32.bor", "btest": "@luau/global/bit32.btest", "bxor": "@luau/global/bit32.bxor", "byteswap": "@luau/global/bit32.byteswap", "countlz": "@luau/global/bit32.countlz", "countrz": "@luau/global/bit32.countrz", "extract": "@luau/global/bit32.extract", "replace": "@luau/global/bit32.replace", "lrotate": "@luau/global/bit32.lrotate", "lshift": "@luau/global/bit32.lshift", "rrotate": "@luau/global/bit32.rrotate", "rshift": "@luau/global/bit32.rshift" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32", "code_sample": "" }, "@luau/global/bit32.arshift/param/0": { "documentation": "The number whose bits shall be shifted." }, "@luau/global/bit32.arshift/param/1": { "documentation": "The integer number of bits to shift by." }, "@luau/global/bit32.arshift/return/0": { "documentation": "" }, "@luau/global/bit32.arshift": { "documentation": "Returns a number after its bits have been arithmetically shifted to the right by a given displacement.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.arshift/param/0" }, { "name": "disp", "documentation": "@luau/global/bit32.arshift/param/1" } ], "returns": [ "@luau/global/bit32.arshift/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#arshift", "code_sample": "" }, "@luau/global/bit32.band/param/0": { "documentation": "" }, "@luau/global/bit32.band/return/0": { "documentation": "" }, "@luau/global/bit32.band": { "documentation": "Returns the bitwise AND of all provided numbers.", "params": [ { "name": "numbers", "documentation": "@luau/global/bit32.band/param/0" } ], "returns": [ "@luau/global/bit32.band/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#band", "code_sample": "" }, "@luau/global/bit32.bnot/param/0": { "documentation": "" }, "@luau/global/bit32.bnot/return/0": { "documentation": "" }, "@luau/global/bit32.bnot": { "documentation": "Returns the bitwise negation of a given number.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.bnot/param/0" } ], "returns": [ "@luau/global/bit32.bnot/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#bnot", "code_sample": "" }, "@luau/global/bit32.bor/param/0": { "documentation": "" }, "@luau/global/bit32.bor/return/0": { "documentation": "" }, "@luau/global/bit32.bor": { "documentation": "Returns the bitwise OR of all provided numbers.", "params": [ { "name": "numbers", "documentation": "@luau/global/bit32.bor/param/0" } ], "returns": [ "@luau/global/bit32.bor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#bor", "code_sample": "" }, "@luau/global/bit32.btest/param/0": { "documentation": "" }, "@luau/global/bit32.btest/return/0": { "documentation": "" }, "@luau/global/bit32.btest": { "documentation": "Returns a boolean describing whether the bitwise and of its operands is different from zero.", "params": [ { "name": "numbers", "documentation": "@luau/global/bit32.btest/param/0" } ], "returns": [ "@luau/global/bit32.btest/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#btest", "code_sample": "" }, "@luau/global/bit32.bxor/param/0": { "documentation": "" }, "@luau/global/bit32.bxor/return/0": { "documentation": "" }, "@luau/global/bit32.bxor": { "documentation": "Returns the bitwise XOR of all provided numbers.", "params": [ { "name": "numbers", "documentation": "@luau/global/bit32.bxor/param/0" } ], "returns": [ "@luau/global/bit32.bxor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#bxor", "code_sample": "" }, "@luau/global/bit32.byteswap/param/0": { "documentation": "" }, "@luau/global/bit32.byteswap/return/0": { "documentation": "" }, "@luau/global/bit32.byteswap": { "documentation": "Returns the given number with the order of the bytes swapped.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.byteswap/param/0" } ], "returns": [ "@luau/global/bit32.byteswap/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#byteswap", "code_sample": "" }, "@luau/global/bit32.countlz/param/0": { "documentation": "" }, "@luau/global/bit32.countlz/return/0": { "documentation": "" }, "@luau/global/bit32.countlz": { "documentation": "Returns the number of consecutive zero bits in the 32-bit representation of the provided number starting from the left-most (most significant) bit.", "params": [ { "name": "n", "documentation": "@luau/global/bit32.countlz/param/0" } ], "returns": [ "@luau/global/bit32.countlz/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#countlz", "code_sample": "" }, "@luau/global/bit32.countrz/param/0": { "documentation": "" }, "@luau/global/bit32.countrz/return/0": { "documentation": "" }, "@luau/global/bit32.countrz": { "documentation": "Returns the number of consecutive zero bits in the 32-bit representation of the provided number starting from the right-most (least significant) bit.", "params": [ { "name": "n", "documentation": "@luau/global/bit32.countrz/param/0" } ], "returns": [ "@luau/global/bit32.countrz/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#countrz", "code_sample": "" }, "@luau/global/bit32.extract/param/0": { "documentation": "" }, "@luau/global/bit32.extract/param/1": { "documentation": "" }, "@luau/global/bit32.extract/param/2": { "documentation": "" }, "@luau/global/bit32.extract/return/0": { "documentation": "" }, "@luau/global/bit32.extract": { "documentation": "Extract a range of bits from a number and return them as an unsigned number.", "params": [ { "name": "n", "documentation": "@luau/global/bit32.extract/param/0" }, { "name": "field", "documentation": "@luau/global/bit32.extract/param/1" }, { "name": "width", "documentation": "@luau/global/bit32.extract/param/2" } ], "returns": [ "@luau/global/bit32.extract/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#extract", "code_sample": "" }, "@luau/global/bit32.replace/param/0": { "documentation": "" }, "@luau/global/bit32.replace/param/1": { "documentation": "" }, "@luau/global/bit32.replace/param/2": { "documentation": "" }, "@luau/global/bit32.replace/param/3": { "documentation": "" }, "@luau/global/bit32.replace/return/0": { "documentation": "" }, "@luau/global/bit32.replace": { "documentation": "Return a copy of a number with a range of bits replaced by a given value.", "params": [ { "name": "n", "documentation": "@luau/global/bit32.replace/param/0" }, { "name": "v", "documentation": "@luau/global/bit32.replace/param/1" }, { "name": "field", "documentation": "@luau/global/bit32.replace/param/2" }, { "name": "width", "documentation": "@luau/global/bit32.replace/param/3" } ], "returns": [ "@luau/global/bit32.replace/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#replace", "code_sample": "" }, "@luau/global/bit32.lrotate/param/0": { "documentation": "" }, "@luau/global/bit32.lrotate/param/1": { "documentation": "" }, "@luau/global/bit32.lrotate/return/0": { "documentation": "" }, "@luau/global/bit32.lrotate": { "documentation": "Returns a number after its bits have been rotated to the left by a given number of times.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.lrotate/param/0" }, { "name": "disp", "documentation": "@luau/global/bit32.lrotate/param/1" } ], "returns": [ "@luau/global/bit32.lrotate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#lrotate", "code_sample": "" }, "@luau/global/bit32.lshift/param/0": { "documentation": "" }, "@luau/global/bit32.lshift/param/1": { "documentation": "" }, "@luau/global/bit32.lshift/return/0": { "documentation": "" }, "@luau/global/bit32.lshift": { "documentation": "Returns a number whose bits have been logically shifted to the left by a given displacement.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.lshift/param/0" }, { "name": "disp", "documentation": "@luau/global/bit32.lshift/param/1" } ], "returns": [ "@luau/global/bit32.lshift/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#lshift", "code_sample": "" }, "@luau/global/bit32.rrotate/param/0": { "documentation": "" }, "@luau/global/bit32.rrotate/param/1": { "documentation": "" }, "@luau/global/bit32.rrotate/return/0": { "documentation": "" }, "@luau/global/bit32.rrotate": { "documentation": "Returns a number after its bits have been rotated to the right by a given number of times.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.rrotate/param/0" }, { "name": "disp", "documentation": "@luau/global/bit32.rrotate/param/1" } ], "returns": [ "@luau/global/bit32.rrotate/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#rrotate", "code_sample": "" }, "@luau/global/bit32.rshift/param/0": { "documentation": "" }, "@luau/global/bit32.rshift/param/1": { "documentation": "" }, "@luau/global/bit32.rshift/return/0": { "documentation": "" }, "@luau/global/bit32.rshift": { "documentation": "Returns a number whose bits have been logically shifted to the right by a given displacement.", "params": [ { "name": "x", "documentation": "@luau/global/bit32.rshift/param/0" }, { "name": "disp", "documentation": "@luau/global/bit32.rshift/param/1" } ], "returns": [ "@luau/global/bit32.rshift/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/bit32#rshift", "code_sample": "" }, "@luau/global/buffer": { "documentation": "A library of buffer functions.", "keys": { "create": "@luau/global/buffer.create", "fromstring": "@luau/global/buffer.fromstring", "tostring": "@luau/global/buffer.tostring", "len": "@luau/global/buffer.len", "readbits": "@luau/global/buffer.readbits", "readi8": "@luau/global/buffer.readi8", "readu8": "@luau/global/buffer.readu8", "readi16": "@luau/global/buffer.readi16", "readu16": "@luau/global/buffer.readu16", "readi32": "@luau/global/buffer.readi32", "readu32": "@luau/global/buffer.readu32", "readf32": "@luau/global/buffer.readf32", "readf64": "@luau/global/buffer.readf64", "writebits": "@luau/global/buffer.writebits", "writei8": "@luau/global/buffer.writei8", "writeu8": "@luau/global/buffer.writeu8", "writei16": "@luau/global/buffer.writei16", "writeu16": "@luau/global/buffer.writeu16", "writei32": "@luau/global/buffer.writei32", "writeu32": "@luau/global/buffer.writeu32", "writef32": "@luau/global/buffer.writef32", "writef64": "@luau/global/buffer.writef64", "readstring": "@luau/global/buffer.readstring", "writestring": "@luau/global/buffer.writestring", "copy": "@luau/global/buffer.copy", "fill": "@luau/global/buffer.fill" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer", "code_sample": "" }, "@luau/global/buffer.create/param/0": { "documentation": "Size of the buffer in bytes. Must be a positive integer." }, "@luau/global/buffer.create/return/0": { "documentation": "" }, "@luau/global/buffer.create": { "documentation": "Creates a buffer.", "params": [ { "name": "size", "documentation": "@luau/global/buffer.create/param/0" } ], "returns": [ "@luau/global/buffer.create/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#create", "code_sample": "" }, "@luau/global/buffer.fromstring/param/0": { "documentation": "" }, "@luau/global/buffer.fromstring/return/0": { "documentation": "" }, "@luau/global/buffer.fromstring": { "documentation": "Creates a buffer from a string.", "params": [ { "name": "str", "documentation": "@luau/global/buffer.fromstring/param/0" } ], "returns": [ "@luau/global/buffer.fromstring/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#fromstring", "code_sample": "" }, "@luau/global/buffer.tostring/param/0": { "documentation": "" }, "@luau/global/buffer.tostring/return/0": { "documentation": "" }, "@luau/global/buffer.tostring": { "documentation": "Converts a buffer to a string.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.tostring/param/0" } ], "returns": [ "@luau/global/buffer.tostring/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#tostring", "code_sample": "" }, "@luau/global/buffer.len/param/0": { "documentation": "" }, "@luau/global/buffer.len/return/0": { "documentation": "" }, "@luau/global/buffer.len": { "documentation": "Returns the size of the buffer in bytes.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.len/param/0" } ], "returns": [ "@luau/global/buffer.len/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#len", "code_sample": "" }, "@luau/global/buffer.readbits/param/0": { "documentation": "" }, "@luau/global/buffer.readbits/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readbits/param/2": { "documentation": "Integer bit count to read. Error is thrown if this value is not in range of 0 to 32, inclusive." }, "@luau/global/buffer.readbits/return/0": { "documentation": "" }, "@luau/global/buffer.readbits": { "documentation": "Reads a range of bits into an unsigned integer from the buffer based on a specific bitCount integer from 0 to 32, inclusive.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readbits/param/0" }, { "name": "bitOffset", "documentation": "@luau/global/buffer.readbits/param/1" }, { "name": "bitCount", "documentation": "@luau/global/buffer.readbits/param/2" } ], "returns": [ "@luau/global/buffer.readbits/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readbits", "code_sample": "" }, "@luau/global/buffer.readi8/param/0": { "documentation": "" }, "@luau/global/buffer.readi8/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readi8/return/0": { "documentation": "" }, "@luau/global/buffer.readi8": { "documentation": "Reads an 8-bit signed integer from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readi8/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readi8/param/1" } ], "returns": [ "@luau/global/buffer.readi8/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readi8", "code_sample": "" }, "@luau/global/buffer.readu8/param/0": { "documentation": "" }, "@luau/global/buffer.readu8/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readu8/return/0": { "documentation": "" }, "@luau/global/buffer.readu8": { "documentation": "Reads an 8-bit unsigned integer from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readu8/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readu8/param/1" } ], "returns": [ "@luau/global/buffer.readu8/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readu8", "code_sample": "" }, "@luau/global/buffer.readi16/param/0": { "documentation": "" }, "@luau/global/buffer.readi16/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readi16/return/0": { "documentation": "" }, "@luau/global/buffer.readi16": { "documentation": "Reads a 16-bit signed integer from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readi16/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readi16/param/1" } ], "returns": [ "@luau/global/buffer.readi16/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readi16", "code_sample": "" }, "@luau/global/buffer.readu16/param/0": { "documentation": "" }, "@luau/global/buffer.readu16/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readu16/return/0": { "documentation": "" }, "@luau/global/buffer.readu16": { "documentation": "Reads a 16-bit unsigned integer from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readu16/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readu16/param/1" } ], "returns": [ "@luau/global/buffer.readu16/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readu16", "code_sample": "" }, "@luau/global/buffer.readi32/param/0": { "documentation": "" }, "@luau/global/buffer.readi32/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readi32/return/0": { "documentation": "" }, "@luau/global/buffer.readi32": { "documentation": "Reads a 32-bit signed integer from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readi32/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readi32/param/1" } ], "returns": [ "@luau/global/buffer.readi32/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readi32", "code_sample": "" }, "@luau/global/buffer.readu32/param/0": { "documentation": "" }, "@luau/global/buffer.readu32/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readu32/return/0": { "documentation": "" }, "@luau/global/buffer.readu32": { "documentation": "Reads a 32-bit unsigned integer from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readu32/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readu32/param/1" } ], "returns": [ "@luau/global/buffer.readu32/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readu32", "code_sample": "" }, "@luau/global/buffer.readf32/param/0": { "documentation": "" }, "@luau/global/buffer.readf32/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readf32/return/0": { "documentation": "" }, "@luau/global/buffer.readf32": { "documentation": "Reads a 32-bit floating-point value from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readf32/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readf32/param/1" } ], "returns": [ "@luau/global/buffer.readf32/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readf32", "code_sample": "" }, "@luau/global/buffer.readf64/param/0": { "documentation": "" }, "@luau/global/buffer.readf64/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readf64/return/0": { "documentation": "" }, "@luau/global/buffer.readf64": { "documentation": "Reads a 64-bit floating-point value from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readf64/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readf64/param/1" } ], "returns": [ "@luau/global/buffer.readf64/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readf64", "code_sample": "" }, "@luau/global/buffer.writebits/param/0": { "documentation": "" }, "@luau/global/buffer.writebits/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writebits/param/2": { "documentation": "Integer bit count to write. Error is thrown if this value is not in range of 0 to 32, inclusive." }, "@luau/global/buffer.writebits/param/3": { "documentation": "Unsigned 32‑bit number. Only bitCount least significant bits are written." }, "@luau/global/buffer.writebits": { "documentation": "Writes data to the buffer based on a specific bitCount integer from 0 to 32, inclusive.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writebits/param/0" }, { "name": "bitOffset", "documentation": "@luau/global/buffer.writebits/param/1" }, { "name": "bitCount", "documentation": "@luau/global/buffer.writebits/param/2" }, { "name": "value", "documentation": "@luau/global/buffer.writebits/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writebits", "code_sample": "" }, "@luau/global/buffer.writei8/param/0": { "documentation": "" }, "@luau/global/buffer.writei8/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writei8/param/2": { "documentation": "An integer number in range [-128, 127]." }, "@luau/global/buffer.writei8": { "documentation": "Writes an 8-bit signed integer to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writei8/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writei8/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writei8/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writei8", "code_sample": "" }, "@luau/global/buffer.writeu8/param/0": { "documentation": "" }, "@luau/global/buffer.writeu8/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writeu8/param/2": { "documentation": "An integer number in range [0, 255]." }, "@luau/global/buffer.writeu8": { "documentation": "Writes an 8-bit unsigned integer to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writeu8/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writeu8/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writeu8/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writeu8", "code_sample": "" }, "@luau/global/buffer.writei16/param/0": { "documentation": "" }, "@luau/global/buffer.writei16/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writei16/param/2": { "documentation": "An integer number in range [-32,768, 32,767]." }, "@luau/global/buffer.writei16": { "documentation": "Writes a 16-bit signed integer to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writei16/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writei16/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writei16/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writei16", "code_sample": "" }, "@luau/global/buffer.writeu16/param/0": { "documentation": "" }, "@luau/global/buffer.writeu16/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writeu16/param/2": { "documentation": "An integer number in range [0, 65,535]." }, "@luau/global/buffer.writeu16": { "documentation": "Writes a 16-bit unsigned integer to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writeu16/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writeu16/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writeu16/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writeu16", "code_sample": "" }, "@luau/global/buffer.writei32/param/0": { "documentation": "" }, "@luau/global/buffer.writei32/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writei32/param/2": { "documentation": "An integer number in range [-2,147,483,648, 2,147,483,647]." }, "@luau/global/buffer.writei32": { "documentation": "Writes a 32-bit signed integer to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writei32/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writei32/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writei32/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writei32", "code_sample": "" }, "@luau/global/buffer.writeu32/param/0": { "documentation": "" }, "@luau/global/buffer.writeu32/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writeu32/param/2": { "documentation": "An integer number in range [0, 4,294,967,295]." }, "@luau/global/buffer.writeu32": { "documentation": "Writes a 32-bit unsigned integer to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writeu32/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writeu32/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writeu32/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writeu32", "code_sample": "" }, "@luau/global/buffer.writef32/param/0": { "documentation": "" }, "@luau/global/buffer.writef32/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writef32/param/2": { "documentation": "A single-precision floating-point number." }, "@luau/global/buffer.writef32": { "documentation": "Writes a 32-bit floating-point value to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writef32/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writef32/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writef32/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writef32", "code_sample": "" }, "@luau/global/buffer.writef64/param/0": { "documentation": "" }, "@luau/global/buffer.writef64/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writef64/param/2": { "documentation": "A double-precision floating-point number." }, "@luau/global/buffer.writef64": { "documentation": "Writes a 64-bit floating-point value to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writef64/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writef64/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writef64/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writef64", "code_sample": "" }, "@luau/global/buffer.readstring/param/0": { "documentation": "" }, "@luau/global/buffer.readstring/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.readstring/param/2": { "documentation": "Length to read." }, "@luau/global/buffer.readstring/return/0": { "documentation": "" }, "@luau/global/buffer.readstring": { "documentation": "Reads a string from the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.readstring/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.readstring/param/1" }, { "name": "count", "documentation": "@luau/global/buffer.readstring/param/2" } ], "returns": [ "@luau/global/buffer.readstring/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#readstring", "code_sample": "" }, "@luau/global/buffer.writestring/param/0": { "documentation": "" }, "@luau/global/buffer.writestring/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.writestring/param/2": { "documentation": "Data to write." }, "@luau/global/buffer.writestring/param/3": { "documentation": "Number of bytes to take from the string. This value cannot be larger than the string length." }, "@luau/global/buffer.writestring": { "documentation": "Writes a string to the buffer.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.writestring/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.writestring/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.writestring/param/2" }, { "name": "count", "documentation": "@luau/global/buffer.writestring/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#writestring", "code_sample": "" }, "@luau/global/buffer.copy/param/0": { "documentation": "Buffer to copy data into." }, "@luau/global/buffer.copy/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.copy/param/2": { "documentation": "Buffer to take the data from." }, "@luau/global/buffer.copy/param/3": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.copy/param/4": { "documentation": "Number of bytes to copy. If omitted, the whole source data starting from sourceOffset is taken." }, "@luau/global/buffer.copy": { "documentation": "Copies bytes between buffers.", "params": [ { "name": "target", "documentation": "@luau/global/buffer.copy/param/0" }, { "name": "targetOffset", "documentation": "@luau/global/buffer.copy/param/1" }, { "name": "source", "documentation": "@luau/global/buffer.copy/param/2" }, { "name": "sourceOffset", "documentation": "@luau/global/buffer.copy/param/3" }, { "name": "count", "documentation": "@luau/global/buffer.copy/param/4" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#copy", "code_sample": "" }, "@luau/global/buffer.fill/param/0": { "documentation": "Buffer to write the data into." }, "@luau/global/buffer.fill/param/1": { "documentation": "Offset from the beginning of the buffer memory, starting from 0." }, "@luau/global/buffer.fill/param/2": { "documentation": "An integer number in range [0, 255]." }, "@luau/global/buffer.fill/param/3": { "documentation": "Number of bytes to write. If omitted, all bytes after the specified offset are set." }, "@luau/global/buffer.fill": { "documentation": "Sets a region of the buffer memory to some 8-bit unsigned integer value.", "params": [ { "name": "b", "documentation": "@luau/global/buffer.fill/param/0" }, { "name": "offset", "documentation": "@luau/global/buffer.fill/param/1" }, { "name": "value", "documentation": "@luau/global/buffer.fill/param/2" }, { "name": "count", "documentation": "@luau/global/buffer.fill/param/3" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/buffer#fill", "code_sample": "" }, "@luau/global/os": { "documentation": "This library provides functions related to time and date.", "keys": { "clock": "@luau/global/os.clock", "date": "@luau/global/os.date", "difftime": "@luau/global/os.difftime", "time": "@luau/global/os.time" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/os", "code_sample": "" }, "@luau/global/os.clock/return/0": { "documentation": "" }, "@luau/global/os.clock": { "documentation": "Returns elapsed time in seconds since an arbitrary baseline with sub-microsecond precision.", "params": [], "returns": [ "@luau/global/os.clock/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/os#clock", "code_sample": "" }, "@luau/global/os.date/param/0": { "documentation": "Must be either \"*t\" or \"!*t\"." }, "@luau/global/os.date/param/1": { "documentation": "The time value to format." }, "@luau/global/os.date/return/0": { "documentation": "" }, "@luau/global/os.date": { "documentation": "Formats the given string with date/time information based on the given time.", "params": [ { "name": "formatString", "documentation": "@luau/global/os.date/param/0" }, { "name": "time", "documentation": "@luau/global/os.date/param/1" } ], "returns": [ "@luau/global/os.date/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/os#date", "code_sample": "" }, "@luau/global/os.difftime/param/0": { "documentation": "" }, "@luau/global/os.difftime/param/1": { "documentation": "" }, "@luau/global/os.difftime/return/0": { "documentation": "" }, "@luau/global/os.difftime": { "documentation": "Returns the number of seconds from one time to another.", "params": [ { "name": "t2", "documentation": "@luau/global/os.difftime/param/0" }, { "name": "t1", "documentation": "@luau/global/os.difftime/param/1" } ], "returns": [ "@luau/global/os.difftime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/os#difftime", "code_sample": "" }, "@luau/global/os.time/param/0": { "documentation": "A dictionary table describing a specific time, similar to that returned by os.date(). If not provided, uses the current UTC time." }, "@luau/global/os.time/return/0": { "documentation": "" }, "@luau/global/os.time": { "documentation": "Returns how many seconds have passed since the Unix epoch (1 January 1970, 00:00:00) under current UTC time.", "params": [ { "name": "time", "documentation": "@luau/global/os.time/param/0" } ], "returns": [ "@luau/global/os.time/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/os#time", "code_sample": "" }, "@roblox/global/task": { "documentation": "Allows for functions and threads to be coordinated with the engine's scheduler.", "keys": { "spawn": "@roblox/global/task.spawn", "defer": "@roblox/global/task.defer", "delay": "@roblox/global/task.delay", "desynchronize": "@roblox/global/task.desynchronize", "synchronize": "@roblox/global/task.synchronize", "wait": "@roblox/global/task.wait", "cancel": "@roblox/global/task.cancel" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task", "code_sample": "" }, "@roblox/global/task.spawn/param/0": { "documentation": "A function or a thread returned by coroutine.create()." }, "@roblox/global/task.spawn/param/1": { "documentation": "Arguments to send to the function or thread." }, "@roblox/global/task.spawn/return/0": { "documentation": "The scheduled thread." }, "@roblox/global/task.spawn": { "documentation": "Calls/resumes a function/coroutine immediately through the engine's scheduler.", "params": [ { "name": "functionOrThread", "documentation": "@roblox/global/task.spawn/param/0" }, { "name": "...", "documentation": "@roblox/global/task.spawn/param/1" } ], "returns": [ "@roblox/global/task.spawn/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#spawn", "code_sample": "" }, "@roblox/global/task.defer/param/0": { "documentation": "A function or a thread returned by coroutine.create." }, "@roblox/global/task.defer/param/1": { "documentation": "Arguments to send to the function or thread." }, "@roblox/global/task.defer/return/0": { "documentation": "The scheduled thread." }, "@roblox/global/task.defer": { "documentation": "Calls/resumes a function/coroutine at the end of the current resumption cycle.", "params": [ { "name": "functionOrThread", "documentation": "@roblox/global/task.defer/param/0" }, { "name": "...", "documentation": "@roblox/global/task.defer/param/1" } ], "returns": [ "@roblox/global/task.defer/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#defer", "code_sample": "" }, "@roblox/global/task.delay/param/0": { "documentation": "The minimum number of seconds that must pass before the function/thread is called/resumed." }, "@roblox/global/task.delay/param/1": { "documentation": "" }, "@roblox/global/task.delay/param/2": { "documentation": "Arguments to be passed to the function/thread when it is due to be called/resumed." }, "@roblox/global/task.delay/return/0": { "documentation": "The scheduled thread." }, "@roblox/global/task.delay": { "documentation": "Schedules a function/coroutine to be called/resumed on the next Heartbeat after the given duration (in seconds) has passed, without throttling.", "params": [ { "name": "duration", "documentation": "@roblox/global/task.delay/param/0" }, { "name": "functionOrThread", "documentation": "@roblox/global/task.delay/param/1" }, { "name": "...", "documentation": "@roblox/global/task.delay/param/2" } ], "returns": [ "@roblox/global/task.delay/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#delay", "code_sample": "" }, "@roblox/global/task.desynchronize": { "documentation": "Causes the following code to be run in parallel.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#desynchronize", "code_sample": "" }, "@roblox/global/task.synchronize": { "documentation": "Causes the following code to be run in serial.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#synchronize", "code_sample": "" }, "@roblox/global/task.wait/param/0": { "documentation": "The amount of time in seconds that should elapse before the current thread is resumed." }, "@roblox/global/task.wait/return/0": { "documentation": "" }, "@roblox/global/task.wait": { "documentation": "Yields the current thread without throttling.", "params": [ { "name": "duration", "documentation": "@roblox/global/task.wait/param/0" } ], "returns": [ "@roblox/global/task.wait/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#wait", "code_sample": "" }, "@roblox/global/task.cancel/param/0": { "documentation": "The thread that will be cancelled." }, "@roblox/global/task.cancel": { "documentation": "Cancels a thread, preventing it from being resumed.", "params": [ { "name": "thread", "documentation": "@roblox/global/task.cancel/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/task#cancel", "code_sample": "" }, "@luau/global/debug": { "documentation": "This library provides functions useful for debugging and profiling code.", "keys": { "traceback": "@luau/global/debug.traceback", "info": "@luau/global/debug.info", "profilebegin": "@luau/global/debug.profilebegin", "profileend": "@luau/global/debug.profileend", "getmemorycategory": "@luau/global/debug.getmemorycategory", "setmemorycategory": "@luau/global/debug.setmemorycategory", "resetmemorycategory": "@luau/global/debug.resetmemorycategory", "dumpcodesize": "@luau/global/debug.dumpcodesize" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug", "code_sample": "" }, "@luau/global/debug.traceback": { "overloads": { "(string?, number?) -> string": "@luau/global/debug.traceback/overload/(string?, number?) -> string", "(thread, string?, number?) -> string": "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string" } }, "@luau/global/debug.traceback/overload/(string?, number?) -> string/param/0": { "documentation": "The first line of the returned string." }, "@luau/global/debug.traceback/overload/(string?, number?) -> string/param/1": { "documentation": "The number of calls \"up\" the call stack to return." }, "@luau/global/debug.traceback/overload/(string?, number?) -> string/return/0": { "documentation": "Traceback of the current function call stack." }, "@luau/global/debug.traceback/overload/(string?, number?) -> string": { "documentation": "Returns a string of undefined format that describes the current function call stack.", "params": [ { "name": "message", "documentation": "@luau/global/debug.traceback/overload/(string?, number?) -> string/param/0" }, { "name": "level", "documentation": "@luau/global/debug.traceback/overload/(string?, number?) -> string/param/1" } ], "returns": [ "@luau/global/debug.traceback/overload/(string?, number?) -> string/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#traceback", "code_sample": "" }, "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/param/0": { "documentation": "A thread as returned by coroutine.create()." }, "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/param/1": { "documentation": "The first line of the returned string." }, "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/param/2": { "documentation": "The number of calls \"up\" the call stack to return." }, "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/return/0": { "documentation": "Traceback of the current function call stack." }, "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string": { "documentation": "Returns a string of undefined format that describes the current function call stack.", "params": [ { "name": "thread", "documentation": "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/param/0" }, { "name": "message", "documentation": "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/param/1" }, { "name": "level", "documentation": "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/param/2" } ], "returns": [ "@luau/global/debug.traceback/overload/(thread, string?, number?) -> string/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#traceback", "code_sample": "" }, "@luau/global/debug.info": { "overloads": { "(number, string) -> Tuple": "@luau/global/debug.info/overload/(number, string) -> Tuple", "(function, string) -> Tuple": "@luau/global/debug.info/overload/(function, string) -> Tuple", "(thread, number, string) -> Tuple": "@luau/global/debug.info/overload/(thread, number, string) -> Tuple" } }, "@luau/global/debug.info/overload/(number, string) -> Tuple/param/0": { "documentation": "Determines at what level of the call stack the information returned should describe. A value of 1 represents the function which is calling debug.info(), a value of 2 represents the function that called that function, and so on." }, "@luau/global/debug.info/overload/(number, string) -> Tuple/param/1": { "documentation": "A string that describes what the returned information should represent. It must only contain 0 or 1 instances of the characters slnaf, each representing a piece of information: " }, "@luau/global/debug.info/overload/(number, string) -> Tuple/return/0": { "documentation": "" }, "@luau/global/debug.info/overload/(number, string) -> Tuple": { "documentation": "Traverses the entire stack of current thread and returns a string containing the call stack of target level details.", "params": [ { "name": "level", "documentation": "@luau/global/debug.info/overload/(number, string) -> Tuple/param/0" }, { "name": "options", "documentation": "@luau/global/debug.info/overload/(number, string) -> Tuple/param/1" } ], "returns": [ "@luau/global/debug.info/overload/(number, string) -> Tuple/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#info", "code_sample": "" }, "@luau/global/debug.info/overload/(function, string) -> Tuple/param/0": { "documentation": "The function of the call stack which the information returned should describe." }, "@luau/global/debug.info/overload/(function, string) -> Tuple/param/1": { "documentation": "A string that describes what the returned information should represent. It must only contain 0 or 1 instances of the characters slnaf, each representing a piece of information: " }, "@luau/global/debug.info/overload/(function, string) -> Tuple/return/0": { "documentation": "" }, "@luau/global/debug.info/overload/(function, string) -> Tuple": { "documentation": "Traverses the entire stack of current thread and returns a string containing the call stack of target function details.", "params": [ { "name": "function", "documentation": "@luau/global/debug.info/overload/(function, string) -> Tuple/param/0" }, { "name": "options", "documentation": "@luau/global/debug.info/overload/(function, string) -> Tuple/param/1" } ], "returns": [ "@luau/global/debug.info/overload/(function, string) -> Tuple/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#info", "code_sample": "" }, "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/param/0": { "documentation": "A thread as returned by coroutine.create()." }, "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/param/1": { "documentation": "Determines at what level of the call stack the information returned should describe. A value of 1 represents the function which is calling debug.info(), a value of 2 represents the function that called that function, and so on." }, "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/param/2": { "documentation": "A string that describes what the returned information should represent. It must only contain 0 or 1 instances of the characters slnaf, each representing a piece of information: " }, "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/return/0": { "documentation": "" }, "@luau/global/debug.info/overload/(thread, number, string) -> Tuple": { "documentation": "Traverses the entire stack of target thread and returns a string containing the call stack of target level details.", "params": [ { "name": "thread", "documentation": "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/param/0" }, { "name": "level", "documentation": "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/param/1" }, { "name": "options", "documentation": "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/param/2" } ], "returns": [ "@luau/global/debug.info/overload/(thread, number, string) -> Tuple/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#info", "code_sample": "" }, "@luau/global/debug.profilebegin/param/0": { "documentation": "The text that this MicroProfiler label displays." }, "@luau/global/debug.profilebegin": { "documentation": "Starts profiling for a label.", "params": [ { "name": "label", "documentation": "@luau/global/debug.profilebegin/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#profilebegin", "code_sample": "" }, "@luau/global/debug.profileend": { "documentation": "Stops profiling for the most recent label that debug.profilebegin() opened.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#profileend", "code_sample": "" }, "@luau/global/debug.getmemorycategory/return/0": { "documentation": "The current thread's active memory category." }, "@luau/global/debug.getmemorycategory": { "documentation": "Returns the name of the current thread's active memory category.", "params": [], "returns": [ "@luau/global/debug.getmemorycategory/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#getmemorycategory", "code_sample": "" }, "@luau/global/debug.setmemorycategory/param/0": { "documentation": "" }, "@luau/global/debug.setmemorycategory/return/0": { "documentation": "The current thread's previous memory category." }, "@luau/global/debug.setmemorycategory": { "documentation": "Assigns a custom tag to the current thread's memory category.", "params": [ { "name": "tag", "documentation": "@luau/global/debug.setmemorycategory/param/0" } ], "returns": [ "@luau/global/debug.setmemorycategory/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#setmemorycategory", "code_sample": "" }, "@luau/global/debug.resetmemorycategory": { "documentation": "Resets the tag assigned by debug.setmemorycategory() to the automatically assigned value (typically, the script name).", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#resetmemorycategory", "code_sample": "" }, "@luau/global/debug.dumpcodesize": { "documentation": "Displays a table of native code size of individual functions and scripts.", "params": [], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/debug#dumpcodesize", "code_sample": "" }, "@luau/global/table": { "documentation": "A library of table functions.", "keys": { "clear": "@luau/global/table.clear", "clone": "@luau/global/table.clone", "concat": "@luau/global/table.concat", "create": "@luau/global/table.create", "find": "@luau/global/table.find", "foreach": "@luau/global/table.foreach", "foreachi": "@luau/global/table.foreachi", "freeze": "@luau/global/table.freeze", "getn": "@luau/global/table.getn", "insert": "@luau/global/table.insert", "isfrozen": "@luau/global/table.isfrozen", "maxn": "@luau/global/table.maxn", "move": "@luau/global/table.move", "pack": "@luau/global/table.pack", "remove": "@luau/global/table.remove", "sort": "@luau/global/table.sort", "unpack": "@luau/global/table.unpack" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table", "code_sample": "" }, "@luau/global/table.clear/param/0": { "documentation": "The table whose keys will be cleared." }, "@luau/global/table.clear": { "documentation": "Sets all keys in the given table to nil.", "params": [ { "name": "table", "documentation": "@luau/global/table.clear/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#clear", "code_sample": "" }, "@luau/global/table.clone/param/0": { "documentation": "The table to be cloned." }, "@luau/global/table.clone/return/0": { "documentation": "The clone of the provided table." }, "@luau/global/table.clone": { "documentation": "Returns a shallow copy of the provided table.", "params": [ { "name": "t", "documentation": "@luau/global/table.clone/param/0" } ], "returns": [ "@luau/global/table.clone/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#clone", "code_sample": "" }, "@luau/global/table.concat/param/0": { "documentation": "The table that will be converted into a string." }, "@luau/global/table.concat/param/1": { "documentation": "The string that will be concatenated between each entry in the table." }, "@luau/global/table.concat/param/2": { "documentation": "The starting index of the table concatenation." }, "@luau/global/table.concat/param/3": { "documentation": "The ending index of the table concatenation." }, "@luau/global/table.concat/return/0": { "documentation": "" }, "@luau/global/table.concat": { "documentation": "Returns the given range of table elements as a string where each element is separated by the given separator.", "params": [ { "name": "t", "documentation": "@luau/global/table.concat/param/0" }, { "name": "sep", "documentation": "@luau/global/table.concat/param/1" }, { "name": "i", "documentation": "@luau/global/table.concat/param/2" }, { "name": "j", "documentation": "@luau/global/table.concat/param/3" } ], "returns": [ "@luau/global/table.concat/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#concat", "code_sample": "" }, "@luau/global/table.create/param/0": { "documentation": "" }, "@luau/global/table.create/param/1": { "documentation": "" }, "@luau/global/table.create/return/0": { "documentation": "" }, "@luau/global/table.create": { "documentation": "Returns a new table populated with many instances of the specified value.", "params": [ { "name": "count", "documentation": "@luau/global/table.create/param/0" }, { "name": "value", "documentation": "@luau/global/table.create/param/1" } ], "returns": [ "@luau/global/table.create/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#create", "code_sample": "" }, "@luau/global/table.find/param/0": { "documentation": "" }, "@luau/global/table.find/param/1": { "documentation": "" }, "@luau/global/table.find/param/2": { "documentation": "" }, "@luau/global/table.find/return/0": { "documentation": "" }, "@luau/global/table.find": { "documentation": "Returns the index of the first occurrence of needle within haystack starting from init.", "params": [ { "name": "haystack", "documentation": "@luau/global/table.find/param/0" }, { "name": "needle", "documentation": "@luau/global/table.find/param/1" }, { "name": "init", "documentation": "@luau/global/table.find/param/2" } ], "returns": [ "@luau/global/table.find/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#find", "code_sample": "" }, "@luau/global/table.foreach/param/0": { "documentation": "The table to be iterated over." }, "@luau/global/table.foreach/param/1": { "documentation": "The function that will be used for the iteration. This function will receive 2 arguments for each iteration, where the 1st argument is the key, and the 2nd argument is the value." }, "@luau/global/table.foreach": { "documentation": "Deprecated:
Iterates over the provided table, passing the key and value of each iteration over to the provided function.", "params": [ { "name": "t", "documentation": "@luau/global/table.foreach/param/0" }, { "name": "f", "documentation": "@luau/global/table.foreach/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#foreach", "code_sample": "" }, "@luau/global/table.foreachi/param/0": { "documentation": "The table to be iterated over." }, "@luau/global/table.foreachi/param/1": { "documentation": "The function that will be used for the iteration. This function will receive 2 arguments for each iteration, where the 1st argument is the index, and the 2nd argument is the value." }, "@luau/global/table.foreachi": { "documentation": "Deprecated:
Similar to table.foreach() except index-value pairs are passed instead of key-value pairs.", "params": [ { "name": "t", "documentation": "@luau/global/table.foreachi/param/0" }, { "name": "f", "documentation": "@luau/global/table.foreachi/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#foreachi", "code_sample": "" }, "@luau/global/table.freeze/param/0": { "documentation": "The table to be frozen." }, "@luau/global/table.freeze/return/0": { "documentation": "The frozen table." }, "@luau/global/table.freeze": { "documentation": "Makes the given table read-only.", "params": [ { "name": "t", "documentation": "@luau/global/table.freeze/param/0" } ], "returns": [ "@luau/global/table.freeze/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#freeze", "code_sample": "" }, "@luau/global/table.getn/param/0": { "documentation": "The table whose size is being measured." }, "@luau/global/table.getn/return/0": { "documentation": "" }, "@luau/global/table.getn": { "documentation": "Deprecated:
Returns the number of elements in the table passed.", "params": [ { "name": "t", "documentation": "@luau/global/table.getn/param/0" } ], "returns": [ "@luau/global/table.getn/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#getn", "code_sample": "" }, "@luau/global/table.insert": { "overloads": { "(table, number, Variant) -> ()": "@luau/global/table.insert/overload/(table, number, Variant) -> ()", "(table, Variant) -> ()": "@luau/global/table.insert/overload/(table, Variant) -> ()" } }, "@luau/global/table.insert/overload/(table, number, Variant) -> ()/param/0": { "documentation": "The table that is being appended to." }, "@luau/global/table.insert/overload/(table, number, Variant) -> ()/param/1": { "documentation": "The position at which the value will be inserted." }, "@luau/global/table.insert/overload/(table, number, Variant) -> ()/param/2": { "documentation": "The value that will be appended to the table." }, "@luau/global/table.insert/overload/(table, number, Variant) -> ()": { "documentation": "Inserts the provided value to the target position of the array.", "params": [ { "name": "t", "documentation": "@luau/global/table.insert/overload/(table, number, Variant) -> ()/param/0" }, { "name": "pos", "documentation": "@luau/global/table.insert/overload/(table, number, Variant) -> ()/param/1" }, { "name": "value", "documentation": "@luau/global/table.insert/overload/(table, number, Variant) -> ()/param/2" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#insert", "code_sample": "" }, "@luau/global/table.insert/overload/(table, Variant) -> ()/param/0": { "documentation": "The table that is being appended to." }, "@luau/global/table.insert/overload/(table, Variant) -> ()/param/1": { "documentation": "The value that will be appended to the table." }, "@luau/global/table.insert/overload/(table, Variant) -> ()": { "documentation": "Appends the provided value to the end of the array.", "params": [ { "name": "t", "documentation": "@luau/global/table.insert/overload/(table, Variant) -> ()/param/0" }, { "name": "value", "documentation": "@luau/global/table.insert/overload/(table, Variant) -> ()/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#insert", "code_sample": "" }, "@luau/global/table.isfrozen/param/0": { "documentation": "The table to check." }, "@luau/global/table.isfrozen/return/0": { "documentation": "Whether the table is frozen from table.freeze()." }, "@luau/global/table.isfrozen": { "documentation": "Returns true if the given table is frozen and false if it isn't frozen.", "params": [ { "name": "t", "documentation": "@luau/global/table.isfrozen/param/0" } ], "returns": [ "@luau/global/table.isfrozen/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#isfrozen", "code_sample": "" }, "@luau/global/table.maxn/param/0": { "documentation": "" }, "@luau/global/table.maxn/return/0": { "documentation": "" }, "@luau/global/table.maxn": { "documentation": "Returns the maximum numeric key of the provided table, or zero if the table has no numeric keys.", "params": [ { "name": "t", "documentation": "@luau/global/table.maxn/param/0" } ], "returns": [ "@luau/global/table.maxn/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#maxn", "code_sample": "" }, "@luau/global/table.move/param/0": { "documentation": "Source table." }, "@luau/global/table.move/param/1": { "documentation": "Start copying at src[a]." }, "@luau/global/table.move/param/2": { "documentation": "Copy up to and including src[b]." }, "@luau/global/table.move/param/3": { "documentation": "Copy into dst[t], ...." }, "@luau/global/table.move/param/4": { "documentation": "Destination table." }, "@luau/global/table.move/return/0": { "documentation": "dst, for convenience." }, "@luau/global/table.move": { "documentation": "Copies the specified range of elements from one table to another.", "params": [ { "name": "src", "documentation": "@luau/global/table.move/param/0" }, { "name": "a", "documentation": "@luau/global/table.move/param/1" }, { "name": "b", "documentation": "@luau/global/table.move/param/2" }, { "name": "t", "documentation": "@luau/global/table.move/param/3" }, { "name": "dst", "documentation": "@luau/global/table.move/param/4" } ], "returns": [ "@luau/global/table.move/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#move", "code_sample": "" }, "@luau/global/table.pack/param/0": { "documentation": "" }, "@luau/global/table.pack/return/0": { "documentation": "" }, "@luau/global/table.pack": { "documentation": "Returns a new table containing the provided values.", "params": [ { "name": "values...", "documentation": "@luau/global/table.pack/param/0" } ], "returns": [ "@luau/global/table.pack/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#pack", "code_sample": "" }, "@luau/global/table.remove/param/0": { "documentation": "The table that is having an element removed." }, "@luau/global/table.remove/param/1": { "documentation": "The index of the element being removed." }, "@luau/global/table.remove/return/0": { "documentation": "" }, "@luau/global/table.remove": { "documentation": "Removes the specified element from the array, shifting later elements down to fill in the empty space if possible.", "params": [ { "name": "t", "documentation": "@luau/global/table.remove/param/0" }, { "name": "pos", "documentation": "@luau/global/table.remove/param/1" } ], "returns": [ "@luau/global/table.remove/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#remove", "code_sample": "" }, "@luau/global/table.sort/param/0": { "documentation": "" }, "@luau/global/table.sort/param/1": { "documentation": "An optional comparison function to be used when comparing elements in the table. This function receives two elements, and should return true if the first element should be sorted before the second in the final order." }, "@luau/global/table.sort": { "documentation": "Sorts table elements using the provided comparison function or the < operator.", "params": [ { "name": "t", "documentation": "@luau/global/table.sort/param/0" }, { "name": "comp", "documentation": "@luau/global/table.sort/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#sort", "code_sample": "" }, "@luau/global/table.unpack/param/0": { "documentation": "The list of elements to be unpacked." }, "@luau/global/table.unpack/param/1": { "documentation": "The index of the first element to unpack." }, "@luau/global/table.unpack/param/2": { "documentation": "The index of the last element to unpack." }, "@luau/global/table.unpack/return/0": { "documentation": "" }, "@luau/global/table.unpack": { "documentation": "Returns all elements from the given list as a tuple.", "params": [ { "name": "list", "documentation": "@luau/global/table.unpack/param/0" }, { "name": "i", "documentation": "@luau/global/table.unpack/param/1" }, { "name": "j", "documentation": "@luau/global/table.unpack/param/2" } ], "returns": [ "@luau/global/table.unpack/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/table#unpack", "code_sample": "" }, "@luau/global/string": { "documentation": "Provides generic functions to manipulate strings.", "keys": { "byte": "@luau/global/string.byte", "char": "@luau/global/string.char", "find": "@luau/global/string.find", "format": "@luau/global/string.format", "gmatch": "@luau/global/string.gmatch", "gsub": "@luau/global/string.gsub", "len": "@luau/global/string.len", "lower": "@luau/global/string.lower", "match": "@luau/global/string.match", "pack": "@luau/global/string.pack", "packsize": "@luau/global/string.packsize", "rep": "@luau/global/string.rep", "reverse": "@luau/global/string.reverse", "split": "@luau/global/string.split", "sub": "@luau/global/string.sub", "unpack": "@luau/global/string.unpack", "upper": "@luau/global/string.upper" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string", "code_sample": "" }, "@luau/global/string.byte/param/0": { "documentation": "" }, "@luau/global/string.byte/param/1": { "documentation": "" }, "@luau/global/string.byte/param/2": { "documentation": "" }, "@luau/global/string.byte/return/0": { "documentation": "" }, "@luau/global/string.byte": { "documentation": "Returns the internal numerical codes of the characters s[i], s[i+1], ..., s[j]. The default value for i is 1; the default value for j is i. These indices are corrected following the same rules of function string.sub.", "params": [ { "name": "s", "documentation": "@luau/global/string.byte/param/0" }, { "name": "i", "documentation": "@luau/global/string.byte/param/1" }, { "name": "j", "documentation": "@luau/global/string.byte/param/2" } ], "returns": [ "@luau/global/string.byte/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#byte", "code_sample": "" }, "@luau/global/string.char/param/0": { "documentation": "" }, "@luau/global/string.char/return/0": { "documentation": "" }, "@luau/global/string.char": { "documentation": "Receives zero or more integers and returns a string with length equal to the number of arguments, in which each character has the internal numerical code equal to its corresponding argument.", "params": [ { "name": "...", "documentation": "@luau/global/string.char/param/0" } ], "returns": [ "@luau/global/string.char/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#char", "code_sample": "" }, "@luau/global/string.find/param/0": { "documentation": "The string to search within." }, "@luau/global/string.find/param/1": { "documentation": "The pattern to search for in given string." }, "@luau/global/string.find/param/2": { "documentation": "The starting index for the search." }, "@luau/global/string.find/param/3": { "documentation": "" }, "@luau/global/string.find/return/0": { "documentation": "The starting index of the match." }, "@luau/global/string.find/return/1": { "documentation": "The ending index of the match." }, "@luau/global/string.find": { "documentation": "Looks for the first match of pattern in the string s and returns the indices of s where the occurrence starts and ends.", "params": [ { "name": "s", "documentation": "@luau/global/string.find/param/0" }, { "name": "pattern", "documentation": "@luau/global/string.find/param/1" }, { "name": "init", "documentation": "@luau/global/string.find/param/2" }, { "name": "plain", "documentation": "@luau/global/string.find/param/3" } ], "returns": [ "@luau/global/string.find/return/0", "@luau/global/string.find/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#find", "code_sample": "" }, "@luau/global/string.format/param/0": { "documentation": "" }, "@luau/global/string.format/param/1": { "documentation": "" }, "@luau/global/string.format/return/0": { "documentation": "" }, "@luau/global/string.format": { "documentation": "Returns a formatted version of its variable number of arguments following the description given in its first argument, which must be a string.", "params": [ { "name": "formatstring", "documentation": "@luau/global/string.format/param/0" }, { "name": "...", "documentation": "@luau/global/string.format/param/1" } ], "returns": [ "@luau/global/string.format/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#format", "code_sample": "" }, "@luau/global/string.gmatch/param/0": { "documentation": "" }, "@luau/global/string.gmatch/param/1": { "documentation": "" }, "@luau/global/string.gmatch/return/0": { "documentation": "" }, "@luau/global/string.gmatch": { "documentation": "Returns an iterator function that returns the next captures from pattern over the string s each time it's called.", "params": [ { "name": "s", "documentation": "@luau/global/string.gmatch/param/0" }, { "name": "pattern", "documentation": "@luau/global/string.gmatch/param/1" } ], "returns": [ "@luau/global/string.gmatch/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#gmatch", "code_sample": "" }, "@luau/global/string.gsub/param/0": { "documentation": "The string whose occurrences of the given pattern shall be replaced." }, "@luau/global/string.gsub/param/1": { "documentation": "The pattern to be matched and replaced." }, "@luau/global/string.gsub/param/2": { "documentation": "Determines what should replace the occurrence(s) of the given pattern." }, "@luau/global/string.gsub/param/3": { "documentation": "The maximum number of substitutions to make." }, "@luau/global/string.gsub/return/0": { "documentation": "" }, "@luau/global/string.gsub/return/1": { "documentation": "" }, "@luau/global/string.gsub": { "documentation": "Returns a copy of s in which all or the first n occurrences of the pattern are replaced with the given replacement. The second value returned is the total number of substitutions made.", "params": [ { "name": "s", "documentation": "@luau/global/string.gsub/param/0" }, { "name": "pattern", "documentation": "@luau/global/string.gsub/param/1" }, { "name": "replacement", "documentation": "@luau/global/string.gsub/param/2" }, { "name": "replacements", "documentation": "@luau/global/string.gsub/param/3" } ], "returns": [ "@luau/global/string.gsub/return/0", "@luau/global/string.gsub/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#gsub", "code_sample": "" }, "@luau/global/string.len/param/0": { "documentation": "" }, "@luau/global/string.len/return/0": { "documentation": "" }, "@luau/global/string.len": { "documentation": "Returns the length of a string.", "params": [ { "name": "s", "documentation": "@luau/global/string.len/param/0" } ], "returns": [ "@luau/global/string.len/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#len", "code_sample": "" }, "@luau/global/string.lower/param/0": { "documentation": "" }, "@luau/global/string.lower/return/0": { "documentation": "" }, "@luau/global/string.lower": { "documentation": "Returns a copy of a string with all uppercase letters changed to lowercase.", "params": [ { "name": "s", "documentation": "@luau/global/string.lower/param/0" } ], "returns": [ "@luau/global/string.lower/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#lower", "code_sample": "" }, "@luau/global/string.match/param/0": { "documentation": "" }, "@luau/global/string.match/param/1": { "documentation": "" }, "@luau/global/string.match/param/2": { "documentation": "" }, "@luau/global/string.match/return/0": { "documentation": "" }, "@luau/global/string.match": { "documentation": "Looks for the first match of pattern in the string s. If a match is found, it is returned; otherwise, it returns nil. A third, optional numerical argument, init, specifies where to start the search.", "params": [ { "name": "s", "documentation": "@luau/global/string.match/param/0" }, { "name": "pattern", "documentation": "@luau/global/string.match/param/1" }, { "name": "init", "documentation": "@luau/global/string.match/param/2" } ], "returns": [ "@luau/global/string.match/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#match", "code_sample": "" }, "@luau/global/string.pack/param/0": { "documentation": "" }, "@luau/global/string.pack/param/1": { "documentation": "" }, "@luau/global/string.pack/return/0": { "documentation": "" }, "@luau/global/string.pack": { "documentation": "Returns a binary string containing the provided arguments.", "params": [ { "name": "format", "documentation": "@luau/global/string.pack/param/0" }, { "name": "...", "documentation": "@luau/global/string.pack/param/1" } ], "returns": [ "@luau/global/string.pack/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#pack", "code_sample": "" }, "@luau/global/string.packsize/param/0": { "documentation": "" }, "@luau/global/string.packsize/return/0": { "documentation": "" }, "@luau/global/string.packsize": { "documentation": "Returns the size in bytes of any string packed with a given description.", "params": [ { "name": "format", "documentation": "@luau/global/string.packsize/param/0" } ], "returns": [ "@luau/global/string.packsize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#packsize", "code_sample": "" }, "@luau/global/string.rep/param/0": { "documentation": "" }, "@luau/global/string.rep/param/1": { "documentation": "" }, "@luau/global/string.rep/return/0": { "documentation": "" }, "@luau/global/string.rep": { "documentation": "Returns a string that is the concatenation of n copies of the string s.", "params": [ { "name": "s", "documentation": "@luau/global/string.rep/param/0" }, { "name": "n", "documentation": "@luau/global/string.rep/param/1" } ], "returns": [ "@luau/global/string.rep/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#rep", "code_sample": "" }, "@luau/global/string.reverse/param/0": { "documentation": "" }, "@luau/global/string.reverse/return/0": { "documentation": "" }, "@luau/global/string.reverse": { "documentation": "Returns a string that is the string s reversed.", "params": [ { "name": "s", "documentation": "@luau/global/string.reverse/param/0" } ], "returns": [ "@luau/global/string.reverse/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#reverse", "code_sample": "" }, "@luau/global/string.split/param/0": { "documentation": "The string to split." }, "@luau/global/string.split/param/1": { "documentation": "The separator character(s) to be used for splitting the string." }, "@luau/global/string.split/return/0": { "documentation": "" }, "@luau/global/string.split": { "documentation": "Splits a string into parts based on the defined separator character(s), returning a table of ordered results.", "params": [ { "name": "s", "documentation": "@luau/global/string.split/param/0" }, { "name": "separator", "documentation": "@luau/global/string.split/param/1" } ], "returns": [ "@luau/global/string.split/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#split", "code_sample": "" }, "@luau/global/string.sub/param/0": { "documentation": "" }, "@luau/global/string.sub/param/1": { "documentation": "" }, "@luau/global/string.sub/param/2": { "documentation": "" }, "@luau/global/string.sub/return/0": { "documentation": "" }, "@luau/global/string.sub": { "documentation": "Returns the substring of s that starts at i and continues until and including j. i and j can be negative. i defaults to 1 and j defaults to -1.", "params": [ { "name": "s", "documentation": "@luau/global/string.sub/param/0" }, { "name": "i", "documentation": "@luau/global/string.sub/param/1" }, { "name": "j", "documentation": "@luau/global/string.sub/param/2" } ], "returns": [ "@luau/global/string.sub/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#sub", "code_sample": "" }, "@luau/global/string.unpack/param/0": { "documentation": "" }, "@luau/global/string.unpack/param/1": { "documentation": "" }, "@luau/global/string.unpack/param/2": { "documentation": "" }, "@luau/global/string.unpack/return/0": { "documentation": "The values packed into the provided binary string, plus the index of the first unread byte." }, "@luau/global/string.unpack": { "documentation": "Extracts the values packed in the provided binary string.", "params": [ { "name": "format", "documentation": "@luau/global/string.unpack/param/0" }, { "name": "data", "documentation": "@luau/global/string.unpack/param/1" }, { "name": "readStart", "documentation": "@luau/global/string.unpack/param/2" } ], "returns": [ "@luau/global/string.unpack/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#unpack", "code_sample": "" }, "@luau/global/string.upper/param/0": { "documentation": "" }, "@luau/global/string.upper/return/0": { "documentation": "" }, "@luau/global/string.upper": { "documentation": "Returns a copy of a string with all lowercase letters changed to uppercase.", "params": [ { "name": "s", "documentation": "@luau/global/string.upper/param/0" } ], "returns": [ "@luau/global/string.upper/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/string#upper", "code_sample": "" }, "@luau/global/utf8": { "documentation": "This library provides basic support for UTF-8 encoding.", "keys": { "char": "@luau/global/utf8.char", "codes": "@luau/global/utf8.codes", "codepoint": "@luau/global/utf8.codepoint", "len": "@luau/global/utf8.len", "offset": "@luau/global/utf8.offset", "graphemes": "@luau/global/utf8.graphemes", "nfcnormalize": "@luau/global/utf8.nfcnormalize", "nfdnormalize": "@luau/global/utf8.nfdnormalize", "charpattern": "@luau/global/utf8.charpattern" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8", "code_sample": "" }, "@luau/global/utf8.char/param/0": { "documentation": "" }, "@luau/global/utf8.char/return/0": { "documentation": "" }, "@luau/global/utf8.char": { "documentation": "Converts zero or more codepoints to UTF-8 byte sequences.", "params": [ { "name": "codepoints", "documentation": "@luau/global/utf8.char/param/0" } ], "returns": [ "@luau/global/utf8.char/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#char", "code_sample": "" }, "@luau/global/utf8.codes/param/0": { "documentation": "The string to iterate over." }, "@luau/global/utf8.codes/return/0": { "documentation": "" }, "@luau/global/utf8.codes/return/1": { "documentation": "" }, "@luau/global/utf8.codes/return/2": { "documentation": "" }, "@luau/global/utf8.codes": { "documentation": "Returns an iterator function that iterates over all codepoints in a given string.", "params": [ { "name": "str", "documentation": "@luau/global/utf8.codes/param/0" } ], "returns": [ "@luau/global/utf8.codes/return/0", "@luau/global/utf8.codes/return/1", "@luau/global/utf8.codes/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#codes", "code_sample": "" }, "@luau/global/utf8.codepoint/param/0": { "documentation": "" }, "@luau/global/utf8.codepoint/param/1": { "documentation": "The index of the codepoint that should be fetched from this string." }, "@luau/global/utf8.codepoint/param/2": { "documentation": "The index of the last codepoint between i and j that will be returned. If excluded, this will default to the value of i." }, "@luau/global/utf8.codepoint/return/0": { "documentation": "" }, "@luau/global/utf8.codepoint": { "documentation": "Returns the codepoints (as integers) from all codepoints in a given string.", "params": [ { "name": "str", "documentation": "@luau/global/utf8.codepoint/param/0" }, { "name": "i", "documentation": "@luau/global/utf8.codepoint/param/1" }, { "name": "j", "documentation": "@luau/global/utf8.codepoint/param/2" } ], "returns": [ "@luau/global/utf8.codepoint/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#codepoint", "code_sample": "" }, "@luau/global/utf8.len/param/0": { "documentation": "" }, "@luau/global/utf8.len/param/1": { "documentation": "The starting position." }, "@luau/global/utf8.len/param/2": { "documentation": "The ending position." }, "@luau/global/utf8.len/return/0": { "documentation": "" }, "@luau/global/utf8.len": { "documentation": "Returns the number of UTF-8 codepoints in a given string.", "params": [ { "name": "s", "documentation": "@luau/global/utf8.len/param/0" }, { "name": "i", "documentation": "@luau/global/utf8.len/param/1" }, { "name": "j", "documentation": "@luau/global/utf8.len/param/2" } ], "returns": [ "@luau/global/utf8.len/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#len", "code_sample": "" }, "@luau/global/utf8.offset/param/0": { "documentation": "" }, "@luau/global/utf8.offset/param/1": { "documentation": "" }, "@luau/global/utf8.offset/param/2": { "documentation": "" }, "@luau/global/utf8.offset/return/0": { "documentation": "" }, "@luau/global/utf8.offset": { "documentation": "Returns the position (in bytes) where the encoding of the n‑th codepoint of s (counting from byte position i) starts.", "params": [ { "name": "s", "documentation": "@luau/global/utf8.offset/param/0" }, { "name": "n", "documentation": "@luau/global/utf8.offset/param/1" }, { "name": "i", "documentation": "@luau/global/utf8.offset/param/2" } ], "returns": [ "@luau/global/utf8.offset/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#offset", "code_sample": "" }, "@luau/global/utf8.graphemes/param/0": { "documentation": "" }, "@luau/global/utf8.graphemes/param/1": { "documentation": "" }, "@luau/global/utf8.graphemes/param/2": { "documentation": "" }, "@luau/global/utf8.graphemes/return/0": { "documentation": "" }, "@luau/global/utf8.graphemes": { "documentation": "Returns an iterator function that iterates over the grapheme clusters of a given string.", "params": [ { "name": "str", "documentation": "@luau/global/utf8.graphemes/param/0" }, { "name": "i", "documentation": "@luau/global/utf8.graphemes/param/1" }, { "name": "j", "documentation": "@luau/global/utf8.graphemes/param/2" } ], "returns": [ "@luau/global/utf8.graphemes/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#graphemes", "code_sample": "" }, "@luau/global/utf8.nfcnormalize/param/0": { "documentation": "" }, "@luau/global/utf8.nfcnormalize/return/0": { "documentation": "" }, "@luau/global/utf8.nfcnormalize": { "documentation": "Converts the input string to Normal Form C.", "params": [ { "name": "str", "documentation": "@luau/global/utf8.nfcnormalize/param/0" } ], "returns": [ "@luau/global/utf8.nfcnormalize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#nfcnormalize", "code_sample": "" }, "@luau/global/utf8.nfdnormalize/param/0": { "documentation": "The string to convert." }, "@luau/global/utf8.nfdnormalize/return/0": { "documentation": "" }, "@luau/global/utf8.nfdnormalize": { "documentation": "Converts the input string to Normal Form D.", "params": [ { "name": "str", "documentation": "@luau/global/utf8.nfdnormalize/param/0" } ], "returns": [ "@luau/global/utf8.nfdnormalize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#nfdnormalize", "code_sample": "" }, "@luau/global/utf8.charpattern": { "documentation": "The pattern \"[%z\\x01-\\x7F\\xC2-\\xF4][\\x80-\\xBF]*\", which matches exactly zero or more UTF-8 byte sequences, assuming that the subject is a valid UTF-8 string.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#charpattern", "code_sample": "" }, "@luau/global/coroutine": { "documentation": "A function that executes alongside the main thread.", "keys": { "close": "@luau/global/coroutine.close", "create": "@luau/global/coroutine.create", "isyieldable": "@luau/global/coroutine.isyieldable", "resume": "@luau/global/coroutine.resume", "running": "@luau/global/coroutine.running", "status": "@luau/global/coroutine.status", "wrap": "@luau/global/coroutine.wrap", "yield": "@luau/global/coroutine.yield" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine", "code_sample": "" }, "@luau/global/coroutine.close/param/0": { "documentation": "" }, "@luau/global/coroutine.close/return/0": { "documentation": "true unless the coroutine being closed is in an error state." }, "@luau/global/coroutine.close/return/1": { "documentation": "The error message, if any." }, "@luau/global/coroutine.close": { "documentation": "Closes and puts the provided coroutine in a dead state.", "params": [ { "name": "co", "documentation": "@luau/global/coroutine.close/param/0" } ], "returns": [ "@luau/global/coroutine.close/return/0", "@luau/global/coroutine.close/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#close", "code_sample": "" }, "@luau/global/coroutine.create/param/0": { "documentation": "" }, "@luau/global/coroutine.create/return/0": { "documentation": "" }, "@luau/global/coroutine.create": { "documentation": "Creates a new coroutine, with body f. f must be a Luau function.", "params": [ { "name": "f", "documentation": "@luau/global/coroutine.create/param/0" } ], "returns": [ "@luau/global/coroutine.create/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#create", "code_sample": "" }, "@luau/global/coroutine.isyieldable/return/0": { "documentation": "Whether or not the coroutine can safely yield at this point." }, "@luau/global/coroutine.isyieldable": { "documentation": "Returns true if the coroutine this function is called within can safely yield.", "params": [], "returns": [ "@luau/global/coroutine.isyieldable/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#isyieldable", "code_sample": "" }, "@luau/global/coroutine.resume/param/0": { "documentation": "" }, "@luau/global/coroutine.resume/param/1": { "documentation": "" }, "@luau/global/coroutine.resume/return/0": { "documentation": "" }, "@luau/global/coroutine.resume/return/1": { "documentation": "" }, "@luau/global/coroutine.resume": { "documentation": "Starts or continues the execution of coroutine co.", "params": [ { "name": "co", "documentation": "@luau/global/coroutine.resume/param/0" }, { "name": "...", "documentation": "@luau/global/coroutine.resume/param/1" } ], "returns": [ "@luau/global/coroutine.resume/return/0", "@luau/global/coroutine.resume/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#resume", "code_sample": "" }, "@luau/global/coroutine.running/return/0": { "documentation": "" }, "@luau/global/coroutine.running": { "documentation": "Returns the running coroutine.", "params": [], "returns": [ "@luau/global/coroutine.running/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#running", "code_sample": "" }, "@luau/global/coroutine.status/param/0": { "documentation": "" }, "@luau/global/coroutine.status/return/0": { "documentation": "" }, "@luau/global/coroutine.status": { "documentation": "Returns the status of coroutine co as a string.", "params": [ { "name": "co", "documentation": "@luau/global/coroutine.status/param/0" } ], "returns": [ "@luau/global/coroutine.status/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#status", "code_sample": "" }, "@luau/global/coroutine.wrap/param/0": { "documentation": "" }, "@luau/global/coroutine.wrap/return/0": { "documentation": "" }, "@luau/global/coroutine.wrap": { "documentation": "Creates a new coroutine and returns a function that, when called, resumes the coroutine.", "params": [ { "name": "f", "documentation": "@luau/global/coroutine.wrap/param/0" } ], "returns": [ "@luau/global/coroutine.wrap/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#wrap", "code_sample": "" }, "@luau/global/coroutine.yield/param/0": { "documentation": "" }, "@luau/global/coroutine.yield/return/0": { "documentation": "" }, "@luau/global/coroutine.yield": { "documentation": "Suspends execution of the coroutine.", "params": [ { "name": "...", "documentation": "@luau/global/coroutine.yield/param/0" } ], "returns": [ "@luau/global/coroutine.yield/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/coroutine#yield", "code_sample": "" }, "@roblox/global/vector": { "documentation": "A library of vector functions.", "keys": { "create": "@roblox/global/vector.create", "magnitude": "@roblox/global/vector.magnitude", "normalize": "@roblox/global/vector.normalize", "cross": "@roblox/global/vector.cross", "dot": "@roblox/global/vector.dot", "angle": "@roblox/global/vector.angle", "floor": "@roblox/global/vector.floor", "ceil": "@roblox/global/vector.ceil", "abs": "@roblox/global/vector.abs", "sign": "@roblox/global/vector.sign", "clamp": "@roblox/global/vector.clamp", "lerp": "@roblox/global/vector.lerp", "max": "@roblox/global/vector.max", "min": "@roblox/global/vector.min", "zero": "@roblox/global/vector.zero", "one": "@roblox/global/vector.one" }, "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector", "code_sample": "" }, "@roblox/global/vector.create/param/0": { "documentation": "" }, "@roblox/global/vector.create/param/1": { "documentation": "" }, "@roblox/global/vector.create/param/2": { "documentation": "" }, "@roblox/global/vector.create/return/0": { "documentation": "" }, "@roblox/global/vector.create": { "documentation": "Creates a new vector with the given component values.", "params": [ { "name": "x", "documentation": "@roblox/global/vector.create/param/0" }, { "name": "y", "documentation": "@roblox/global/vector.create/param/1" }, { "name": "z", "documentation": "@roblox/global/vector.create/param/2" } ], "returns": [ "@roblox/global/vector.create/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#create", "code_sample": "" }, "@roblox/global/vector.magnitude/param/0": { "documentation": "" }, "@roblox/global/vector.magnitude/return/0": { "documentation": "" }, "@roblox/global/vector.magnitude": { "documentation": "Calculates the magnitude of a given vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.magnitude/param/0" } ], "returns": [ "@roblox/global/vector.magnitude/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#magnitude", "code_sample": "" }, "@roblox/global/vector.normalize/param/0": { "documentation": "" }, "@roblox/global/vector.normalize/return/0": { "documentation": "" }, "@roblox/global/vector.normalize": { "documentation": "Computes the normalized version (unit vector) of a given vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.normalize/param/0" } ], "returns": [ "@roblox/global/vector.normalize/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#normalize", "code_sample": "" }, "@roblox/global/vector.cross/param/0": { "documentation": "" }, "@roblox/global/vector.cross/param/1": { "documentation": "" }, "@roblox/global/vector.cross/return/0": { "documentation": "" }, "@roblox/global/vector.cross": { "documentation": "Computes the cross product of two vectors.", "params": [ { "name": "vec1", "documentation": "@roblox/global/vector.cross/param/0" }, { "name": "vec2", "documentation": "@roblox/global/vector.cross/param/1" } ], "returns": [ "@roblox/global/vector.cross/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#cross", "code_sample": "" }, "@roblox/global/vector.dot/param/0": { "documentation": "" }, "@roblox/global/vector.dot/param/1": { "documentation": "" }, "@roblox/global/vector.dot/return/0": { "documentation": "" }, "@roblox/global/vector.dot": { "documentation": "Computes the dot product of two vectors.", "params": [ { "name": "vec1", "documentation": "@roblox/global/vector.dot/param/0" }, { "name": "vec2", "documentation": "@roblox/global/vector.dot/param/1" } ], "returns": [ "@roblox/global/vector.dot/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#dot", "code_sample": "" }, "@roblox/global/vector.angle/param/0": { "documentation": "" }, "@roblox/global/vector.angle/param/1": { "documentation": "" }, "@roblox/global/vector.angle/param/2": { "documentation": "" }, "@roblox/global/vector.angle/return/0": { "documentation": "" }, "@roblox/global/vector.angle": { "documentation": "Computes the angle between two vectors in radians.", "params": [ { "name": "vec1", "documentation": "@roblox/global/vector.angle/param/0" }, { "name": "vec2", "documentation": "@roblox/global/vector.angle/param/1" }, { "name": "axis", "documentation": "@roblox/global/vector.angle/param/2" } ], "returns": [ "@roblox/global/vector.angle/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#angle", "code_sample": "" }, "@roblox/global/vector.floor/param/0": { "documentation": "" }, "@roblox/global/vector.floor/return/0": { "documentation": "" }, "@roblox/global/vector.floor": { "documentation": "Applies math.floor() to every component of the input vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.floor/param/0" } ], "returns": [ "@roblox/global/vector.floor/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#floor", "code_sample": "" }, "@roblox/global/vector.ceil/param/0": { "documentation": "" }, "@roblox/global/vector.ceil/return/0": { "documentation": "" }, "@roblox/global/vector.ceil": { "documentation": "Applies math.ceil() to every component of the input vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.ceil/param/0" } ], "returns": [ "@roblox/global/vector.ceil/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#ceil", "code_sample": "" }, "@roblox/global/vector.abs/param/0": { "documentation": "" }, "@roblox/global/vector.abs/return/0": { "documentation": "" }, "@roblox/global/vector.abs": { "documentation": "Applies math.abs() to every component of the input vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.abs/param/0" } ], "returns": [ "@roblox/global/vector.abs/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#abs", "code_sample": "" }, "@roblox/global/vector.sign/param/0": { "documentation": "" }, "@roblox/global/vector.sign/return/0": { "documentation": "" }, "@roblox/global/vector.sign": { "documentation": "Applies math.sign() to every component of the input vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.sign/param/0" } ], "returns": [ "@roblox/global/vector.sign/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#sign", "code_sample": "" }, "@roblox/global/vector.clamp/param/0": { "documentation": "" }, "@roblox/global/vector.clamp/param/1": { "documentation": "" }, "@roblox/global/vector.clamp/param/2": { "documentation": "" }, "@roblox/global/vector.clamp/return/0": { "documentation": "" }, "@roblox/global/vector.clamp": { "documentation": "Applies math.clamp() to every component of the input vector.", "params": [ { "name": "vec", "documentation": "@roblox/global/vector.clamp/param/0" }, { "name": "min", "documentation": "@roblox/global/vector.clamp/param/1" }, { "name": "max", "documentation": "@roblox/global/vector.clamp/param/2" } ], "returns": [ "@roblox/global/vector.clamp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#clamp", "code_sample": "" }, "@roblox/global/vector.lerp/param/0": { "documentation": "" }, "@roblox/global/vector.lerp/param/1": { "documentation": "" }, "@roblox/global/vector.lerp/param/2": { "documentation": "" }, "@roblox/global/vector.lerp/return/0": { "documentation": "" }, "@roblox/global/vector.lerp": { "documentation": "Returns a vector linearly interpolated between two vectors by a fractional alpha.", "params": [ { "name": "vec1", "documentation": "@roblox/global/vector.lerp/param/0" }, { "name": "vec2", "documentation": "@roblox/global/vector.lerp/param/1" }, { "name": "alpha", "documentation": "@roblox/global/vector.lerp/param/2" } ], "returns": [ "@roblox/global/vector.lerp/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#lerp", "code_sample": "" }, "@roblox/global/vector.max/param/0": { "documentation": "" }, "@roblox/global/vector.max/return/0": { "documentation": "" }, "@roblox/global/vector.max": { "documentation": "Applies math.max() to the corresponding components of the input vectors.", "params": [ { "name": "...", "documentation": "@roblox/global/vector.max/param/0" } ], "returns": [ "@roblox/global/vector.max/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#max", "code_sample": "" }, "@roblox/global/vector.min/param/0": { "documentation": "" }, "@roblox/global/vector.min/return/0": { "documentation": "" }, "@roblox/global/vector.min": { "documentation": "Applies math.min() to the corresponding components of the input vectors.", "params": [ { "name": "...", "documentation": "@roblox/global/vector.min/param/0" } ], "returns": [ "@roblox/global/vector.min/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#min", "code_sample": "" }, "@roblox/global/vector.zero": { "documentation": "Constant vector with all components set to 0.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#zero", "code_sample": "" }, "@roblox/global/vector.one": { "documentation": "Constant vector with all components set to 1.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/vector#one", "code_sample": "" }, "@luau/global/assert/param/0": { "documentation": "The value that will be asserted against." }, "@luau/global/assert/param/1": { "documentation": "The text that will be shown in the error if the assertion fails." }, "@luau/global/assert/return/0": { "documentation": "" }, "@luau/global/assert": { "documentation": "Throws an error if the provided value resolves to false or nil.", "params": [ { "name": "value", "documentation": "@luau/global/assert/param/0" }, { "name": "errorMessage", "documentation": "@luau/global/assert/param/1" } ], "returns": [ "@luau/global/assert/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#assert", "code_sample": "" }, "@luau/global/collectgarbage/param/0": { "documentation": "The name of the operation that should be performed by the garbage collector." }, "@luau/global/collectgarbage/return/0": { "documentation": "" }, "@luau/global/collectgarbage": { "documentation": "Deprecated:
Performs the specified operation of the garbage collector.", "params": [ { "name": "operation", "documentation": "@luau/global/collectgarbage/param/0" } ], "returns": [ "@luau/global/collectgarbage/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#collectgarbage", "code_sample": "" }, "@luau/global/error/param/0": { "documentation": "The error message to display." }, "@luau/global/error/param/1": { "documentation": "The level of information that should be printed. Defaults to 1." }, "@luau/global/error": { "documentation": "Halts thread execution and throws an error.", "params": [ { "name": "message", "documentation": "@luau/global/error/param/0" }, { "name": "level", "documentation": "@luau/global/error/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#error", "code_sample": "" }, "@luau/global/gcinfo/return/0": { "documentation": "" }, "@luau/global/gcinfo": { "documentation": "Returns the total memory heap size in kilobytes.", "params": [], "returns": [ "@luau/global/gcinfo/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#gcinfo", "code_sample": "" }, "@luau/global/getfenv/param/0": { "documentation": "The stack level (int) of the environment to be returned; or the function whose environment will be returned." }, "@luau/global/getfenv/return/0": { "documentation": "" }, "@luau/global/getfenv": { "documentation": "Deprecated: This function allows uncontrolled change of the global/function environment and disables script optimizations. Changes to the environment are not tracked by the script analysis tooling and may result in missing or incorrect warnings. As a replacement, consider using debug.info() instead.
Returns the current environment in use by the caller, as a dictionary.", "params": [ { "name": "stack", "documentation": "@luau/global/getfenv/param/0" } ], "returns": [ "@luau/global/getfenv/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#getfenv", "code_sample": "" }, "@luau/global/getmetatable/param/0": { "documentation": "The object to fetch the metatable of." }, "@luau/global/getmetatable/return/0": { "documentation": "" }, "@luau/global/getmetatable": { "documentation": "Returns the metatable of the given table.", "params": [ { "name": "t", "documentation": "@luau/global/getmetatable/param/0" } ], "returns": [ "@luau/global/getmetatable/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#getmetatable", "code_sample": "" }, "@luau/global/ipairs/param/0": { "documentation": "A table whose elements are to be iterated over." }, "@luau/global/ipairs/return/0": { "documentation": "" }, "@luau/global/ipairs/return/1": { "documentation": "" }, "@luau/global/ipairs/return/2": { "documentation": "" }, "@luau/global/ipairs": { "documentation": "Returns an iterator function and the table for use in a for loop.", "params": [ { "name": "t", "documentation": "@luau/global/ipairs/param/0" } ], "returns": [ "@luau/global/ipairs/return/0", "@luau/global/ipairs/return/1", "@luau/global/ipairs/return/2" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#ipairs", "code_sample": "" }, "@luau/global/loadstring/param/0": { "documentation": "The specified string to be loaded as Luau code." }, "@luau/global/loadstring/param/1": { "documentation": "An optional chunk name for error messages and debug information. If unspecified, Luau uses the contents string." }, "@luau/global/loadstring/return/0": { "documentation": "" }, "@luau/global/loadstring": { "documentation": "Returns the provided code as a function that can be executed.", "params": [ { "name": "contents", "documentation": "@luau/global/loadstring/param/0" }, { "name": "chunkname", "documentation": "@luau/global/loadstring/param/1" } ], "returns": [ "@luau/global/loadstring/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#loadstring", "code_sample": "" }, "@luau/global/newproxy/param/0": { "documentation": "" }, "@luau/global/newproxy/return/0": { "documentation": "" }, "@luau/global/newproxy": { "documentation": "Creates a blank userdata, with the option for it to have a metatable.", "params": [ { "name": "addMetatable", "documentation": "@luau/global/newproxy/param/0" } ], "returns": [ "@luau/global/newproxy/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#newproxy", "code_sample": "" }, "@luau/global/next/param/0": { "documentation": "The array to be traversed." }, "@luau/global/next/param/1": { "documentation": "The last key that was previously retrieved from a call to next." }, "@luau/global/next/return/0": { "documentation": "" }, "@luau/global/next/return/1": { "documentation": "" }, "@luau/global/next": { "documentation": "An iterator function for use in for loops.", "params": [ { "name": "t", "documentation": "@luau/global/next/param/0" }, { "name": "lastKey", "documentation": "@luau/global/next/param/1" } ], "returns": [ "@luau/global/next/return/0", "@luau/global/next/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#next", "code_sample": "" }, "@luau/global/pairs/param/0": { "documentation": "An array or dictionary table to iterate over." }, "@luau/global/pairs/return/0": { "documentation": "" }, "@luau/global/pairs/return/1": { "documentation": "" }, "@luau/global/pairs": { "documentation": "Returns an iterator function and the provided table for use in a for loop.", "params": [ { "name": "t", "documentation": "@luau/global/pairs/param/0" } ], "returns": [ "@luau/global/pairs/return/0", "@luau/global/pairs/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#pairs", "code_sample": "" }, "@luau/global/pcall/param/0": { "documentation": "The function to be called in protected mode." }, "@luau/global/pcall/param/1": { "documentation": "The arguments to send to func when executing." }, "@luau/global/pcall/return/0": { "documentation": "" }, "@luau/global/pcall/return/1": { "documentation": "" }, "@luau/global/pcall": { "documentation": "Runs the provided function and catches any error it throws, returning the function's success and its results.", "params": [ { "name": "func", "documentation": "@luau/global/pcall/param/0" }, { "name": "args", "documentation": "@luau/global/pcall/param/1" } ], "returns": [ "@luau/global/pcall/return/0", "@luau/global/pcall/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#pcall", "code_sample": "" }, "@luau/global/print/param/0": { "documentation": "Any number of arguments to be outputted." }, "@luau/global/print": { "documentation": "Prints all provided values to the output.", "params": [ { "name": "params", "documentation": "@luau/global/print/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#print", "code_sample": "" }, "@luau/global/rawequal/param/0": { "documentation": "The first variable to compare." }, "@luau/global/rawequal/param/1": { "documentation": "The second variable to compare." }, "@luau/global/rawequal/return/0": { "documentation": "" }, "@luau/global/rawequal": { "documentation": "Returns whether v1 is equal to v2, bypassing their metamethods.", "params": [ { "name": "v1", "documentation": "@luau/global/rawequal/param/0" }, { "name": "v2", "documentation": "@luau/global/rawequal/param/1" } ], "returns": [ "@luau/global/rawequal/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#rawequal", "code_sample": "" }, "@luau/global/rawget/param/0": { "documentation": "The table to be referenced." }, "@luau/global/rawget/param/1": { "documentation": "The index to get from t." }, "@luau/global/rawget/return/0": { "documentation": "" }, "@luau/global/rawget": { "documentation": "Gets the real value of table[index], bypassing any metamethods.", "params": [ { "name": "t", "documentation": "@luau/global/rawget/param/0" }, { "name": "index", "documentation": "@luau/global/rawget/param/1" } ], "returns": [ "@luau/global/rawget/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#rawget", "code_sample": "" }, "@luau/global/rawlen/param/0": { "documentation": "The table to be referenced." }, "@luau/global/rawlen/return/0": { "documentation": "" }, "@luau/global/rawlen": { "documentation": "Returns the length of the string or table, bypassing any metamethods.", "params": [ { "name": "t", "documentation": "@luau/global/rawlen/param/0" } ], "returns": [ "@luau/global/rawlen/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#rawlen", "code_sample": "" }, "@luau/global/rawset/param/0": { "documentation": "The table to be referenced." }, "@luau/global/rawset/param/1": { "documentation": "The index to set in t to a specified value. Must be different from nil." }, "@luau/global/rawset/param/2": { "documentation": "The value to be set to a specified index in table t." }, "@luau/global/rawset/return/0": { "documentation": "" }, "@luau/global/rawset": { "documentation": "Sets the real value of table[index], bypassing any metamethods.", "params": [ { "name": "t", "documentation": "@luau/global/rawset/param/0" }, { "name": "index", "documentation": "@luau/global/rawset/param/1" }, { "name": "value", "documentation": "@luau/global/rawset/param/2" } ], "returns": [ "@luau/global/rawset/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#rawset", "code_sample": "" }, "@luau/global/require/param/0": { "documentation": "The ModuleScript that will be executed to retrieve the return value it provides, or a reference to one (a string path or asset ID)." }, "@luau/global/require/return/0": { "documentation": "What the ModuleScript returned (usually a table or a function)." }, "@luau/global/require": { "documentation": "Returns the value that was returned by the given ModuleScript, running it if it has not been run yet.", "params": [ { "name": "module", "documentation": "@luau/global/require/param/0" } ], "returns": [ "@luau/global/require/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#require", "code_sample": "" }, "@luau/global/select/param/0": { "documentation": "The index of the argument to return all arguments after in args. If it's set to \"#\", the number of arguments that were passed after it is returned." }, "@luau/global/select/param/1": { "documentation": "A tuple of arguments." }, "@luau/global/select/return/0": { "documentation": "" }, "@luau/global/select": { "documentation": "Returns all arguments after the given index.", "params": [ { "name": "index", "documentation": "@luau/global/select/param/0" }, { "name": "args", "documentation": "@luau/global/select/param/1" } ], "returns": [ "@luau/global/select/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#select", "code_sample": "" }, "@luau/global/setfenv/param/0": { "documentation": "Either a function or a number that specifies the function at that stack level." }, "@luau/global/setfenv/param/1": { "documentation": "The function environment table to set for the specified function." }, "@luau/global/setfenv/return/0": { "documentation": "" }, "@luau/global/setfenv": { "documentation": "Deprecated: This function allows uncontrolled change of the global/function environment and disables script optimizations. Changes to the environment are not tracked by the script analysis tooling and may result in missing or incorrect warnings.
Sets the given function's environment.", "params": [ { "name": "f", "documentation": "@luau/global/setfenv/param/0" }, { "name": "fenv", "documentation": "@luau/global/setfenv/param/1" } ], "returns": [ "@luau/global/setfenv/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#setfenv", "code_sample": "" }, "@luau/global/setmetatable/param/0": { "documentation": "The table to set the metatable of." }, "@luau/global/setmetatable/param/1": { "documentation": "If nil, the metatable of the given table t is removed. Otherwise, the metatable to set for the given table t." }, "@luau/global/setmetatable/return/0": { "documentation": "" }, "@luau/global/setmetatable": { "documentation": "Sets the given table's metatable.", "params": [ { "name": "t", "documentation": "@luau/global/setmetatable/param/0" }, { "name": "newMeta", "documentation": "@luau/global/setmetatable/param/1" } ], "returns": [ "@luau/global/setmetatable/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#setmetatable", "code_sample": "" }, "@luau/global/tonumber/param/0": { "documentation": "The object to be converted into a number." }, "@luau/global/tonumber/param/1": { "documentation": "The numerical base to convert arg into." }, "@luau/global/tonumber/return/0": { "documentation": "" }, "@luau/global/tonumber": { "documentation": "Returns the provided value converted to a number, or nil if impossible.", "params": [ { "name": "arg", "documentation": "@luau/global/tonumber/param/0" }, { "name": "base", "documentation": "@luau/global/tonumber/param/1" } ], "returns": [ "@luau/global/tonumber/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#tonumber", "code_sample": "" }, "@luau/global/tostring/param/0": { "documentation": "The object to be converted into a string." }, "@luau/global/tostring/return/0": { "documentation": "" }, "@luau/global/tostring": { "documentation": "Returns the provided value converted to a string, or nil if impossible.", "params": [ { "name": "e", "documentation": "@luau/global/tostring/param/0" } ], "returns": [ "@luau/global/tostring/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#tostring", "code_sample": "" }, "@luau/global/type/param/0": { "documentation": "The object to return the type of." }, "@luau/global/type/return/0": { "documentation": "" }, "@luau/global/type": { "documentation": "Returns the basic type of the provided object.", "params": [ { "name": "v", "documentation": "@luau/global/type/param/0" } ], "returns": [ "@luau/global/type/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#type", "code_sample": "" }, "@luau/global/unpack/param/0": { "documentation": "The list of elements to be unpacked." }, "@luau/global/unpack/param/1": { "documentation": "The index of the first element to unpack." }, "@luau/global/unpack/param/2": { "documentation": "The index of the last element to unpack." }, "@luau/global/unpack/return/0": { "documentation": "" }, "@luau/global/unpack": { "documentation": "Returns all elements from the given list as a tuple.", "params": [ { "name": "list", "documentation": "@luau/global/unpack/param/0" }, { "name": "i", "documentation": "@luau/global/unpack/param/1" }, { "name": "j", "documentation": "@luau/global/unpack/param/2" } ], "returns": [ "@luau/global/unpack/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#unpack", "code_sample": "" }, "@luau/global/xpcall/param/0": { "documentation": "The function to be called in protected mode." }, "@luau/global/xpcall/param/1": { "documentation": "The function to be used as an error handle if xpcall catches an error." }, "@luau/global/xpcall/param/2": { "documentation": "" }, "@luau/global/xpcall/return/0": { "documentation": "" }, "@luau/global/xpcall/return/1": { "documentation": "" }, "@luau/global/xpcall": { "documentation": "Similar to pcall() except it uses a custom error handler.", "params": [ { "name": "f", "documentation": "@luau/global/xpcall/param/0" }, { "name": "err", "documentation": "@luau/global/xpcall/param/1" }, { "name": "args", "documentation": "@luau/global/xpcall/param/2" } ], "returns": [ "@luau/global/xpcall/return/0", "@luau/global/xpcall/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#xpcall", "code_sample": "" }, "@luau/global/_G": { "documentation": "A table that is shared between all scripts of the same context level.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#_G", "code_sample": "" }, "@luau/global/_VERSION": { "documentation": "A global variable that holds a string containing the current interpreter version.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#_VERSION", "code_sample": "" }, "@roblox/global/delay/param/0": { "documentation": "The amount of time that this function will be queued before being executed." }, "@roblox/global/delay/param/1": { "documentation": "The function that will be executed once delayTime seconds have passed." }, "@roblox/global/delay": { "documentation": "Deprecated: This method has been superseded by task.delay() and should not be used for future work.
Schedules a function to be called on the next Heartbeat after the given duration (in seconds) has passed, with throttling.", "params": [ { "name": "delayTime", "documentation": "@roblox/global/delay/param/0" }, { "name": "callback", "documentation": "@roblox/global/delay/param/1" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#delay", "code_sample": "" }, "@roblox/global/DebuggerManager/return/0": { "documentation": "" }, "@roblox/global/DebuggerManager": { "documentation": "Deprecated: The DebuggerManager is obsolete and serves little to no use case for developers.
Refers to the legacy DebuggerManager class which acts as an interface for the Luau debugger feature.", "params": [], "returns": [ "@roblox/global/DebuggerManager/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#DebuggerManager", "code_sample": "" }, "@roblox/global/elapsedTime/return/0": { "documentation": "" }, "@roblox/global/elapsedTime": { "documentation": "Returns the amount of time in seconds that the current instance of Roblox has been running for.", "params": [], "returns": [ "@roblox/global/elapsedTime/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#elapsedTime", "code_sample": "" }, "@roblox/global/PluginManager/return/0": { "documentation": "" }, "@roblox/global/PluginManager": { "documentation": "Refers to the PluginManager, a deprecated singleton that was previously required to create plugins.", "params": [], "returns": [ "@roblox/global/PluginManager/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#PluginManager", "code_sample": "" }, "@roblox/global/printidentity/param/0": { "documentation": "" }, "@roblox/global/printidentity": { "documentation": "Deprecated:
Prints \"Current identity is X\", where X corresponds to the current thread's security context level.", "params": [ { "name": "prefix", "documentation": "@roblox/global/printidentity/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#printidentity", "code_sample": "" }, "@roblox/global/settings/return/0": { "documentation": "" }, "@roblox/global/settings": { "documentation": "Returns the GlobalSettings object, which can be used to access settings objects that configure Roblox Studio's behavior.", "params": [], "returns": [ "@roblox/global/settings/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#settings", "code_sample": "" }, "@roblox/global/spawn/param/0": { "documentation": "The function that will be executed." }, "@roblox/global/spawn": { "documentation": "Deprecated: This method has been superseded by task.spawn() and should not be used for future work.
Calls a function immediately through the engine scheduler, with throttling.", "params": [ { "name": "callback", "documentation": "@roblox/global/spawn/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#spawn", "code_sample": "" }, "@roblox/global/stats/return/0": { "documentation": "" }, "@roblox/global/stats": { "documentation": "Deprecated:
Returns the Stats service.", "params": [], "returns": [ "@roblox/global/stats/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#stats", "code_sample": "" }, "@roblox/global/tick/return/0": { "documentation": "" }, "@roblox/global/tick": { "documentation": "Returns the amount of time in seconds since the Unix epoch according to this device's time.", "params": [], "returns": [ "@roblox/global/tick/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#tick", "code_sample": "" }, "@roblox/global/time/return/0": { "documentation": "" }, "@roblox/global/time": { "documentation": "Returns the amount of time in seconds that has elapsed since the current game instance started running.", "params": [], "returns": [ "@roblox/global/time/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#time", "code_sample": "" }, "@roblox/global/typeof/param/0": { "documentation": "The Luau type that will have its type checked." }, "@roblox/global/typeof/return/0": { "documentation": "" }, "@roblox/global/typeof": { "documentation": "Returns the type of the given object as a string, also supporting Roblox-specific types (e.g. Vector3).", "params": [ { "name": "object", "documentation": "@roblox/global/typeof/param/0" } ], "returns": [ "@roblox/global/typeof/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#typeof", "code_sample": "" }, "@roblox/global/UserSettings/return/0": { "documentation": "" }, "@roblox/global/UserSettings": { "documentation": "Returns the UserSettings object, which is used to read information from the current user's game menu settings.", "params": [], "returns": [ "@roblox/global/UserSettings/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#UserSettings", "code_sample": "" }, "@roblox/global/version/return/0": { "documentation": "" }, "@roblox/global/version": { "documentation": "Returns the current version of Roblox as a string, which includes the generation, version, patch and commit.", "params": [], "returns": [ "@roblox/global/version/return/0" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#version", "code_sample": "" }, "@roblox/global/wait/param/0": { "documentation": "Specifies how long the thread should yield for." }, "@roblox/global/wait/return/0": { "documentation": "" }, "@roblox/global/wait/return/1": { "documentation": "" }, "@roblox/global/wait": { "documentation": "Deprecated: This method has been superseded by task.wait() and should not be used for future work.
Yields the current thread until the specified amount of time in seconds have elapsed, with throttling.", "params": [ { "name": "seconds", "documentation": "@roblox/global/wait/param/0" } ], "returns": [ "@roblox/global/wait/return/0", "@roblox/global/wait/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#wait", "code_sample": "" }, "@roblox/global/warn/param/0": { "documentation": "This function accepts any number of arguments, and will attempt to convert them into strings which will then be joined together with spaces between them." }, "@roblox/global/warn": { "documentation": "Behaves similarly to print, except with more distinct formatting (yellow); intended for messages which describe potential problems.", "params": [ { "name": "params", "documentation": "@roblox/global/warn/param/0" } ], "returns": [], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#warn", "code_sample": "" }, "@roblox/global/ypcall/param/0": { "documentation": "The function to be called in protected mode." }, "@roblox/global/ypcall/param/1": { "documentation": "" }, "@roblox/global/ypcall/return/0": { "documentation": "" }, "@roblox/global/ypcall/return/1": { "documentation": "" }, "@roblox/global/ypcall": { "documentation": "Deprecated:
Legacy function to work around an old task scheduling limitation of pcall().", "params": [ { "name": "f", "documentation": "@roblox/global/ypcall/param/0" }, { "name": "args", "documentation": "@roblox/global/ypcall/param/1" } ], "returns": [ "@roblox/global/ypcall/return/0", "@roblox/global/ypcall/return/1" ], "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#ypcall", "code_sample": "" }, "@roblox/global/Enum": { "documentation": "Contains all Enum objects.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#Enum", "code_sample": "" }, "@roblox/global/game": { "documentation": "Refers to the DataModel singleton, the root instance of a place's hierarchy.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#game", "code_sample": "" }, "@roblox/global/plugin": { "documentation": "Refers to a Plugin singleton when the code is run in the context of a Studio plugin.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#plugin", "code_sample": "" }, "@roblox/global/shared": { "documentation": "A table shared between all code running at the same execution context level.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#shared", "code_sample": "" }, "@roblox/global/script": { "documentation": "A reference to the LuaSourceContainer object (Script, LocalScript, or ModuleScript) that is executing this code.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#script", "code_sample": "" }, "@roblox/global/workspace": { "documentation": "A reference to the Workspace service, which contains all of the physical components of a place.", "learn_more_link": "https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#workspace", "code_sample": "" } }