@vttforge/core / SceneLike

Interface: SceneLike<System>

A scene.

Extends

• DocumentMembers<System>

Type Parameters

System

System = Record<string, unknown>

Properties

active

readonly active: boolean

---

dimensions

readonly dimensions: Record<string, number>

---

documentName

readonly documentName: string

'Actor', 'Item', 'ActiveEffect', and so on.

Inherited from

DocumentMembers.documentName

---

drawings

readonly drawings: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

firstLevel

readonly firstLevel: LevelLike | null

---

flags

readonly flags: DocumentFlags

Inherited from

DocumentMembers.flags

---

grid

readonly grid: object

Index Signature

[key: string]: unknown

distance

distance: number

size

size: number

style

style: string

type

type: number

units

units: string

---

height

readonly height: number

---

id

readonly id: string | null

Inherited from

DocumentMembers.id

---

img

readonly img: string | null

Inherited from

DocumentMembers.img

---

initialLevel

readonly initialLevel: LevelLike | null

---

isOwner

readonly isOwner: boolean

Whether the current user owns this document.

Inherited from

DocumentMembers.isOwner

---

isView

readonly isView: boolean

---

levels

readonly levels: EmbeddedCollection<LevelLike>

New in v14. The background and fog moved onto these.

---

lights

readonly lights: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

name

readonly name: string

Inherited from

DocumentMembers.name

---

navigation

readonly navigation: boolean

---

navName

readonly navName: string

---

navOrder

readonly navOrder: number

---

notes

readonly notes: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

padding

readonly padding: number

---

parent

readonly parent: DocumentMembers<Record<string, unknown>> | null

The document this one is embedded in, or null at the top level.

Inherited from

DocumentMembers.parent

---

regions

readonly regions: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

sounds

readonly sounds: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

system

readonly system: System

The type data model instance. Its fields are the schema's fields.

Inherited from

DocumentMembers.system

---

thumb

readonly thumb: string | null

---

tiles

readonly tiles: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

tokens

readonly tokens: EmbeddedCollection<TokenDocumentLike<Record<string, unknown>>>

---

tokenVision

readonly tokenVision: boolean

---

type

readonly type: string

The subtype, as declared under documentTypes in the manifest.

Inherited from

DocumentMembers.type

---

uuid

readonly uuid: string

Inherited from

DocumentMembers.uuid

---

walls

readonly walls: EmbeddedCollection<DocumentMembers<Record<string, unknown>>>

---

weather

readonly weather: string

---

width

readonly width: number

Methods

activate()

activate(): Promise<SceneLike<System>>

Returns

Promise<SceneLike<System>>

---

delete()

delete(operation?): Promise<SceneLike<System> | undefined>

Parameters

operation?

Record<string, unknown>

Returns

Promise<SceneLike<System> | undefined>

Inherited from

DocumentMembers.delete

---

getFlag()

getFlag<T>(scope, key): T | undefined

Type Parameters

T

T = unknown

Parameters

scope

string

key

string

Returns

T | undefined

Inherited from

DocumentMembers.getFlag

---

setFlag()

setFlag(scope, key, value): Promise<SceneLike<System>>

Parameters

scope

string

key

string

value

unknown

Returns

Promise<SceneLike<System>>

Inherited from

DocumentMembers.setFlag

---

toObject()

toObject(source?): Record<string, unknown>

A plain-object copy. source reads the stored data instead of the prepared data.

Parameters

source?

boolean

Returns

Record<string, unknown>

Inherited from

DocumentMembers.toObject

---

unsetFlag()

unsetFlag(scope, key): Promise<SceneLike<System>>

Parameters

scope

string

key

string

Returns

Promise<SceneLike<System>>

Inherited from

DocumentMembers.unsetFlag

---

update()

update(data, operation?): Promise<SceneLike<System> | undefined>

Parameters

data

Record<string, unknown>

operation?

Record<string, unknown>

Returns

Promise<SceneLike<System> | undefined>

Inherited from

DocumentMembers.update

---

view()

view(): Promise<SceneLike<System>>

Returns

Promise<SceneLike<System>>