Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RunService

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 29

HistoryMember
553ClientGitHash: string
622RunState: RunState
573BindToRenderStep(name: string, priority: int, function: Function): null
462GetCoreScriptVersion(): string
527GetRobloxClientChannel(): string
609GetRobloxGuiFocused(): bool
462GetRobloxVersion(): string
538IsClient(): bool
538IsEdit(): bool
538IsRunMode(): bool
462IsRunning(): bool
538IsServer(): bool
538IsStudio(): bool
573Pause(): null
573Reset(): null
573Run(): null
573Set3dRenderingEnabled(enable: bool): null
573SetRobloxGuiFocused(focus: bool): null
573Stop(): null
573UnbindFromRenderStep(name: string): null
573setThrottleFramerateEnabled(enable: bool): null
469Heartbeat(deltaTime: double)
548PostSimulation(deltaTimeSim: double)
548PreAnimation(deltaTimeSim: double)
548PreRender(deltaTimeRender: double)
548PreSimulation(deltaTimeSim: double)
469RenderStepped(deltaTime: double)
609RobloxGuiFocusedChanged(isRobloxGuiFocused: bool)
469Stepped(time: double, deltaTime: double)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 1

HistoryMember
347RobloxOnlyIsEdit(): bool

History 103

Members 29

BindToRenderStep

Parameters (3)
namestring
priorityint
functionFunction
Returns (1)
null
Thread safetyUnsafe

History 3

ClientGitHash

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 3

Tags: [ReadOnly, NotReplicated]

GetCoreScriptVersion

Parameters (0)
No parameters.
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

GetRobloxClientChannel

Parameters (0)
No parameters.
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetRobloxGuiFocused

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetRobloxVersion

Parameters (0)
No parameters.
Returns (1)
string
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

Heartbeat

Parameters (1)
deltaTimedouble
Thread safetyUnsafe

History 7

IsClient

Parameters (0)
No parameters.
Returns (1)
bool
Thread safetySafe

History 3

IsEdit

Parameters (0)
No parameters.
Returns (1)
bool
SecurityPluginSecurity
Thread safetySafe

History 5

IsRunMode

Parameters (0)
No parameters.
Returns (1)
bool
Thread safetySafe

History 3

IsRunning

Parameters (0)
No parameters.
Returns (1)
bool
Thread safetyUnsafe

History 3

IsServer

Parameters (0)
No parameters.
Returns (1)
bool
Thread safetySafe

History 3

IsStudio

Parameters (0)
No parameters.
Returns (1)
bool
Thread safetySafe

History 3

Pause

Parameters (0)
No parameters.
Returns (1)
null
SecurityPluginSecurity
Thread safetyUnsafe

History 5

PostSimulation

Parameters (1)
deltaTimeSimdouble
Thread safetyUnsafe

History 2

PreAnimation

Parameters (1)
deltaTimeSimdouble
Thread safetyUnsafe

History 2

PreRender

Parameters (1)
deltaTimeRenderdouble
Thread safetyUnsafe

History 2

PreSimulation

Parameters (1)
deltaTimeSimdouble
Thread safetyUnsafe

History 2

RenderStepped

Parameters (1)
deltaTimedouble
Thread safetyUnsafe

History 6

Reset

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity
Thread safetyUnsafe

History 6

  • 573 Change ReturnType of Reset from void to null
  • 462 Change ThreadSafety of Reset from to Unsafe
  • 151 Change Security of Reset from security1 to PluginSecurity
  • 150 Change Security of Reset from LocalUserSecurity to security1
  • 76 Change Tags of Reset from [] to [Deprecated]
  • 47 Add Reset
Tags: [Deprecated]

RobloxGuiFocusedChanged

Parameters (1)
isRobloxGuiFocusedbool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Run

Parameters (0)
No parameters.
Returns (1)
null
SecurityPluginSecurity
Thread safetyUnsafe

History 5

  • 573 Change ReturnType of Run from void to null
  • 462 Change ThreadSafety of Run from to Unsafe
  • 151 Change Security of Run from security1 to PluginSecurity
  • 150 Change Security of Run from LocalUserSecurity to security1
  • 47 Add Run

RunState

TypeDefault
RunState
This property is not replicated. Its interface does not cross the network boundary.
SecurityPluginSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 4

  • 622 Change WriteSecurity of RunState from RobloxScriptSecurity to PluginSecurity
  • 622 Change Tags of RunState from [Hidden, NotReplicated] to [NotReplicated]
  • 622 Change ReadSecurity of RunState from RobloxScriptSecurity to PluginSecurity
  • 615 Add RunState
Tags: [NotReplicated]

Set3dRenderingEnabled

Parameters (1)
enablebool
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

SetRobloxGuiFocused

Parameters (1)
focusbool
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

Stepped

Parameters (2)
timedouble
deltaTimedouble
Thread safetyUnsafe

History 7

Stop

Parameters (0)
No parameters.
Returns (1)
null
SecurityPluginSecurity
Thread safetyUnsafe

History 5

  • 573 Change ReturnType of Stop from void to null
  • 462 Change ThreadSafety of Stop from to Unsafe
  • 151 Change Security of Stop from security1 to PluginSecurity
  • 150 Change Security of Stop from LocalUserSecurity to security1
  • 76 Add Stop

UnbindFromRenderStep

Parameters (1)
namestring
Returns (1)
null
Thread safetyUnsafe

History 3

setThrottleFramerateEnabled

Parameters (1)
enablebool
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

Removed members 1

RobloxOnlyIsEdit

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity

History 2

Settings