Service responsible for all runtime activity and progression of time.
- Memory category
- Instances
- Own members
- 44
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties26
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Defined byRunService3
Property categoryData
RunService.ClientGitHash: string RunService.RunState: Enum.RunState The current run state of the game's simulation.
Property categoryServer Authority
RunService.FrameNumber: number
No properties match the filters.
Methods73
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }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. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - 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.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined byRunService31
RunService:BindToAnimation(function: (...any) -> ...any,frequency: Enum.StepFrequency? = Enum.StepFrequency.Hz30,priority: number? = 2000,): RBXScriptConnection Binds a custom function to be called at a fixed frequency before Animators update when fixed simulation is enabled, or immediately beforeBindToSimulationcallbacks otherwise.Parameters Parameter Description function: (...any) -> ...anyThe function to call. This function will be passed one parameter calleddeltaTime, which shows the elapsed time since the callback's previous invocation.frequency: Enum.StepFrequency? = Enum.StepFrequency.Hz30OptionalStepFrequencyvalue indicating the frequency at which to call the bound function. Defaults toStepFrequency.Hz30.priority: number? = 2000Optional priority of the binding as an integer; it determines the order in which bound functions are called within a simulation step. Lower numbers are called first. If two bindings have the same priority, the order between them is unspecified. Defaults to 2000.Returns Type Description RBXScriptConnectionARBXScriptConnectionthat can be disconnected to unregister the callback.RunService:BindToRenderStep(name: string,priority: number,function: (...any) -> ...any,) Given a string name of a function and a priority, this method binds the function toRunService.PreRender.Parameters Parameter Description name: stringLabel for the binding which can be used withUnbindif the binding is no longer needed.priority: numberPriority 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.function: (...any) -> ...anyThe custom function being bound.RunService:BindToSimulation(function: (...any) -> ...any,frequency: Enum.StepFrequency? = Enum.StepFrequency.Hz30,priority: number? = 2000,): RBXScriptConnection Binds a custom function to be called at a fixed frequency which is independent of the frame rate.Parameters Parameter Description function: (...any) -> ...anyThe function to call. This function will be passed one parameter calleddeltaTimewhich shows how much time passed between the beginning of the previous simulation step and the beginning of the current simulation step.frequency: Enum.StepFrequency? = Enum.StepFrequency.Hz30OptionalStepFrequencyvalue indicating the frequency at which to call the bound function. If not provided, the default frequency will be used.priority: number? = 2000Optional priority of the binding as an integer; it determines the order in which bound functions are called within a simulation step. Lower numbers are called first. If two bindings have the same priority, the order between them is unspecified. Defaults to 2000.Returns Type Description RBXScriptConnectionAnRBXScriptConnectionthat can be disconnected to unbind the function from the simulation step.RunService:GetControlAndVariantRolloutFlags( ): ...any Returns Type ...anyRunService:GetCoreScriptVersion( ): string Returns Type stringRunService:GetPhysicsStepId( ): number Returns Type numberRunService:GetPredictionStatus( context: Instance): Enum.PredictionStatus Checks thePredictionStatusof a specific context instance, useful for debugging scripts affecting multiple instances where some might be predicted and others might not.Returns Type Description Enum.PredictionStatusThePredictionStatusof the given instance, indicating whether it is predicted, authoritative, or not participating in prediction.RunService:GetRobloxClientChannel( ): string Returns Type stringRunService:GetRobloxClientIxpEnrolledExperiments( ): string Returns Type stringRunService:GetRobloxGuiFocused( ): boolean Returns Type booleanRunService:GetRobloxVersion( ): string Returns Type stringRunService:GetTotalScriptPlusExecutionTime( ): number Returns Type numberRunService:IsClient( ): boolean Returns whether the current environment is running on the client.Returns Type Description booleanWhether the current environment is running the client.RunService:IsEdit( ): boolean Returns whether the current environment is inEditmode.Returns Type Description booleanWhether the current environment is in "edit" mode.RunService:IsResimulating( ): boolean Returns whether the client is currently in a resimulation step after a misprediction in the server authority model.Returns Type Description booleanWhether the engine is currently resimulating.RunService:IsRunMode( ): boolean Returns whether a Run playtest has been initiated in Studio.Returns Type Description booleanWhether a Run playtest has been initiated in Studio.RunService:IsRunning( ): boolean Returns whether the experience is currently running.Returns Type Description booleanWhether the experience is currently running.RunService:IsServer( ): boolean Returns whether the current environment is running on the server.Returns Type Description booleanWhether the current environment is running on the server.RunService:IsStudio( ): boolean Returns whether the current environment is running in Studio.Returns Type Description booleanWhether the current environment is running in Studio.RunService:IsTeamCreateViewer( ): boolean Returns Type booleanRunService:IsTeamTest( ): boolean Returns Type boolean- Pauses the experience's simulation if it is running, suspending physics and scripts.
- Runs the game's simulation, running physics and scripts.
RunService:Set3dRenderingEnabled( enable: boolean) Parameters Parameter enable: booleanRunService:SetPredictionMode( context: Instance, mode: Enum.PredictionMode) Sets the prediction mode for anInstanceto anPredictionModevalue.Parameters Parameter Description context: InstanceTheInstancefor which to set the prediction mode.mode: Enum.PredictionModeThePredictionModeto set for the context instance.RunService:SetRobloxGuiFocused( focus: boolean) Parameters Parameter focus: boolean- Stops the experience's simulation if it is running.
RunService:UnbindFromRenderStep( name: string) Unbinds a function that was bound to the render loop usingRunService:BindToRenderStep().Parameters Parameter Description name: stringThe name of the function being unbound.RunService:getThrottleFramerateEnabled( ): boolean Returns Type booleanRunService:setThrottleFramerateEnabled( enable: boolean) Parameters Parameter enable: boolean- Deprecated: This item is deprecated and should not be used in new work.
Resets the current game to a waypoint set whenRunService:Run()was called.
No methods match the filters.
Events20
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
Defined byRunService10
RunService.Heartbeat: RBXScriptSignal<( deltaTime: number)> Fires every frame, after the physics simulation has completed.Parameters Parameter deltaTime: numberRunService.Misprediction: RBXScriptSignal<(time: number,instances: { any },stats: { [string]: any },)> In the server authority model, fires during prediction when the engine detects that the client has diverged from the server's authoritative state. Intended for plugin-based debugging.Parameters Parameter time: numberinstances: { any }stats: { [string]: any }RunService.PostSimulation: RBXScriptSignal<( deltaTimeSim: number)> Fires every frame, after the physics simulation has completed.Parameters Parameter deltaTimeSim: numberRunService.PreAnimation: RBXScriptSignal<( deltaTimeSim: number)> Fires every frame, prior to the physics simulation but after rendering.Parameters Parameter deltaTimeSim: numberRunService.PreRender: RBXScriptSignal<( deltaTimeRender: number)> Fires every frame, prior to the frame being rendered.Parameters Parameter deltaTimeRender: numberRunService.PreSimulation: RBXScriptSignal<( deltaTimeSim: number)> Fires every frame, prior to the physics simulation.Parameters Parameter deltaTimeSim: numberRunService.RenderStepped: RBXScriptSignal<( deltaTime: number)> Fires every frame, prior to the frame being rendered.Parameters Parameter deltaTime: numberRunService.RobloxGuiFocusedChanged: RBXScriptSignal<( isRobloxGuiFocused: boolean)> Parameters Parameter isRobloxGuiFocused: booleanRunService.Rollback: RBXScriptSignal<( time: number)> In the server authority model, this fires after rolling back the predicted state due to a misprediction, but before resimulation begins.Parameters Parameter time: numberRunService.Stepped: RBXScriptSignal<( time: number, deltaTime: number)> Fires every frame, prior to the physics simulation.
No events match the filters.