RunService

Show Deprecated
Not Creatable
Service
Not Replicated

Summary

Properties

Methods

Properties

ClientGitHash

Read Only
Not Replicated
Roblox Script Security
Read Parallel
Not Replicated
Plugin Security
Read Parallel

Methods

BindToRenderStep

()

Parameters

name: string
Default Value: ""
priority: number
Default Value: ""
function: function
Default Value: ""

Returns

()

Code Samples

Frame Moving in Circle

local RunService = game:GetService("RunService")
-- How fast the frame ought to move
local SPEED = 2
local frame = script.Parent
frame.AnchorPoint = Vector2.new(0.5, 0.5)
-- A simple parametric equation of a circle
-- centered at (0.5, 0.5) with radius (0.5)
local function circle(t)
return 0.5 + math.cos(t) * 0.5, 0.5 + math.sin(t) * 0.5
end
-- Keep track of the current time
local currentTime = 0
local function onRenderStep(deltaTime)
-- Update the current time
currentTime = currentTime + deltaTime * SPEED
-- ...and the frame's position
local x, y = circle(currentTime)
frame.Position = UDim2.new(x, 0, y, 0)
end
-- This is just a visual effect, so use the "Last" priority
RunService:BindToRenderStep("FrameCircle", Enum.RenderPriority.Last.Value, onRenderStep)
--RunService.RenderStepped:Connect(onRenderStep) -- Also works, but not recommended
RunService Custom Function

local RunService = game:GetService("RunService")
local function checkDelta(deltaTime)
print("Time since last render step:", deltaTime)
end
RunService:BindToRenderStep("Check delta", Enum.RenderPriority.First.Value, checkDelta)
Bind and Unbind a Function

local RunService = game:GetService("RunService")
-- Step 1: Declare the function and a name
local NAME = "Print Hello"
local function printHello()
print("Hello")
end
-- Step 2: Bind the function
RunService:BindToRenderStep(NAME, Enum.RenderPriority.First.Value, printHello)
-- Step 3: Unbind the function
RunService:UnbindFromRenderStep(NAME)

IsClient

Write Parallel

Returns

IsEdit

Plugin Security
Write Parallel

Returns

IsRunMode

Write Parallel

Returns

IsRunning


Returns

IsServer

Write Parallel

Returns

IsStudio

Write Parallel

Returns

Pause

()
Plugin Security

Returns

()

Run

()
Plugin Security

Returns

()

Stop

()
Plugin Security

Returns

()

UnbindFromRenderStep

()

Parameters

name: string
Default Value: ""

Returns

()

Events

Heartbeat

Parameters

deltaTime: number

PostSimulation

Parameters

deltaTimeSim: number

PreAnimation

Parameters

deltaTimeSim: number

PreRender

Parameters

deltaTimeRender: number

PreSimulation

Parameters

deltaTimeSim: number

RenderStepped

Parameters

deltaTime: number

Stepped

Parameters

time: number
deltaTime: number