Class BestCommentatorCollection

最佳解說員的劇本集合，由 TerrainView.bestCommentator 取得。另粒子下雨/煙霧/爆炸效果需要額外載入粒子特效模組方能正常顯示。

Param: terrainView

依存的目標環境。

Accessors

count groups isAutoPlayNext

Methods

SetGPXEntity createGroup createGroupUI deleteGroup exportBestCommentatorFile exportBestCommentatorJSON exportBestCommentatorKML exportBestCommentatorKMLFile getGroup importBestCommentatorFile importBestCommentatorJSON importBestCommentatorKML importBestCommentatorKMLFile playGroup resetShellObject stop

Accessors

count

  • get count(): number

  • 群組數量

    Returns number

groups

isAutoPlayNext

  • get isAutoPlayNext(): boolean

  • 是否自動播放下一章

    Returns boolean

  • set isAutoPlayNext(value): void

  • 是否自動播放下一章

    Parameters

    • value: boolean

    Returns void

Methods

SetGPXEntity

createGroup

  • createGroup(name, description): boolean

  • 建立指定名稱的最佳解說員群組到集合中

    Parameters

    • name: string

      最佳解說員的名稱。

    • description: string

      最佳解說員的描述。

    Returns boolean

    是否新增成功。

createGroupUI

  • createGroupUI(): void

  • 顯示建立最佳解說員群組的對話框

    Returns void

deleteGroup

  • deleteGroup(name): boolean

  • 刪除指定名稱的最佳解說員群組

    Parameters

    • name: string

      最佳解說員的名稱。

    Returns boolean

    是否刪除成功。

exportBestCommentatorFile

  • exportBestCommentatorFile(fileName, indentation): void

  • 匯出並下載最佳解說員(JSON)

    Parameters

    • fileName: string

      匯出的檔案名稱，若留空將會以UI詢問。

    • indentation: boolean

      匯出的JSON字串是否要縮排。

    Returns void

exportBestCommentatorJSON

  • exportBestCommentatorJSON(indentation): string

  • 以JSON匯出最佳解說員

    Parameters

    • indentation: boolean

      匯出的JSON字串是否要縮排。

    Returns string

    匯出的JSON。

exportBestCommentatorKML

  • exportBestCommentatorKML(): string

  • 以KML匯出最佳解說員

    Returns string

    匯出的KML。

exportBestCommentatorKMLFile

  • exportBestCommentatorKMLFile(fileName): void

  • 匯出並下載最佳解說員(KML)

    Parameters

    • fileName: string

      匯出的檔案名稱，若留空將會以UI詢問。

    Returns void

getGroup

  • getGroup(name): null | BestCommentatorGroup

  • 取得指定名稱的最佳解說員群組

    Parameters

    • name: string

      最佳解說員的名稱。

    Returns null | BestCommentatorGroup

    最佳解說員群組。

importBestCommentatorFile

  • importBestCommentatorFile(file, callback?): void

  • 匯入最佳解說員檔案物件

    Parameters

    • file: File

      匯入的檔案物件。

    • Optional callback: (() => void)

      匯入完成後的回呼。

        • (): void

        • Returns void

    Returns void

importBestCommentatorJSON

  • importBestCommentatorJSON(json): void

  • 以JSON匯入最佳解說員

    Parameters

    • json: string

      要匯入的JSON字串。

    Returns void

importBestCommentatorKML

  • importBestCommentatorKML(xml): void

  • 以KML匯入最佳解說員

    Parameters

    • xml: string

      要匯入的KML字串。

    Returns void

importBestCommentatorKMLFile

  • importBestCommentatorKMLFile(file, callback?): void

  • 匯入最佳解說員KML檔案物件

    Parameters

    • file: File

      匯入的KML檔案物件

    • Optional callback: (() => void)

      import完成後的回呼。

        • (): void

        • Returns void

    Returns void

playGroup

  • playGroup(name, event?): void

  • 撥放指定名稱的群組

    Parameters

    • name: string

      指定的群組名稱。

    • Optional event: {
          onFinish?: (() => void);
          onStart?: ((name) => void);
          onStop?: (() => void);
      }

      指定接下來這個最佳解說員的撥放事件，有以下三種可選的事件:

      • OnStart: 當一個群組開始撥放時
      • OnStop: 當一個群組撥放被中斷時
      • OnFinish: 當一個群組撥放完畢時
      • Optional onFinish?: (() => void)
          • (): void

          • Returns void

      • Optional onStart?: ((name) => void)
          • (name): void

          • Parameters

            • name: string

            Returns void

      • Optional onStop?: (() => void)
          • (): void

          • Returns void

    Returns void

resetShellObject

  • resetShellObject(): void

  • 依照核心引擎的狀態將殼層物件重設

    Returns void

stop

  • stop(): void

  • 撥放中止

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc