v1.0.0
Latest
2022.3+
Class FleetInfo
Information of the fleet
Inheritance
System.Object
FleetInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unity.Services.Multiplay.Authoring.Core.MultiplayApi
Syntax
public class FleetInfoProperties
Allocation
Fleet allocation information
Declaration
public AllocationStatus Allocation { get; }Property Value
| Type | Description |
|---|---|
| AllocationStatus |
BuildConfigInfos
Information about the build configurations
Declaration
public List<BuildConfigInfo> BuildConfigInfos { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<Unity.Services.Multiplay.Authoring.Core.MultiplayApi.BuildConfigInfo> |
FleetName
Name of the fleet
Declaration
public string FleetName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
FleetStatus
Status of the fleet
Declaration
public FleetInfo.Status FleetStatus { get; }Property Value
| Type | Description |
|---|---|
| FleetInfo.Status |
Id
Id of the fleet
Declaration
public FleetId Id { get; }Property Value
| Type | Description |
|---|---|
| FleetId |
Regions
Information about the fleet regions.
Declaration
public List<FleetRegionInfo> Regions { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<FleetRegionInfo> |
UsageSettings
A list of usage settings associated with the fleet.
Declaration
public List<MultiplayConfig.FleetUsageSetting> UsageSettings { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<MultiplayConfig.FleetUsageSetting> |
Methods
AllocationStatus(Int32, Int32, Int32, Int32)
The total allocation status
Declaration
public record AllocationStatus(int Total, int Allocated, int Available, int Online)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | Total | Total number of servers |
| System.Int32 | Allocated | Number of Servers allocated |
| System.Int32 | Available | Number of Servers available |
| System.Int32 | Online | Number of Servers online |
Returns
| Type | Description |
|---|---|
| record |
BuildConfigInfo(Int64, String)
Information of a BuildConfig
Declaration
public record BuildConfigInfo(long Id, string Name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | Id | BuildConfig ID |
| System.String | Name | Name of associated BuildConfig |
Returns
| Type | Description |
|---|---|
| record |
FleetRegionInfo(Guid, Guid, String)
Information of fleet region
Declaration
public record FleetRegionInfo(Guid Id, Guid RegionId, string Name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | Id | Fleet region ID |
| System.Guid | RegionId | Region ID |
| System.String | Name | Name of associated region |
Returns
| Type | Description |
|---|---|
| record |