new ov.BestCommentatorCollection(terrainView)
webgl/ov-BestCommentatorCollection.js, line 6
最佳解說員的劇本集合,由TerrainView.bestCommentator取得。另粒子下雨/煙霧/爆炸效果需要額外載入粒子特效模組方能正常顯示。
Name | Type | Description |
---|---|---|
terrainView |
ov.TerrainView |
依存的目標環境。 |
Members
-
readonlycount
-
群組數量
Properties:
Name Type Description count
Number 群組數量
-
readonlygroups
-
群組陣列
Properties:
Name Type Description groups
Array.<ov.BestCommentatorGroup> 群組陣列
-
readonlyisAutoPlayNext
-
是否自動播放下一章
- See:
-
- ov.BestCommentatorGroup#GroupProperty
Properties:
Name Type Description isAutoPlayNext
Boolean 是否自動播放下一章
Methods
-
createGroup(name, description){Boolean}
webgl/ov-BestCommentatorCollection.js, line 283 -
建立指定名稱的最佳解說員群組到集合中
Name Type Description name
String 最佳解說員的名稱。
description
String 最佳解說員的描述。
Returns:
Type Description Boolean 是否新增成功。 -
createGroupUI()
webgl/ov-BestCommentatorCollection.js, line 300 -
顯示建立最佳解說員群組的對話框
-
deleteGroup(name){Boolean}
webgl/ov-BestCommentatorCollection.js, line 328 -
刪除指定名稱的最佳解說員群組
Name Type Description name
String 最佳解說員的名稱。
Returns:
Type Description Boolean 是否刪除成功。 -
exportBestCommentatorFile(fileName, indentation)
webgl/ov-BestCommentatorCollection.js, line 158 -
匯出並下載最佳解說員(JSON)
Name Type Description fileName
String 匯出的檔案名稱,若留空將會以UI詢問。
indentation
Boolean 匯出的JSON字串是否要縮排。
-
exportBestCommentatorJSON(indentation){String}
webgl/ov-BestCommentatorCollection.js, line 129 -
以JSON匯出最佳解說員
Name Type Description indentation
Boolean 匯出的JSON字串是否要縮排。
Returns:
Type Description String 匯出的JSON。 -
exportBestCommentatorKML(){String}
webgl/ov-BestCommentatorCollection.js, line 207 -
以KML匯出最佳解說員
Returns:
Type Description String 匯出的KML。 -
exportBestCommentatorKMLFile(fileName)
webgl/ov-BestCommentatorCollection.js, line 231 -
匯出並下載最佳解說員(KML)
Name Type Description fileName
String 匯出的檔案名稱,若留空將會以UI詢問。
-
getGroup(name){ov.BestCommentatorGroup}
webgl/ov-BestCommentatorCollection.js, line 345 -
取得指定名稱的最佳解說員群組
Name Type Description name
String 最佳解說員的名稱。
Returns:
Type Description ov.BestCommentatorGroup 最佳解說員群組。 -
importBestCommentatorFile(file, callback)
webgl/ov-BestCommentatorCollection.js, line 142 -
匯入最佳解說員檔案物件
Name Type Description file
File 匯入的檔案物件。
callback
function optional import完成後的回呼。
-
importBestCommentatorJSON(json)
webgl/ov-BestCommentatorCollection.js, line 110 -
以JSON匯入最佳解說員
Name Type Description json
String 要匯入的JSON字串。
-
importBestCommentatorKML(xml)
webgl/ov-BestCommentatorCollection.js, line 196 -
以KML匯入最佳解說員
Name Type Description xml
String 要匯入的KML字串。
-
importBestCommentatorKMLFile(file, callback)
webgl/ov-BestCommentatorCollection.js, line 216 -
匯入最佳解說員KML檔案物件
Name Type Description file
File 匯入的KML檔案物件。
callback
function optional import完成後的回呼。
-
playGroup(name, event)
webgl/ov-BestCommentatorCollection.js, line 95 -
撥放指定名稱的群組
Name Type Description name
String 指定的群組名稱。
event
Object 指定接下來這個最佳解說員的撥放事件,有以下三種可選的事件:
OnStart: 當一個群組開始撥放時
OnStop: 當一個群組撥放被中斷時
OnFinish: 當一個群組撥放完畢時 -
resetShellObject()
webgl/ov-BestCommentatorCollection.js, line 264 -
依照核心引擎的狀態將殼層物件重設
-
stop()
webgl/ov-BestCommentatorCollection.js, line 102 -
撥放中止