Class Shard

• Defined in File Shard.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.Shard : xbe.sdk.EntityBase

A shard is a representation of a zone with a physical/network location that players can connect to. Shards have a one-to-one relationship with game server instances.

REQUIRES: Virtual World Services

Public Functions

Shard ()

Shard (Object obj)

Properties

Object Data { get; set; }

Map of arbitrary data.

DateTime LastHeartbeat { get; set; }

The last time that the associated server instance made contact with the service.

int MaxUsers { get; set; }

The maximum number of users that can join the shard.

string Region { get; set; }

The name of the region that the associated server instance is running in.

string Status { get; set; }

The current availability status of the shard.

string > Tags { get; set; }

The list of descriptive labels that describes the shard, as inherited from the Zone.

string Url { get; set; }

The URL that players use to connect to the associated server instance.

Guid > Users { get; set; }

The list of user id’s that are joined to this shard.

Guid ZoneUid { get; set; }

The zone id that the shard belongs to.

Public Static Functions

new Shard Parse (string json)

Parses the given JSON encoded string into a new Shard instance.

Param json:

Return:

Public Static Attributes

const string STATUS_INITIALIZING = "INITIALIZING"

const string STATUS_AVAILABLE = "AVAILABLE"

const string STATUS_UNAVAILABLE = "UNAVAILABLE"