A utility to query information about the current runtime platform. More...
Inheritance diagram for IPlatformInfoService:
Public Member Functions | |
| PlatformContextFlags | GetContext () |
| Gets the platform context. These are flags, as the context may represent multiple roles at once, for example Editor and Player. | |
| PlatformDevice | GetDevice () |
| Gets the current platform device. | |
| string | GetVersion () |
| Gets the application version string. | |
Properties | |
| bool | IsPlayer [get] |
| Returns true if the platform context represents a player. | |
| bool | IsServer [get] |
| Returns true if the platform context represents a server. | |
| bool | IsEditor [get] |
| Returns true if the platform context represents the Unity Editor. | |
| bool | IsXrDevice [get] |
| Returns true if the platform device represents an XR-compatible device. | |
Detailed Description
A utility to query information about the current runtime platform.
Member Function Documentation
◆ GetContext()
| PlatformContextFlags GetContext | ( | ) |
Gets the platform context. These are flags, as the context may represent multiple roles at once, for example Editor and Player.
Implemented in PlatformInfoService.
◆ GetDevice()
| PlatformDevice GetDevice | ( | ) |
Gets the current platform device.
Implemented in PlatformInfoService.
◆ GetVersion()
| string GetVersion | ( | ) |
Gets the application version string.
Implemented in PlatformInfoService.
Property Documentation
◆ IsEditor
|
get |
Returns true if the platform context represents the Unity Editor.
Implemented in PlatformInfoService.
◆ IsPlayer
|
get |
Returns true if the platform context represents a player.
Implemented in PlatformInfoService.
◆ IsServer
|
get |
Returns true if the platform context represents a server.
Implemented in PlatformInfoService.
◆ IsXrDevice
|
get |
Returns true if the platform device represents an XR-compatible device.
Implemented in PlatformInfoService.
The documentation for this interface was generated from the following file:
- Runtime/Lifecycle/Services/PlatformInfoService.cs