Skip to content

Document ProfileService.IsLive() #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BaileyTab wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document ProfileService.IsLive() #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@ Analytics endpoint for cases when DataStore is throwing too many errors and it's
likely affecting your game really really bad - this could be due to developer errors
or due to Roblox server problems. Could be used to alert players about data store outages.

### ProfileService.IsLive()
``` lua
ProfileService.IsLive() --> [bool] -- (CAN YIELD!!!)
```
Returns true if ProfileService is connected to Roblox DataStores

!!! notice
`.IsLive()` can only return false in Studio

!!! warning
`.IsLive()` can yield while checking if datastores are available in Studio


### ProfileService.GetProfileStore()
``` lua
ProfileService.GetProfileStore(
Expand Down