### StartRecording Source: https://robloxapi.github.io/ref/class/VirtualInputManager Starts recording. ```APIDOC ## StartRecording ### Description Starts recording. ### Method (Implicit, likely a function call) ### Parameters (Details not provided in the input) ### History - 322 Add StartRecording ``` -------------------------------- ### StartPlaying Source: https://robloxapi.github.io/ref/class/VirtualInputManager Starts playback. ```APIDOC ## StartPlaying ### Description Starts playback. ### Method (Implicit, likely a function call) ### Parameters (Details not provided in the input) ### History - 322 Add StartPlaying ``` -------------------------------- ### Start Function Source: https://robloxapi.github.io/ref/class/FaceAnimatorService Starts the tracker. This function has no parameters. ```APIDOC ## Start ### Description Starts the tracker. ### Method (Not specified, likely a function call) ### Endpoint (Not applicable for member functions) ### Parameters No parameters. ### Returns - null ### Security RobloxScriptSecurity ### Thread Safety Unsafe ### History - 573: Changed return type from void to null. - 543: Added Start. ``` -------------------------------- ### Method: BeginRecording Source: https://robloxapi.github.io/ref/class/SoundService Starts recording audio. ```APIDOC ## Method: BeginRecording ### Description Starts recording audio. ### Method POST ### Endpoint /websites/robloxapi_github_io_ref/BeginRecording ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **return_value** (bool) - True if recording started successfully, false otherwise. #### Response Example ```json { "return_value": true } ``` ``` -------------------------------- ### StartRecording API Source: https://robloxapi.github.io/ref/class/VirtualUser Starts recording user input or actions. ```APIDOC ## POST /api/recorder/start ### Description Initiates the recording of user input or actions within the Roblox environment. ### Method POST ### Endpoint /api/recorder/start ### Parameters ### Request Example ```json {} ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. (e.g., "success") #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### StartRecording Source: https://robloxapi.github.io/ref/class/VirtualInputManager Starts recording user input or system events. ```APIDOC ## StartRecording ### Description Initiates the recording of user interactions or system events. This function is essential for capturing sequences that can be played back later. ### Method POST ### Endpoint /websites/robloxapi_github_io_ref/StartRecording ### Parameters No parameters. ### Response #### Success Response (200) - **null** - Indicates the recording has started successfully. #### Response Example ```json null ``` ``` -------------------------------- ### StartInputRecording Source: https://robloxapi.github.io/ref/class/AuroraService Starts recording input. This operation is unsafe. ```APIDOC ## StartInputRecording ### Description Starts recording input. ### Method (Implicitly POST or similar based on operation) ### Endpoint (Not explicitly defined, likely an internal method) ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - No parameters. ### Request Example ```json {} ``` ### Response #### Success Response (200) - null ### Thread safety Unsafe ### History - 681 Add StartInputRecording ``` -------------------------------- ### RequestStarted Source: https://robloxapi.github.io/ref/class/StreamingService Handles the start of a request, including the query to process. ```APIDOC ## POST /websites/robloxapi_github_io_ref/RequestStarted ### Description Handles the start of a request, including the query to process. ### Method POST ### Endpoint /websites/robloxapi_github_io_ref/RequestStarted ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **requestId** (string) - Required - The ID of the request. - **queryToProcess** (string) - Required - The query to process. ### Request Example ```json { "requestId": "string", "queryToProcess": "string" } ``` ### Response #### Success Response (200) - **(No specific response fields documented)** #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### StartPlayingJSON Source: https://robloxapi.github.io/ref/class/VirtualInputManager Starts playing back a recorded sequence from a JSON string. ```APIDOC ## StartPlayingJSON ### Description Begins playback of a recorded sequence provided as a JSON string. This allows for dynamic playback initiation without relying on external files. ### Method POST ### Endpoint /websites/robloxapi_github_io_ref/StartPlayingJSON ### Parameters #### Request Body - **string** (string) - Required - A JSON string representing the recorded sequence to play. ### Response #### Success Response (200) - **null** - Indicates the JSON playback has started successfully. #### Response Example ```json null ``` ``` -------------------------------- ### Get Full Name of Instance Source: https://robloxapi.github.io/ref/class/GuiService Returns the complete hierarchical name of an instance, starting from the root. ```lua Instance.GetFullName(): string ``` -------------------------------- ### startTutorial Source: https://robloxapi.github.io/ref/class/StartPageService Initiates the user tutorial sequence. ```APIDOC ## startTutorial ### Description Initiates the user tutorial sequence. ### Method POST ### Endpoint /startTutorial ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **return_value** (null) - Indicates the tutorial has started. #### Response Example ```json { "return_value": null } ``` ``` -------------------------------- ### StudioModeChanged Event Source: https://robloxapi.github.io/ref/class/UserGameSettings Fired when the user's client switches between Studio mode and in-game mode. This event gets fired periodically in Roblox Studio when a session starts. ```APIDOC ## StudioModeChanged ### Description 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. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **isStudioMode** (boolean) - Indicates if the client is in Studio mode. ### Thread safety Unsafe ``` -------------------------------- ### Access Mouse Origin and UnitRay Source: https://robloxapi.github.io/ref/class/Mouse Demonstrates how to access the Mouse.Origin CFrame and the Mouse.UnitRay, which starts at the origin and extends in the direction of the mouse's 3D position. The example comments on the relationship between UnitRay.Direction and origin.lookVector. ```lua local unitRay = mouse.UnitRay local origin = mouse.Origin -- unitRay.Direction = origin.p -- unitRay.Direction ≈ origin.lookVector ``` -------------------------------- ### Instance Manipulation and Searching (Lua) Source: https://robloxapi.github.io/ref/class/GuiObject Provides examples of common methods for manipulating and searching within the Roblox Instance hierarchy, which GuiObjects are part of. This includes cloning, destroying, and finding children or ancestors by name or class. It also shows how to get attributes associated with an instance. ```lua -- Example of cloning an instance local clonedObject = guiObject:Clone() clonedObject.Parent = workspace -- Or another appropriate parent -- Example of finding a child by name local specificChild = guiObject:FindFirstChild("MyTextLabel") -- Example of finding an ancestor of a specific class local frameAncestor = guiObject:FindFirstAncestorOfClass("ScreenFrame") -- Example of getting an attribute local attributeValue = guiObject:GetAttribute("CustomAttributeName") -- Example of destroying an instance -- clonedObject:Destroy() ``` -------------------------------- ### GetColor Method Example - Roblox Lua Source: https://robloxapi.github.io/ref/class/StudioTheme Demonstrates how to use the GetColor method of the StudioTheme class to retrieve a Color3 value based on Studio style guide items and modifiers. This function is part of the Roblox Engine API and is used within Studio plugins or scripts. ```lua settings().Studio.Theme:GetColor(Enum.StudioStyleGuideColor.MainButton, Enum.StudioStyleGuideModifier.Disabled) ``` -------------------------------- ### StarterGui API Source: https://robloxapi.github.io/ref/type/string Manages core GUI elements, allowing for registration and setting/getting of core functionalities. ```APIDOC ## StarterGui.GetCore ### Description Gets the value of a core GUI parameter. ### Method GET ### Endpoint /startergui/GetCore ### Parameters #### Query Parameters - **parameterName** (string) - Required - The name of the core parameter. ### Response #### Success Response (200) - **value** (any) - The value of the core parameter. ### Response Example ```json { "value": null } ``` ## StarterGui.RegisterGetCore ### Description Registers a function to be called when a core GUI parameter is requested. ### Method POST ### Endpoint /startergui/RegisterGetCore ### Parameters #### Query Parameters - **parameterName** (string) - Required - The name of the core parameter to register. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the registration was successful. ### Response Example ```json { "success": true } ``` ## StarterGui.RegisterSetCore ### Description Registers a function to be called when a core GUI parameter is set. ### Method POST ### Endpoint /startergui/RegisterSetCore ### Parameters #### Query Parameters - **parameterName** (string) - Required - The name of the core parameter to register. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the registration was successful. ### Response Example ```json { "success": true } ``` ## StarterGui.SetCore ### Description Sets the value of a core GUI parameter. ### Method POST ### Endpoint /startergui/SetCore ### Parameters #### Query Parameters - **parameterName** (string) - Required - The name of the core parameter. ### Request Body - **value** (any) - Required - The value to set for the core parameter. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the parameter was set successfully. ### Response Example ```json { "success": true } ``` ``` -------------------------------- ### SetMinutesAfterMidnight - Roblox Lua Example Source: https://robloxapi.github.io/ref/class/Lighting This Lua script demonstrates how to use the SetMinutesAfterMidnight method to create a simple day/night cycle. It allows for adjustable time speed and starting time. The method takes a double representing minutes after midnight and sets the Lighting's TimeOfDay and ClockTime accordingly. It handles values greater than 24 hours for subsequent days. ```lua local Lighting = game:GetService("Lighting") local TIME_SPEED = 60 -- 1 min = 1 hour local START_TIME = 9 -- 9 AM local minutesAfterMidnight = START_TIME * 60 local waitTime = 60 / TIME_SPEED while true do minutesAfterMidnight = minutesAfterMidnight + 1 Lighting:SetMinutesAfterMidnight(minutesAfterMidnight) task.wait(waitTime) end ``` -------------------------------- ### Subscription Feed Started Source: https://robloxapi.github.io/ref/class/VoiceChatService Signals the start of a subscription feed. ```APIDOC ## POST /subscriptions/feed/started ### Description This endpoint indicates that a subscription feed has started. It is not intended for direct use and may have unresolved issues. ### Method POST ### Endpoint /subscriptions/feed/started ### Parameters #### Request Body - **eventTag** (integer) - Required - The tag associated with the event. - **sessionId** (string) - Required - The session ID for the subscription. ### Request Example ```json { "eventTag": 123, "sessionId": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Subscription feed started successfully." } ``` ``` -------------------------------- ### ShouldLaunchTutorial API Source: https://robloxapi.github.io/ref/class/TutorialService Determines if the tutorial should be launched. This endpoint does not take any parameters and returns a boolean value. ```APIDOC ## GET /api/ShouldLaunchTutorial ### Description Determines if the tutorial should be launched. ### Method GET ### Endpoint /api/ShouldLaunchTutorial ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **launch** (bool) - True if the tutorial should be launched, false otherwise. #### Response Example ```json false ``` ``` -------------------------------- ### ExampleService API Source: https://robloxapi.github.io/ref/class/ExampleService Details about the ExampleService class, its properties, methods, and signals. ```APIDOC ## ExampleService Its interface does not cross the network boundary. Instances of this class cannot be created with Instance.new. It is a singleton that may be acquired with GetService. ### Tags Tags: [NotCreatable, Service, NotReplicated] ### Properties - **Archivable** (bool) - 553 - **Attributes** (string) - 553 - **AttributesReplicate** (string) - 553 - **AttributesSerialize** (BinaryString) - 553 - **Capabilities** (SecurityCapabilities) - 670 - **DataCost** (int) - 553 - **DefinesCapabilities** (bool) - 619 - **HistoryId** (UniqueId) - 553 - **Name** (string) - 553 - **Parent** (Instance) - 553 - **PropertyStatusStudio** (PropertyStatus) - 553 - **RobloxLocked** (bool) - 553 - **Sandboxed** (bool) - 670 - **SourceAssetId** (int64) - 616 - **Tags** (BinaryString) - 553 - **UniqueId** (UniqueId) - 680 - **archivable** (bool) - 553 - **numExpectedDirectChildren** (int) - 553 ### Methods - **AddTag(tag: string): null** - 576 - **ClearAllChildren(): null** - 573 - **Clone(): Instance** - 462 - **Destroy(): null** - 573 - **FindFirstAncestor(name: string): Instance** - 486 - **FindFirstAncestorOfClass(className: string): Instance** - 486 - **FindFirstAncestorWhichIsA(className: string): Instance** - 486 - **FindFirstChild(name: string, recursive: bool = false): Instance** - 486 - **FindFirstChildOfClass(className: string): Instance** - 486 - **FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance** - 486 - **FindFirstDescendant(name: string): Instance** - 486 - **GetActor(): Actor** - 563 - **GetAttribute(attribute: string): Variant** - 486 - **GetAttributeChangedSignal(attribute: string): RBXScriptSignal** - 462 - **GetAttributes(): Dictionary** - 631 - **GetChildren(): Instances** - 648 - **GetDebugId(scopeLength: int = 4): string** - 462 - **GetDescendants(): Array** - 486 - **GetFullName(): string** - 486 - **GetPredictionMode(): PredictionMode** - 691 - **GetStyled(name: string): Variant** - 641 - **GetStyledPropertyChangedSignal(property: string): RBXScriptSignal** - 657 - **GetTags(): Array** - 576 - **HasTag(tag: string): bool** - 576 - **IsAncestorOf(descendant: Instance): bool** - 486 - **IsDescendantOf(ancestor: Instance): bool** - 486 - **IsPredicted(): bool** - 690 - **IsPropertyModified(property: string): bool** - 664 - **Remove(): null** - 573 - **RemoveTag(tag: string): null** - 576 - **ResetPropertyToDefault(property: string): null** - 664 - **SetAttribute(attribute: string, value: Variant): null** - 573 - **SetPredictionMode(mode: PredictionMode): null** - 690 - **WaitForChild(childName: string, timeOut: double): Instance** - 462 - **children(): Instances** - 648 - **clone(): Instance** - 553 - **destroy(): null** - 573 - **findFirstChild(name: string, recursive: bool = false): Instance** - 553 - **getChildren(): Instances** - 648 - **isDescendantOf(ancestor: Instance): bool** - 553 - **remove(): null** - 573 ### Signals - **AncestryChanged(child: Instance, parent: Instance)** - 462 - **AttributeChanged(attribute: string)** - 462 - **ChildAdded(child: Instance)** - 462 - **ChildRemoved(child: Instance)** - 462 - **DescendantAdded(descendant: Instance)** - 462 - **DescendantRemoving(descendant: Instance)** - 462 - **Destroying()** - 500 - **StyledPropertiesChanged()** - 657 - **childAdded(child: Instance)** - 553 ### Inherited Members from Instance (68) (Details omitted for brevity) ### Inherited Members from Object (6) - **ClassName** (string) - 647 - **className** (string) - 647 - **GetPropertyChangedSignal(property: string): RBXScriptSignal** - 647 - **IsA(className: string): bool** - 647 - **isA(className: string): bool** - 650 - **Changed(property: string)** - 647 ``` -------------------------------- ### get Source: https://robloxapi.github.io/ref/class/DataModel Adds the 'get' function, likely a generic getter function. ```APIDOC ## get ### Description Adds the 'get' function, likely a generic getter function. ### Method N/A (Function) ### Endpoint N/A ### Parameters Requires specific parameters for the get operation (details not provided in the input). ### Request Example N/A ### Response N/A ``` -------------------------------- ### Set and Get Equipped Emotes in HumanoidDescription with Lua Source: https://robloxapi.github.io/ref/class/HumanoidDescription This code example shows how to set specific emotes as equipped for a HumanoidDescription and then retrieve and display which emotes are currently equipped. It uses the SetEmotes and SetEquippedEmotes methods to define available and equipped emotes, respectively. The GetEquippedEmotes method is then used to iterate through and print the name and slot of each equipped emote. This requires a HumanoidDescription instance to be available. ```lua local hd = Instance.new("HumanoidDescription") hd:SetEmotes({Salute = {3360689775}, Agree = {4849487550}}) hd:SetEquippedEmotes({"Salute", "Agree"}) -- Iterate over the equipped emotes: for _, t in hd:GetEquippedEmotes() do print(("In slot %d: emote %s is equipped"):format(t.Slot, t.Name)) end ``` -------------------------------- ### ExampleV2Service Source: https://robloxapi.github.io/ref/class/ExampleV2Service Documentation for the ExampleV2Service class within the Roblox Engine API. This service is a singleton and cannot be created directly. ```APIDOC ## ExampleV2Service ### Description Its interface does not cross the network boundary. Instances of this class cannot be created with Instance.new. It is a singleton that may be acquired with GetService. ### Tags [NotCreatable, Service, NotReplicated] ### Methods #### PrintHello(): null **Description:** Prints a hello message. **Parameters:** None **Returns:** null **Security:** RobloxScriptSecurity **Thread Safety:** Unsafe #### OnPolo(message: string): null **Description:** Handles a polo message. **Parameters:** - **message** (string) - The message to process. **Returns:** null **Security:** RobloxScriptSecurity **Thread Safety:** Unsafe ### Inherited Members from Instance - **Archivable**: bool - **Attributes**: string - **AttributesReplicate**: string - **AttributesSerialize**: BinaryString - **Capabilities**: SecurityCapabilities - **DataCost**: int - **DefinesCapabilities**: bool - **HistoryId**: UniqueId - **Name**: string - **Parent**: Instance - **PropertyStatusStudio**: PropertyStatus - **RobloxLocked**: bool - **Sandboxed**: bool - **SourceAssetId**: int64 - **Tags**: BinaryString - **UniqueId**: UniqueId - **archivable**: bool - **numExpectedDirectChildren**: int ### Instance Methods - **AddTag(tag: string): null** - **ClearAllChildren(): null** - **Clone(): Instance** - **Destroy(): null** - **FindFirstAncestor(name: string): Instance** - **FindFirstAncestorOfClass(className: string): Instance** - **FindFirstAncestorWhichIsA(className: string): Instance** - **FindFirstChild(name: string, recursive: bool = false): Instance** - **FindFirstChildOfClass(className: string): Instance** - **FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance** - **FindFirstDescendant(name: string): Instance** - **GetActor(): Actor** - **GetAttribute(attribute: string): Variant** - **GetAttributeChangedSignal(attribute: string): RBXScriptSignal** - **GetAttributes(): Dictionary** - **GetChildren(): Instances** - **GetDebugId(scopeLength: int = 4): string** - **GetDescendants(): Array** - **GetFullName(): string** - **GetPredictionMode(): PredictionMode** - **GetStyled(name: string): Variant** - **GetStyledPropertyChangedSignal(property: string): RBXScriptSignal** - **GetTags(): Array** - **HasTag(tag: string): bool** - **IsAncestorOf(descendant: Instance): bool** - **IsDescendantOf(ancestor: Instance): bool** - **IsPredicted(): bool** - **IsPropertyModified(property: string): bool** - **Remove(): null** - **RemoveTag(tag: string): null** - **ResetPropertyToDefault(property: string): null** - **SetAttribute(attribute: string, value: Variant): null** - **SetPredictionMode(mode: PredictionMode): null** - **WaitForChild(childName: string, timeOut: double): Instance** - **children(): Instances** - **clone(): Instance** - **destroy(): null** - **findFirstChild(name: string, recursive: bool = false): Instance** - **getChildren(): Instances** - **isDescendantOf(ancestor: Instance): bool** - **remove(): null** ### Instance Events - **AncestryChanged(child: Instance, parent: Instance)** - **AttributeChanged(attribute: string)** - **ChildAdded(child: Instance)** - **ChildRemoved(child: Instance)** - **DescendantAdded(descendant: Instance)** - **DescendantRemoving(descendant: Instance)** - **Destroying()** - **StyledPropertiesChanged()** - **childAdded(child: Instance)** ### Inherited Members from Object - **ClassName**: string - **className**: string - **GetPropertyChangedSignal(property: string): RBXScriptSignal** - **IsA(className: string): bool** - **isA(className: string): bool** - **Changed(property: string)** ### History - **683**: Added OnPolo - **683**: Added PrintHello - **683**: Added ExampleV2Service ``` -------------------------------- ### StartRecording API Source: https://robloxapi.github.io/ref/class/VirtualUser Initiates the recording of user input or actions. This function does not require any parameters. ```APIDOC ## POST /api/StartRecording ### Description Initiates the recording of user input or actions. This function does not require any parameters. ### Method POST ### Endpoint /api/StartRecording ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body No parameters. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **returnType** (null) - Indicates the operation was successful. #### Response Example ```json { "returnType": null } ``` ``` -------------------------------- ### Started API Source: https://robloxapi.github.io/ref/class/VideoCaptureService Details about the Started event, which requires a cameraid parameter and is marked as Unsafe for thread safety. ```APIDOC ## Started ### Description An event triggered when a camera starts. It requires a camera ID as a parameter. ### Method N/A (Event) ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **cameraid** (string) - Required - The ID of the camera that has started. ``` -------------------------------- ### get API Source: https://robloxapi.github.io/ref/class/DataModel The 'get' endpoint is available for backward compatibility but should not be used for new development. It returns objects. ```APIDOC ## get ### Description This endpoint exists only for backward compatibility and should not be used for new work. It retrieves objects. ### Method GET (assumed, as the name suggests retrieval) ### Endpoint /get ### Parameters #### Query Parameters - **url** (string) - Required - The URL to fetch content from. - **Content** (string) - Required - The type of content to retrieve. ### Request Body None ### Response #### Success Response (200) - **Objects** - The retrieved objects. #### Response Example { "example": "response body" } ``` -------------------------------- ### StartPlaying Source: https://robloxapi.github.io/ref/class/VirtualInputManager Starts playing back a recorded sequence from a specified file. ```APIDOC ## StartPlaying ### Description Initiates playback of a recorded sequence using the provided file name. This is useful for replaying user interactions or system events. ### Method POST ### Endpoint /websites/robloxapi_github_io_ref/StartPlaying ### Parameters #### Request Body - **fileName** (string) - Required - The name of the file containing the recorded sequence to play. ### Response #### Success Response (200) - **null** - Indicates the playback has started successfully. #### Response Example ```json null ``` ``` -------------------------------- ### Instance Methods Source: https://robloxapi.github.io/ref/class/StarterPlayer This section lists the methods of the Instance object, including their parameters and return types. ```APIDOC ## Instance Methods ### Description Methods that allow interaction with and manipulation of an Instance. ### Methods - **ClearDefaults()** (null) - Clears default values. - **AddTag(tag: string)** (null) - Adds a tag to the instance. - **ClearAllChildren()** (null) - Removes all children from the instance. - **Clone()** (Instance) - Creates a clone of the instance. - **Destroy()** (null) - Destroys the instance. - **FindFirstAncestor(name: string)** (Instance) - Finds the first ancestor with the given name. - **FindFirstAncestorOfClass(className: string)** (Instance) - Finds the first ancestor of the specified class. - **FindFirstAncestorWhichIsA(className: string)** (Instance) - Finds the first ancestor which is of the specified class. - **FindFirstChild(name: string, recursive: bool = false)** (Instance) - Finds the first child with the given name, optionally recursively. - **FindFirstChildOfClass(className: string)** (Instance) - Finds the first child of the specified class. - **FindFirstChildWhichIsA(className: string, recursive: bool = false)** (Instance) - Finds the first child which is of the specified class, optionally recursively. - **FindFirstDescendant(name: string)** (Instance) - Finds the first descendant with the given name. - **GetActor()** (Actor) - Gets the actor associated with the instance. - **GetAttribute(attribute: string)** (Variant) - Gets the value of a specified attribute. - **GetAttributeChangedSignal(attribute: string)** (RBXScriptSignal) - Gets the signal that fires when an attribute changes. - **GetAttributes()** (Dictionary) - Gets all attributes of the instance. - **GetChildren()** (Instances) - Gets a list of all children of the instance. - **GetDebugId(scopeLength: int = 4)** (string) - Gets the debug ID of the instance. - **GetDescendants()** (Array) - Gets a list of all descendants of the instance. - **GetFullName()** (string) - Gets the full name (path) of the instance. - **GetPredictionMode()** (PredictionMode) - Gets the prediction mode of the instance. - **GetStyled(name: string)** (Variant) - Gets a styled property value. - **GetStyledPropertyChangedSignal(property: string)** (RBXScriptSignal) - Gets the signal that fires when a styled property changes. - **GetTags()** (Array) - Gets all tags associated with the instance. - **HasTag(tag: string)** (bool) - Checks if the instance has a specific tag. - **IsAncestorOf(descendant: Instance)** (bool) - Checks if this instance is an ancestor of another instance. - **IsDescendantOf(ancestor: Instance)** (bool) - Checks if this instance is a descendant of another instance. - **IsPredicted()** (bool) - Checks if the instance is predicted. - **IsPropertyModified(property: string)** (bool) - Checks if a property has been modified. - **Remove()** (null) - Removes the instance from its parent. - **RemoveTag(tag: string)** (null) - Removes a tag from the instance. - **ResetPropertyToDefault(property: string)** (null) - Resets a property to its default value. - **SetAttribute(attribute: string, value: Variant)** (null) - Sets the value of a specified attribute. - **SetPredictionMode(mode: PredictionMode)** (null) - Sets the prediction mode of the instance. - **WaitForChild(childName: string, timeOut: double)** (Instance) - Waits for a child with the specified name to exist. - **children()** (Instances) - Alias for GetChildren(). - **clone()** (Instance) - Alias for Clone(). - **destroy()** (null) - Alias for Destroy(). - **findFirstChild(name: string, recursive: bool = false)** (Instance) - Alias for FindFirstChild(). - **getChildren()** (Instances) - Alias for GetChildren(). - **isDescendantOf(ancestor: Instance)** (bool) - Alias for IsDescendantOf(). - **remove()** (null) - Alias for Remove(). ``` -------------------------------- ### TweenBase:Play() Source: https://robloxapi.github.io/ref/class/TweenBase Starts playback of a tween. If playback has already started, calling Play() has no effect unless the tween has finished or is stopped. ```APIDOC ## TweenBase:Play() ### Description 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()). Multiple tweens can be played on the same object at the same time, but they must not animate the same property. ### Method `TweenBase:Play()` ### Parameters None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **null** - Indicates the operation was successful. #### Response Example ```json null ``` ``` -------------------------------- ### UseAudioApi Configuration Source: https://robloxapi.github.io/ref/class/VoiceChatService Configures the voice chat setup using AudioDeviceInput objects. Enables or disables default voice chat setup. ```APIDOC ## UseAudioApi Configuration ### Description Configures the voice chat setup, controlled by AudioDeviceInput objects. If enabled, AudioDeviceInput, AudioEmitter, and AudioListener objects are created. If disabled, an internal-only system is used. Currently, 'Automatic' functions as 'Disabled', but will enable customization in the future. ### Type AudioApiRollout ### Default Automatic ### Security PluginSecurity ### Thread safety ReadSafe ### Category Behavior ### Loaded/Saved true ``` -------------------------------- ### StarterGui Description Source: https://robloxapi.github.io/ref/class/StarterGui Provides an overview of the StarterGui service, explaining its purpose in holding LayerCollector objects and how its contents are copied to PlayerGui upon player spawn. ```APIDOC ## StarterGui ### Description StarterGui is a container object designed to hold LayerCollector objects such as ScreenGuis. When a Player.Character spawns, the contents of their PlayerGui (if any) are emptied. Children of the StarterGui are then copied along with their descendants into the PlayerGui. Note, however, that LayerCollector objects such as ScreenGuis with their ResetOnSpawn property set to `false` will only be placed into each player's PlayerGui once and will not be deleted when the Player respawns. StarterGui also includes a range of functions allowing you to interact with the CoreGui. For example StarterGui:SetCoreGuiEnabled() can be used to disable elements of the CoreGui, and StarterGui:SetCore() can perform a range of functions including creating notifications and system messages. ``` -------------------------------- ### LineJoinMode Enum Examples Source: https://robloxapi.github.io/ref/class/UIStroke Provides examples for setting the LineJoinMode property of a UIStroke. This property determines how the corners of the stroke are rendered, with options for 'Round', 'Bevel', and 'Miter'. ```lua local uiStroke = Instance.new("UIStroke") uiStroke.LineJoinMode = Enum.LineJoinMode.Round -- or uiStroke.LineJoinMode = Enum.LineJoinMode.Bevel -- or uiStroke.LineJoinMode = Enum.LineJoinMode.Miter ``` -------------------------------- ### StartLuaUrlDelivery API Source: https://robloxapi.github.io/ref/class/LinkingService Initiates the delivery of Lua URLs. This endpoint has no parameters and returns a dictionary. ```APIDOC ## StartLuaUrlDelivery ### Description Initiates the delivery of Lua URLs. ### Method POST ### Endpoint /StartLuaUrlDelivery ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **deliveryInfo** (Dictionary) - Information about the delivery process. #### Response Example ```json { "deliveryInfo": { "status": "initiated", "timestamp": "2023-10-27T10:00:00Z" } } ``` ``` -------------------------------- ### Perform HTTP GET Request Source: https://robloxapi.github.io/ref/class/DataModel Asynchronously sends an HTTP GET request to a specified URL. This function blocks the calling thread until the request is complete. It is considered unsafe for thread management. ```Lua HttpService:HttpGetAsync(url, [httpRequestType]) ``` -------------------------------- ### TutorialService API Source: https://robloxapi.github.io/ref/class/TutorialService Documentation for the TutorialService, including its methods and inherited properties. ```APIDOC ## TutorialService ### Description Its interface does not cross the network boundary. Instances of this class cannot be created with Instance.new. It is a singleton that may be acquired with GetService. ### Method Not applicable (Service Class) ### Endpoint Not applicable (Service Class) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## Methods ### GetMainViewSessionId - **Returns**: string ### HasUserCompletedTutorial - **Returns**: bool ### HideWidgets - **Parameters**: - **commaSeparatedNames** (string) - Required - The names of the widgets to hide. - **Returns**: bool ### PromptClosePlace - **Returns**: null ### SetTutorialCompletionStatus - **Parameters**: - **completed** (bool) - Required - The completion status to set. - **Returns**: null ### ShouldLaunchTutorial - **Returns**: bool ### ShowWidgets - **Parameters**: - **commaSeparatedNames** (string) - Required - The names of the widgets to show. - **Returns**: bool ## Inherited Members from Instance ### Properties - **Archivable** (bool) - **Attributes** (string) - **AttributesReplicate** (string) - **AttributesSerialize** (BinaryString) - **Capabilities** (SecurityCapabilities) - **DataCost** (int) - **DefinesCapabilities** (bool) - **HistoryId** (UniqueId) - **Name** (string) - **Parent** (Instance) - **PropertyStatusStudio** (PropertyStatus) - **RobloxLocked** (bool) - **Sandboxed** (bool) - **SourceAssetId** (int64) - **Tags** (BinaryString) - **UniqueId** (UniqueId) - **archivable** (bool) - **numExpectedDirectChildren** (int) ### Methods - **AddTag**(tag: string): null - **ClearAllChildren**(): null - **Clone**(): Instance - **Destroy**(): null - **FindFirstAncestor**(name: string): Instance - **FindFirstAncestorOfClass**(className: string): Instance - **FindFirstAncestorWhichIsA**(className: string): Instance - **FindFirstChild**(name: string, recursive: bool = false): Instance - **FindFirstChildOfClass**(className: string): Instance - **FindFirstChildWhichIsA**(className: string, recursive: bool = false): Instance - **FindFirstDescendant**(name: string): Instance - **GetActor**(): Actor - **GetAttribute**(attribute: string): Variant - **GetAttributeChangedSignal**(attribute: string): RBXScriptSignal - **GetAttributes**(): Dictionary - **GetChildren**(): Instances - **GetDebugId**(scopeLength: int = 4): string - **GetDescendants**(): Array - **GetFullName**(): string - **GetPredictionMode**(): PredictionMode - **GetStyled**(name: string): Variant - **GetStyledPropertyChangedSignal**(property: string): RBXScriptSignal - **GetTags**(): Array - **HasTag**(tag: string): bool - **IsAncestorOf**(descendant: Instance): bool - **IsDescendantOf**(ancestor: Instance): bool - **IsPredicted**(): bool - **IsPropertyModified**(property: string): bool - **Remove**(): null - **RemoveTag**(tag: string): null - **ResetPropertyToDefault**(property: string): null - **SetAttribute**(attribute: string, value: Variant): null - **SetPredictionMode**(mode: PredictionMode): null - **WaitForChild**(childName: string, timeOut: double): Instance - **children**(): Instances - **clone**(): Instance - **destroy**(): null - **findFirstChild**(name: string, recursive: bool = false): Instance - **getChildren**(): Instances - **isDescendantOf**(ancestor: Instance): bool - **remove**(): null ### Events - **AncestryChanged**(child: Instance, parent: Instance) - **AttributeChanged**(attribute: string) - **ChildAdded**(child: Instance) - **ChildRemoved**(child: Instance) - **DescendantAdded**(descendant: Instance) - **DescendantRemoving**(descendant: Instance) - **Destroying**() - **StyledPropertiesChanged**() - **childAdded**(child: Instance) ## Inherited Members from Object ### Properties - **ClassName**: string - **className**: string ### Methods - **GetPropertyChangedSignal**(property: string): RBXScriptSignal - **IsA**(className: string): bool - **isA**(className: string): bool ### Events - **Changed**(property: string) ``` -------------------------------- ### Get Property Changed Signal (Legacy) (Lua) Source: https://robloxapi.github.io/ref/class/PublishService This is a legacy method for getting a signal that fires when a property changes. It takes the property name and returns an RBXScriptSignal. The preferred method is `GetPropertyChangedSignal`. ```Lua function Changed(property: string) -- Function implementation details... end ``` -------------------------------- ### Roblox Lua: GetPlayingAnimationTracks Example Source: https://robloxapi.github.io/ref/class/AnimationController This example demonstrates how to load an animation and store the returned AnimationTrack in a table. It illustrates a workaround for tracking animations that are loaded but not currently playing, as GetPlayingAnimationTracks only returns currently playing tracks. ```lua local animationTracks = {} local track = animationController:LoadTrack(animation) table.insert(animationTracks, track) ``` -------------------------------- ### StartPageService API Source: https://robloxapi.github.io/ref/class/StartPageService Documentation for the StartPageService, a singleton service used for managing start page functionalities. It includes methods for URL generation, user login status, game registry, and tutorial management. ```APIDOC ## StartPageService API ### Description This service is a singleton that cannot be created with Instance.new and its interface does not cross the network boundary. It provides methods for managing start page content, game registries, and user tutorials. ### Service Information - **Tags**: [NotCreatable, Service, NotReplicated] ### Methods #### URL Generation - **generateTempUrlInContentProvider**(url: string): null - Description: Generates a temporary URL within the content provider. - **getTempUrlInContentProvider**(url: string): string - Description: Retrieves a temporary URL from the content provider. #### User and Game Management - **getDaysSinceFirstUserLogin**(): int - Description: Returns the number of days since the first user login. - **getLocalGamesFromRegistry**(): Array - Description: Retrieves a list of local games from the registry. - **getRecentAPIGamesFromRegistry**(): Array - Description: Retrieves a list of recent API games from the registry. - **removeAPIGameFromRegistry**(gameId: int64): null - Description: Removes an API game from the registry. - **removeLocalFileFromRegistry**(fileName: string): null - Description: Removes a local file from the registry. #### Tutorial Management - **isTutorialBannerClosed**(): bool - Description: Checks if the tutorial banner is closed. - **isTutorialPopupClosed**(): bool - Description: Checks if the tutorial popup is closed. - **setTutorialBannerClosed**(closed: bool): null - Description: Sets the state of the tutorial banner. - **setTutorialPopupClosed**(closed: bool): null - Description: Sets the state of the tutorial popup. - **startTutorial**(): null - Description: Initiates the tutorial. #### Navigation and Opening - **openLink**(link: string): null - Description: Opens a given link. - **openLocalFile**(filePath: string): null - Description: Opens a local file at the specified path. - **openPlace**(placeId: int64, universeId: int64, launchTutorial: bool): null - Description: Opens a Roblox place with specified IDs and tutorial launch option. #### Warnings - **shouldShowMacOSDeprecationWarning**(): bool - Description: Checks if the macOS deprecation warning should be shown. - **shouldShowWinOSDeprecationWarning**(): bool - Description: Checks if the Windows OS deprecation warning should be shown. ### Signals - **ImageImportedSignal**(urlImported: string, temporaryId: string) - **LocalGamesFromRegistryUpdatedSignal**(localGames: Array) - **RecentApiGamesFromRegistryUpdatedSignal**(recentGames: Array) ### Inherited Members from Instance - **Archivable**: bool - **Attributes**: string - **AttributesReplicate**: string - **AttributesSerialize**: BinaryString - **Capabilities**: SecurityCapabilities - **DataCost**: int - **DefinesCapabilities**: bool - **HistoryId**: UniqueId - **Name**: string - **Parent**: Instance - **PropertyStatusStudio**: PropertyStatus - **RobloxLocked**: bool - **Sandboxed**: bool - **SourceAssetId**: int64 - **Tags**: BinaryString - **UniqueId**: UniqueId - **archivable**: bool - **numExpectedDirectChildren**: int - **AddTag**(tag: string): null - **ClearAllChildren**(): null - **Clone**(): Instance - **Destroy**(): null - **FindFirstAncestor**(name: string): Instance - **FindFirstAncestorOfClass**(className: string): Instance - **FindFirstAncestorWhichIsA**(className: string): Instance - **FindFirstChild**(name: string, recursive: bool = false): Instance - **FindFirstChildOfClass**(className: string): Instance - **FindFirstChildWhichIsA**(className: string, recursive: bool = false): Instance - **FindFirstDescendant**(name: string): Instance - **GetActor**(): Actor - **GetAttribute**(attribute: string): Variant - **GetAttributeChangedSignal**(attribute: string): RBXScriptSignal - **GetAttributes**(): Dictionary - **GetChildren**(): Instances - **GetDebugId**(scopeLength: int = 4): string - **GetDescendants**(): Array - **GetFullName**(): string - **GetPredictionMode**(): PredictionMode - **GetStyled**(name: string): Variant - **GetStyledPropertyChangedSignal**(property: string): RBXScriptSignal - **GetTags**(): Array - **HasTag**(tag: string): bool - **IsAncestorOf**(descendant: Instance): bool - **IsDescendantOf**(ancestor: Instance): bool - **IsPredicted**(): bool - **IsPropertyModified**(property: string): bool - **Remove**(): null - **RemoveTag**(tag: string): null - **ResetPropertyToDefault**(property: string): null - **SetAttribute**(attribute: string, value: Variant): null - **SetPredictionMode**(mode: PredictionMode): null - **WaitForChild**(childName: string, timeOut: double): Instance - **children**(): Instances - **clone**(): Instance - **destroy**(): null - **findFirstChild**(name: string, recursive: bool = false): Instance - **getChildren**(): Instances - **isDescendantOf**(ancestor: Instance): bool - **remove**(): null ### Inherited Signals from Instance - **AncestryChanged**(child: Instance, parent: Instance) - **AttributeChanged**(attribute: string) - **ChildAdded**(child: Instance) - **ChildRemoved**(child: Instance) - **DescendantAdded**(descendant: Instance) - **DescendantRemoving**(descendant: Instance) - **Destroying**() - **StyledPropertiesChanged**() ### Inherited Members from Object - **ClassName**: string - **className**: string - **GetPropertyChangedSignal**(property: string): RBXScriptSignal - **IsA**(className: string): bool - **isA**(className: string): bool ### Inherited Signals from Object - **Changed**(property: string) ### Removed Members (from index 3) - **getStartPageVersionForUser**(): int - **getTutorialVersionForUser**(): string - **refreshRegistryDataInStartPage**(): null ```