Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ActorDelta

The client-side ActorDelta embedded document which extends the common BaseActorDelta document model.

mixes

ClientDocumentMixin

see

TokenDocument The TokenDocument document type which contains ActorDelta embedded documents.

Hierarchy

  • any
    • ActorDelta

Index

Constructors

Methods

Constructors

constructor

  • Returns ActorDelta

Methods

_configure

  • _configure(options?: {}): void
  • inheritdoc

    Parameters

    • options: {} = {}

      Returns void

    _initialize

    • _initialize(__namedParameters?: { sceneReset: boolean }): void
    • inheritdoc

      Parameters

      • __namedParameters: { sceneReset: boolean } = {}
        • sceneReset: boolean

      Returns void

    apply

    • apply(context?: any): Actor

    • Apply this ActorDelta to the base Actor and return a synthetic Actor.

      Parameters

      • context: any = {}

      Returns Actor

    prepareEmbeddedDocuments

    • prepareEmbeddedDocuments(): void
    • override

      Returns void

    updateSource

    • updateSource(changes?: {}, options?: {}): any
    • inheritdoc

      Parameters

      • changes: {} = {}
        • options: {} = {}

          Returns any

        reset

        • reset(): void
        • inheritdoc

          Returns void

        _createSyntheticActor

        • _createSyntheticActor([options]?: { reinitializeCollections: boolean }): void

        • Generate a synthetic Actor instance when constructed, or when the represented Actor, or actorLink status changes.

          internal

          Parameters

          • [options]: { reinitializeCollections: boolean } = {}
            • reinitializeCollections: boolean

          Returns void

        updateSyntheticActor

        • updateSyntheticActor(): void

        • Update the synthetic Actor instance with changes from the delta or the base Actor.

          Returns void

        restore

        • restore(): Promise<Actor>

        • Restore this delta to empty, inheriting all its properties from the base actor.

          Returns Promise<Actor>

          The restored synthetic Actor.

        _handleDeltaCollectionUpdates

        • _handleDeltaCollectionUpdates(doc: Document): any

        • Ensure that the embedded collection delta is managing any entries that have had their descendants updated.

          internal

          Parameters

          • doc: Document

            The parent whose immediate children have been modified.

          Returns any

        _preDelete

        • _preDelete(options: any, user: any): Promise<any>

        • Parameters

          • options: any
          • user: any

          Returns Promise<any>

        _onUpdate

        • _onUpdate(data: any, options: any, userId: any): void
        • override

          Parameters

          • data: any
          • options: any
          • userId: any

          Returns void

        _onDelete

        • _onDelete(options: any, userId: any): void
        • inheritdoc

          Parameters

          • options: any
          • userId: any

          Returns void

        _dispatchDescendantDocumentEvents

        • _dispatchDescendantDocumentEvents(event: any, collection: any, args: any, _parent: any): void
        • inheritdoc

          Parameters

          • event: any
          • collection: any
          • args: any
          • _parent: any

          Returns void