IsClient

Function of:

Description:

This function returns whether the current environment is running on the client.

If the code that invoked this method is running in a client context (in a LocalScript or a ModuleScript required by a LocalScript) then this method will return true. In all other cases, this function will return false.

If this function returns true, then the current environment can access client-only features like RunService/RenderStepped or Players/LocalPlayer.

RunService test function results

Environment	IsStudio	IsClient	IsServer	IsEdit	IsRunning	IsRunMode
Live Player	false	true	false
Live Server	false	false	true
Edit Mode	true	true	true	true	false	false
Edit Mode (Team Create)	true	true	false	true	false	false
Run Mode	true	true	true	false	true	true
Play Mode (Client)	true	true	false	false	true	false
Play Mode (Server)	true	false	true	false	true	true
Team Test Player	true	true	false	false	true	false
Legacy Play Mode[^1]	true	true	true	false	true	false

Returns

Return Type	Summary
Return Type bool	Summary Whether the current environment is running the client

Code Samples

Run Context

This code prints out details of a script’s running context, like if it is running on the server, client, in studio, etc. It uses RunService to do this.

Try pasting this code into a Script or LocalScript. See how it runs in online mode and on a Roblox server (open the developer console).

Expand

local RunService = game:GetService("RunService")

if RunService:IsStudio() then
	print("I am in Roblox Studio")
else
	print("I am in an online Roblox Server")
end

if RunService:IsRunMode() then
	print("Running in Studio")
end

if RunService:IsClient() then
	print("I am a client")
else
	print("I am not a client")
end

if RunService:IsServer() then
	print("I am a server")
else
	print("I am not a server")
end

if RunService:IsRunning() then
	print("The game is running")
else
	print("The game is stopped or paused")
end

Copy Code Light Theme

IsClient

RunService test function results

See also

Returns

bool

Code Samples

Run Context