Class: Shard

Class: Shard#

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

author Jean-Philippe Steinmetz info@acceleratxr.com

Hierarchy#

Index#

Constructors#

Properties#

Accessors#

Constructors#

constructor#

+ new Shard(other?: any): Shard

Overrides EntityBase.constructor

Defined in src/models/Shard.ts:78

Parameters:#

Name

Type

other?

any

Returns: Shard

Properties#

buildVersion#

• buildVersion: string = “”

Defined in src/models/Shard.ts:28

The build version that the associated server instance is running.

data#

• data: any = undefined

Defined in src/models/Shard.ts:33

A map of arbitrary data.

dateCreated#

• dateCreated: Date = new Date()

Inherited from EntityBase.dateCreated

Defined in src/EntityBase.ts:18

The date and time that the object was created.

dateModified#

• dateModified: Date = new Date()

Inherited from EntityBase.dateModified

Defined in src/EntityBase.ts:23

The date and time that the object was last modified.

lastHeartbeat#

• lastHeartbeat: Date = new Date()

Defined in src/models/Shard.ts:38

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

maxUsers#

• maxUsers: number = 0

Defined in src/models/Shard.ts:43

The maximum number of users that can join the shard.

numUsers#

• numUsers: number = 0

Defined in src/models/Shard.ts:48

The current number of users that have joined the shard.

region#

• region: string = “”

Defined in src/models/Shard.ts:53

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

status#

• status: ShardStatus = ShardStatus.INITIALIZING

Defined in src/models/Shard.ts:58

The current availability status of the shard.

tags#

• tags: Array<string> = []

Defined in src/models/Shard.ts:63

A list of descriptive labels that describes the shard, as inherited from the Zone and server instance.

uid#

• uid: string = uuid.v4()

Inherited from EntityBase.uid

Defined in src/EntityBase.ts:13

The universally unique identifier of the object.

url#

• url: string = “”

Defined in src/models/Shard.ts:68

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

users#

• users: Array<string> = []

Defined in src/models/Shard.ts:73

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

version#

• version: number = 0

Inherited from EntityBase.version

Defined in src/EntityBase.ts:28

The optimistic locking version of the object.

zoneUid#

• zoneUid: string = “”

Defined in src/models/Shard.ts:78

The zone id that the shard belongs to.

Accessors#

ClassName#

• Staticget ClassName(): string

Defined in src/models/Shard.ts:23

Returns: string