Class Zone

• Defined in File Zone.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.Zone : xbe.sdk.EntityBase

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

Public Functions

Zone ()

Zone (Object obj)

Properties

string > Adjacent { get; set; }

The list of other zone id’s that are adjacent and directly reachable from this zone.

string > Allowed { get; set; }

The list of user id’s and role names that have permission to join this zone. Supports regex patterns.

bool AutoCreateShards { get; set; }

Should create shards based on population demand.

Object Data { get; set; }

The map of arbitrary data.

string Description { get; set; }

The textual description of the zone.

Object DesiredShards { get; set; }

The number of shards that are presently desired for this zone, expressed as a map of region name to number.

int MaxShards { get; set; }

The maximum number of shards that can be created for this zone. If set to -1 there is no limit.

int MaxShardUsers { get; set; }

The maximum number of users that can join any given shard for this zone.

int MinShards { get; set; }

The minimum number of shards that can be created for this zone.

Guid ProductUid { get; set; }

The uid of the product that this zone is associated with.

REQUIRES: Virtual World Services Studio.

string Name { get; set; }

The unique name of the zone.

string > Tags { get; set; }

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

string Title { get; set; }

The textual name of the zone to display to users.

Public Static Functions

new Zone Parse (string json)

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

Param json:

Return: