RunService:IsRunMode() documentation does not match actual behavior

[Neutron_Flow]

As the name suggests, one would expect IsRunMode to return true ONLY when clicking the Run button in Studio. The documentation supports this assumption:

This method returns whether the Run button has been pressed to run the simulation in Studio.
…
Note that Studio only enters “run” mode when the Run button is pressed, not the Play button.

However, it also returns true on the server when using “Play”, “Play Here”, and “Local Server”. The response to a post from 2020 pointing out this incorrect behavior was that the documentation was wrong, as seen here:

RunService:IsRunMode() always returns 'true', even when using 'Play Here'/'Play' in Roblox Studio?

What context did you experience this problem in where you wanted the function to work differently? Because in my experience, the behavior that the function currently has is the most useful behavior, in that the server view in a Play session is very similar to the view in a Run session. So for instance any plugin that wants to do something specific in Run mode probably also wants to do the same thing in the Server view of Play. (That is to say, the current behavior is correct, and the current do…

If this truly is the intended behavior, the documentation should reflect this. If it’s not the intended behavior, the documentation should at least have a note about the current behavior until the behavior is fixed.

Thanks

Page URL: https://create.roblox.com/docs/reference/engine/classes/RunService#IsRunMode

[Focia19]

This is just an acknowledgment announcement!

We’ve filed a ticket into our internal database for this issue and will start investigating, we will update you when we have further information.

Thank you for flagging!