Class Space

Hierarchy

default
- Space

Constructors

constructor

new Space(id: ParcelOrSpaceId): Space

Overrides default.constructor
- Defined in parcel.ts:818
Parameters
- id: ParcelOrSpaceId
Returns Space

Properties

Optional address

address?: string

featuresList

featuresList: Feature[]

A list of all the Feature objects in the parcel

id

id: ParcelOrSpaceId

owner

owner: string = ""

Owner of the parcel

players

players: Map<string, Player>

A Map of all the players connected to the parcel; <token -> player>

snapshots

snapshots: Snapshot[]

A list of all the snapshots of the parcel; Is empty until fetchSnapshots() is called.

x1

x1: number

x2

x2: number

y1

y1: number

y2

y2: number

z1

z1: number

z2

z2: number

Accessors

allowLoggedInOnly

get allowLoggedInOnly(): boolean
set allowLoggedInOnly(state: boolean): void

Inherited from Parcel.allowLoggedInOnly
- Defined in parcel.ts:729
Returns boolean
Inherited from Parcel.allowLoggedInOnly
- Defined in parcel.ts:732
Parameters
- state: boolean
Returns void

allowedWallets

get allowedWallets(): string[]

Inherited from Parcel.allowedWallets
- Defined in parcel.ts:751
Returns string[]

isPrivate

get isPrivate(): boolean
set isPrivate(state: boolean): void

Inherited from Parcel.isPrivate
- Defined in parcel.ts:707
Returns boolean
Inherited from Parcel.isPrivate
- Defined in parcel.ts:710
Parameters
- state: boolean
Returns void

summary

get summary(): { contributors?: string[]; features?: FeatureDescription[]; id: string | number; palette?: string[]; tileset?: string; voxels?: string }

Inherited from Parcel.summary
- Defined in parcel.ts:119
Returns a summary of the parcel

Returns { contributors?: string[]; features?: FeatureDescription[]; id: string | number; palette?: string[]; tileset?: string; voxels?: string }
the properties of the parcel object.
- Optional contributors?: string[]
- Optional features?: FeatureDescription[]
- id: string | number
- Optional palette?: string[]
- Optional tileset?: string
- Optional voxels?: string

Methods

allow

allow(): void

Overrides default.allow
- Defined in parcel.ts:832
Returns void

broadcast

broadcast(message: ParcelBroadcastMessage): void

Inherited from default.broadcast
- Defined in parcel.ts:341
Broadcast a message to the client. Note: this is mainly used internally.

Parameters
- message: ParcelBroadcastMessage
Returns void

createFeature

createFeature(type: string, description?: FeatureDescription, shouldBroadcast?: boolean): Feature

Inherited from default.createFeature
- Defined in parcel.ts:597
Create a feature

Parameters
- type: string
  
  a valid feature type, eg: 'vox-model'
- Optional description: FeatureDescription
  
  an optional object.
- shouldBroadcast: boolean = true
Returns Feature
Feature

debug

debug(): void

Inherited from default.debug
- Defined in parcel.ts:349
Returns void

disallow

disallow(): void

Overrides default.disallow
- Defined in parcel.ts:829
Returns void

fetch

fetch(): void

Inherited from default.fetch
- Defined in parcel.ts:347
Returns void

fetchSnapshots

fetchSnapshots(callback?: null | Function): void

Overrides Parcel.fetchSnapshots
- Defined in parcel.ts:821
Parameters
- callback: null | Function = null
Returns void

getFeatureById

getFeatureById(id: string): undefined | Feature

Inherited from default.getFeatureById
- Defined in parcel.ts:441
Get a feature by its ID

Parameters
- id: string
  
  the feature's ID
Returns undefined | Feature
a Feature or undefined

getFeatureByUuid

getFeatureByUuid(uuid: string): undefined | Feature

Inherited from default.getFeatureByUuid
- Defined in parcel.ts:432
Get a feature by its UUID

Parameters
- uuid: string
  
  the feature's UUID
Returns undefined | Feature
a Feature or Undefined

getFeatures

getFeatures(): Feature[]

Inherited from default.getFeatures
- Defined in parcel.ts:448
Get a list of all features

Returns Feature[]
Feature[]

getFeaturesByType

getFeaturesByType(type: string): Feature[]

Inherited from default.getFeaturesByType
- Defined in parcel.ts:455
Get a list of all features of the given type

Parameters
- type: string
Returns Feature[]
Feature[]

getPlayerByUuid

getPlayerByUuid(uuid: string): undefined | Player

Inherited from default.getPlayerByUuid
- Defined in parcel.ts:395
Get a player by its UUID

Parameters
- uuid: string
  
  a string
Returns undefined | Player
a Player or Undefined

getPlayerByWallet

getPlayerByWallet(wallet: string): undefined | null | Player

Inherited from default.getPlayerByWallet
- Defined in parcel.ts:414
Get a player by its wallet

Parameters
- wallet: string
  
  the player's wallet
Returns undefined | null | Player
a Player object or undefined

getPlayers

getPlayers(): Player[]

Inherited from default.getPlayers
- Defined in parcel.ts:462
Get a list of all players connected to the parcel

Returns Player[]
Player[]

getPlayersWithinParcel

getPlayersWithinParcel(): Player[]

Inherited from default.getPlayersWithinParcel
- Defined in parcel.ts:475
Get a list of all players that are within the parcel A player within the parcel is player that's sent the event 'playerenter'

Returns Player[]
Player[]

isWalletAllowedIfPrivate

isWalletAllowedIfPrivate(wallet: string): boolean

Overrides default.isWalletAllowedIfPrivate
- Defined in parcel.ts:836
Parameters
- wallet: string
Returns boolean

parse

parse(parcel: ParcelDescription): void

Inherited from default.parse
- Defined in parcel.ts:378
Parse a parcel object

Parameters
- parcel: ParcelDescription
  
  an object {id:string,features:Feature[]}
Returns void

removeFeature

removeFeature(f: Feature, shouldBroadcast?: boolean): void

Inherited from default.removeFeature
- Defined in parcel.ts:631
Deletes a feature and removes it from the parcel

Parameters
- f: Feature
  
  Feature
- shouldBroadcast: boolean = true
Returns void

setSnapshot

setSnapshot(): void

Overrides Parcel.setSnapshot
- Defined in parcel.ts:825
Returns void

start

start(): void

Inherited from default.start
- Defined in parcel.ts:646
Returns void

Generated using TypeDoc