@acceleratxr/core_sdk / Zone
Class: Zone#
A zone is a representation of a particular place or region in a virtual world. Zones can be connected to others, creating a network of traversable spaces.
REQUIRES: Virtual World Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ Zone
Index#
Constructors#
Properties#
Accessors#
Object literals#
Constructors#
constructor#
+ new Zone(other?: any): Zone
Overrides EntityBase.constructor
Defined in src/models/Zone.ts:89
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Zone
Properties#
adjacent#
• adjacent: Array<string> = []
Defined in src/models/Zone.ts:24
The list of other zone id’s that are adjacent and directly reachable from this zone.
allowed#
• allowed: Array<string> = []
Defined in src/models/Zone.ts:29
The list of user id’s and role names that have permission to join this zone. Supports regex patterns.
autoCreateShards#
• autoCreateShards: boolean = true
Defined in src/models/Zone.ts:34
Set to true to have the service automatically create shards based on population demand, otherwise set to false.
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.
denied#
• denied: Array<string> = []
Defined in src/models/Zone.ts:47
The list of UID and role names that do not have permission to join this zone. Supports regex patterns.
description#
• description: string = “”
Defined in src/models/Zone.ts:52
The textual description of the zone.
desiredShards#
• desiredShards: any
Defined in src/models/Zone.ts:57
The number of shards that are presently desired for this zone, expressed as a map of region name to number.
maxShardUsers#
• maxShardUsers: number = 100
Defined in src/models/Zone.ts:67
The maximum number of users that can join any given shard for this zone.
maxShards#
• maxShards: number = -1
Defined in src/models/Zone.ts:62
The maximum number of shards that can be created for this zone. If set to -1 there is no limit.
minShards#
• minShards: number = 1
Defined in src/models/Zone.ts:72
The minimum number of shards that can be created for this zone.
name#
• name: string = “”
Defined in src/models/Zone.ts:19
The unique name of the zone.
productUid#
• productUid: string | undefined = undefined
Defined in src/models/Zone.ts:79
The uid of the product that this zone is associated with.
REQUIRES: Virtual World Services
title#
• title: string = “”
Defined in src/models/Zone.ts:89
The textual name of the zone to display to users.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/Zone.ts:14
Returns: string
Object literals#
data#
▪ data: object
Defined in src/models/Zone.ts:39
A map of arbitrary data. Each zone must define two properties in this field; buildVersions and initOptions. These are necessary in order to automatically create Shards with the necessary server information. Optionally, a third field regions may be specified which will limit Shard creation to only the regions specified.
Properties:#
Name |
Type |
Value |
|---|---|---|
|
never[] |
[] |
|
never[] |
[] |