default | Voxels-Scripting-Engine

Represents the Parcel instance.

Hierarchy

AbstractParcel
- default
  - Space

Constructors

constructor

new default(id: ParcelOrSpaceId): default

Overrides AbstractParcel.constructor
- Defined in parcel.ts:107
Parameters
- id: ParcelOrSpaceId
Returns default

Properties

Optional address

address?: string

featuresList

featuresList: Feature[]

A list of all the Feature objects in the parcel

fetchSnapshots

fetchSnapshots: (callback?: (snapshots: Snapshot[]) => void) => void = ...

Type declaration

- (callback?: (snapshots: Snapshot[]) => void): void
- Throttled function to fetch the snapshots of the parcel;
  
  Parameters
  - Optional callback: (snapshots: Snapshot[]) => void
    a Callback expecting an array of objects. Eg:
    
    function myCallback(snapshots){ parcel.setSnapshot(snapshots[0].id) } feature.on('click',e=>{ parcel.fetchSnapshots(myCallback) })
    - - (snapshots: Snapshot[]): void
      - Parameters
        snapshots: Snapshot[]
        Returns void
  Returns void

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>

setSnapshot

setSnapshot: (snapshot_id: number) => void = ...

Type declaration

- (snapshot_id: number): void
- Sets the parcel content to the given snapshot index. This should be called after 'fetchSnaphots' has been called.
  
  Parameters
  - snapshot_id: number
  Returns void

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

- Defined in parcel.ts:729
Returns boolean
- Defined in parcel.ts:732
Parameters
- state: boolean
Returns void

allowedWallets

get allowedWallets(): string[]

- Defined in parcel.ts:751
Returns string[]

isPrivate

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

- Defined in parcel.ts:707
Returns boolean
- 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 }

- 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(walletOrWallets: string | string[]): void

- Defined in parcel.ts:755
Parameters
- walletOrWallets: string | string[]
Returns void

broadcast

broadcast(message: ParcelBroadcastMessage): void

- 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

- 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

- Defined in parcel.ts:349
Returns void

disallow

disallow(wallet: string): void

- Defined in parcel.ts:778
Parameters
- wallet: string
Returns void

fetch

fetch(): void

- Defined in parcel.ts:347
Returns void

getFeatureById

getFeatureById(id: string): undefined | Feature

- 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

- 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[]

- Defined in parcel.ts:448
Get a list of all features

Returns Feature[]
Feature[]

getFeaturesByType

getFeaturesByType(type: string): Feature[]

- 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

- 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

- 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[]

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

Returns Player[]
Player[]

getPlayersWithinParcel

getPlayersWithinParcel(): Player[]

- 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

- Defined in parcel.ts:802
Parameters
- Optional wallet: string
Returns boolean

parse

parse(parcel: ParcelDescription): void

- 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

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

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

start

start(): void

- Defined in parcel.ts:646
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: ParcelOrSpaceId

Returns default

Properties

Optional address

featuresList

fetchSnapshots

Type declaration

Parameters

Optional callback: (snapshots: Snapshot[]) => void

Parameters

snapshots: Snapshot[]

Returns void

Returns void

id

owner

players

setSnapshot

Type declaration

Parameters

snapshot_id: number

Returns void

snapshots

x1

x2

y1

y2

z1

z2

Accessors

allowLoggedInOnly

Returns boolean

Parameters

state: boolean

Returns void

allowedWallets

Returns string[]

isPrivate

Returns boolean

Parameters

state: boolean

Returns void

summary

Returns { contributors?: string[]; features?: FeatureDescription[]; id: string | number; palette?: string[]; tileset?: string; voxels?: string }

Optional contributors?: string[]

Optional features?: FeatureDescription[]

id: string | number

Optional palette?: string[]

Optional tileset?: string

Optional voxels?: string

Methods

allow

Parameters

walletOrWallets: string | string[]

Returns void

broadcast

Parameters

message: ParcelBroadcastMessage

Returns void

createFeature

Parameters

type: string

Optional description: FeatureDescription

shouldBroadcast: boolean = true

Returns Feature

debug

Returns void

disallow

Parameters

wallet: string

Returns void

fetch