A ServiceProvider is an abstract class, which stores, and provides certain
singleton classes, depending on what inherited class you are using its members
with.
Instances of this class cannot be created with Instance.new.
It is not visible in Studio's object browser.
Tags: [NotCreatable, NotBrowsable]
A ServiceProvider is an abstract base class that manages a registry of
singleton service instances. The DataModel (accessible in Lua as
game) is the primary ServiceProvider in an experience. Services are created
lazily the first time they are requested via
ServiceProvider:GetService() and remain available for the lifetime of
the DataModel.
You do not create ServiceProvider instances directly; instead you interact
with its members through the DataModel.
| Parameters (0) |
|---|
| No parameters. |
Fires when the game instance is shutting down, immediately before services
and instances are torn down. On the server this occurs when the last
player leaves or the server is closed; on the client it fires when the
player leaves the experience.
Connect to this event to perform final cleanup such as saving player data
with DataStoreService. Handlers run synchronously — the engine
waits for all connected callbacks to return before proceeding with
shutdown.
History 2
| Parameters (0) |
|---|
| No parameters. |
History 2
Returns the service with the given class name only if it has already been
created. Unlike ServiceProvider:GetService(), this method does not
create the service when it does not yet exist; it returns nil instead.
If className is not a valid service name, the method throws an error.
This method is thread-safe and can be called from any thread context. It
is useful when you need to check whether a service is present without
triggering its initialization, for example during cleanup or conditional
logic that should not force service creation.
History 5
Returns a service with the class name requested. When called with the name
of a service (such as Debris) it will return the instance of that
service. If the service does not yet exist it will be created and the new
service is returned. This is the only way to create some services, and can
also be used for services that have unusual names, e.g. RunService's name
is "Run Service".
Note:
- This function will return
nil if the className parameter is an
existing class, but the class is not a service. - If you attempt to fetch a service that is present under another Object,
an error will be thrown stating that the "singleton serviceName already
exists".
History 5
Fires after a service is added to the DataModel. The service parameter
is the Instance of the newly added service. Because services are
created lazily (the first time ServiceProvider:GetService() is
called for them), this event lets you react to a service becoming
available without polling for it.
History 2
Fires just before a service is removed from the DataModel. The service
parameter is the Instance that is about to be removed. This event
fires during DataModel teardown, giving listeners a chance to disconnect
from the service or release references before the service is destroyed.
History 2
It exists only for backward compatibility, and should not be used for new work.
GetService should be used instead.
History 3
Tags: [Deprecated]
It exists only for backward compatibility, and should not be used for new work.
GetService should be used instead.
History 4
Tags: [Deprecated]