PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. RunService

RunService

Show deprecated
Hide content
  1. apireference
  2. runservice

RunService

Show deprecated

RunService contains methods and events for time-management as well as for managing the context in which a game or script is running. Methods like RunService/IsClient|IsClient, RunService/IsServer|IsServer, RunService/IsStudio|IsStudio, can help you determine under what context code is running. These methods are useful for ModuleScripts that may be required by both client and server scripts. Furthermore, RunService/IsStudio|IsStudio can be used to add special behaviors for in-studio testing.

RunService also houses events that allow your code to adhere to Roblox’s frame-by-frame loop, such as RunService/Stepped|Stepped, RunService/Heartbeat|Heartbeat and RunService/RenderStepped|RenderStepped. Selecting the proper event to use for any case is important, so you should read articles/Task Scheduler|Task Scheduler to make an informed decision.

Properties

string

ClientGitHash

[ReadOnly] [NotReplicated]

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

BindToRenderStep ( string name , int priority , Function function )

Given a string name of a function and a priority, this method binds the function to RunService/RenderStepped
string

GetCoreScriptVersion ( )

string

GetRobloxVersion ( )

bool

IsClient ( )

Returns whether the current environment is running on the client
bool

IsEdit ( )

Returns whether the current environment is in Edit mode
bool

IsRunMode ( )

Returns whether the ‘Run’ button has been pressed to run the simulation in Roblox Studio
bool

IsRunning ( )

Returns whether the game is currently running
bool

IsServer ( )

Returns whether the current environment is running on the server
bool

IsStudio ( )

Returns whether the current environment is running in Roblox Studio
void

Pause ( )

Pauses the game’s simulation if it is running, suspending physics and scripts
void

Reset ( )

[Deprecated]

Resets the current game to a waypoint set when RunService/Run was called
void

Run ( )

Runs the game’s simulation, running physics and scripts
void

Set3dRenderingEnabled ( bool enable )

void

SetRobloxGuiFocused ( bool focus )

void

Stop ( )

Ends the game’s simulation if it is running
void

UnbindFromRenderStep ( string name )

Unbinds a function that was bound to the render loop using RunService/BindToRenderStep
void

setThrottleFramerateEnabled ( bool enable )

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

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

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

Heartbeat ( double deltaTime )

Fires every frame after the physics simulation has completed
RBXScriptSignal

PostSimulation ( double deltaTime )

RBXScriptSignal

PreAnimation ( double deltaTime )

RBXScriptSignal

PreRender ( double deltaTime )

RBXScriptSignal

PreSimulation ( double deltaTime )

RBXScriptSignal

RenderStepped ( double deltaTime )

Fires every frame prior to the frame being rendered
RBXScriptSignal

Stepped ( double time , double deltaTime )

Fires every frame prior to the physics simulation

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

RunService Stepped

This code sample uses RunService’s Stepped event to create a Part that flies in a direction given a start position and speed. It uses a BodyPosition to move the Part, and calculates the new position of the Part each frame.

Copy Code Light Theme
ReplicatedFirst Script