Global

_createElement(node) → {UIElement}

创建预设元素的实例(私有)

Source:

ui.js, line 175

Parameters:

Name	Type	Description
`node`	`Object`	预设元素数据

Returns:

Type:: UIElement

_updateBubbleState(target)

更新事件冒泡状态(私有) 如果选中了UI元素阻止事件传递到场景中

Source:

ui.js, line 328

Parameters:

Name	Type	Description
`target`	`UIElement`

(async) activate(pointer)

激活场景上下文

Source:

scene.js, line 204

Parameters:

Name	Type	Description
`pointer`	`number`	场景指针(0或1)

activate(element)

准备激活第一次添加到管理器中的元素

Source:

ui.js, line 6201

Parameters:

Name	Type	Description
`element`	`UIElement`	元素实例

add(object)

添加对象到映射表中

Source:

scene.js, line 6283

Parameters:

Name	Type	Description
`object`	`Object`	实体对象

add(presetId) → {UIElement}

创建预设元素的实例，并添加到跟元素

Source:

ui.js, line 195

Parameters:

Name	Type	Description
`presetId`	`string`	预设元素ID

Returns:

Type:: UIElement

addMember(actor)

添加玩家队伍成员

Source:

actor.js, line 75

Parameters:

Name	Type	Description
`actor`	`GlobalActor`	队伍成员

addPointerEventRoot(element)

添加指针事件根元素

Source:

ui.js, line 248

Parameters:

Name	Type	Description
`element`	`UIElement`	根元素

append(event)

添加已激活事件处理器

Source:

event.js, line 211

Parameters:

Name	Type	Description
`event`	`EventHandler`	事件处理器

append(element)

添加元素到管理器中

Source:

ui.js, line 6170

Parameters:

Name	Type	Description
`element`	`UIElement`	元素实例

autorun()

调用自动执行事件

Source:

ui.js, line 6206

bind(scene)

绑定场景上下文

Source:

scene.js, line 285

Parameters:

Name	Type	Description
`scene`	`SceneContext` \| `null`	场景上下文对象

blur(event)

失去焦点事件

Source:

controller.js, line 252

Parameters:

Name	Type	Description
`event`	`FocusEvent`	焦点事件

buildPath(startX, startY, destX, destY, endIndex) → {Float64Array}

使用寻路后的数据建立路径

Source:

scene.js, line 648

Parameters:

Name	Type	Description
`startX`	`number`	起点位置X
`startY`	`number`	起点位置Y
`destX`	`number`	终点位置X
`destY`	`number`	终点位置Y
`endIndex`	`number`	终点顶点索引

Returns:

Type:: Float64Array

角色移动路径

calculateCoords(event)

计算坐标

Source:

controller.js, line 461

Parameters:

Name	Type	Description
`event`	`PointerEvent`

calculateSceneCoords()

计算场景坐标

Source:

controller.js, line 479

call(id) → {EventHandler|undefined}

调用全局事件

Source:

event.js, line 174

Parameters:

Name	Type	Description
`id`	`string`	全局事件文件ID

Returns:

Type:: EventHandler | undefined

callAutorunEvents()

调用自动执行事件

Source:

event.js, line 163

callSpecialEvent()

调用特殊事件

Source:

event.js, line 155

changeRelation(teamId1, teamId2, relation)

改变角色队伍的关系

Source:

actor.js, line 273

Parameters:

Name	Type	Description
`teamId1`	`string`	队伍ID1
`teamId2`	`string`	队伍ID2
`relation`	`number`	队伍1和队伍2的关系(0:敌对, 1:友好)

checkIfRemovedHover()

检查是否移除了hover元素

Source:

ui.js, line 336

clearGlobalActors()

清除所有全局角色

Source:

actor.js, line 364

compileEvents(data, eventPath) → {Object}

编译对象中的事件

Source:

data.js, line 465

Parameters:

Name	Type	Description
`data`	`Object`	对象数据
`eventPath`	`string`	事件路径

Returns:

Type:: Object

事件集合

continue()

继续场景活动

Source:

scene.js, line 186

convertToScreenCoords(scenePos) → {Object}

将场景坐标转换为屏幕坐标

Source:

camera.js, line 351

Parameters:

Name	Type	Description
`scenePos`	`Object`	拥有场景坐标的对象

Returns:

Type:: Object

create(actorId, savedDataopt) → {GlobalActor|null}

创建全局角色

Source:

actor.js, line 385

Parameters:

Name	Type	Attributes	Description
`actorId`	`string`		角色文件ID
`savedData`	`Object`	<optional>	角色存档数据

Returns:

Type:: GlobalActor | null

createAutotileMap()

创建自动图块模板数据映射表

Source:

data.js, line 436

createEasingMap()

创建过渡映射表

Source:

data.js, line 445

createElement(presetId) → {UIElement}

创建预设元素的实例

Source:

ui.js, line 159

Parameters:

Name	Type	Description
`presetId`	`string`	预设元素ID

Returns:

Type:: UIElement

createFollower() → {Object}

创建目标角色跟随器(返回更新器)

Source:

camera.js, line 330

Returns:

Type:: Object

createMembers()

创建玩家队伍成员

Source:

actor.js, line 50

createPath(startX, startY, destX, destY, passage, bypass) → {Float64Array}

创建路径(Lazy Theta*寻路算法)

Source:

scene.js, line 547

Parameters:

Name	Type	Description
`startX`	`number`	起点位置X
`startY`	`number`	起点位置Y
`destX`	`number`	终点位置X
`destY`	`number`	终点位置Y
`passage`	`number`	角色通行区域
`bypass`	`boolean`	是否绕过角色

Returns:

Type:: Float64Array

角色移动路径

createPlayer()

创建玩家角色

Source:

actor.js, line 40

createUnitPath(destX, destY) → {Float64Array}

创建单位移动路径

Source:

scene.js, line 631

Parameters:

Name	Type	Description
`destX`	`number`	终点位置X
`destY`	`number`	终点位置Y

Returns:

Type:: Float64Array

角色移动路径

decodeClone(array, index) → {Object}

解码克隆数据

Source:

codec.js, line 325

Parameters:

Name	Type	Description
`array`	`Uint8Array`	字节码列表
`index`	`number`	字节码索引

Returns:

Type:: Object

{结束位置, 克隆数量}

decodeTeamData(code, length) → {Uint8Array}

解码队伍数据

Source:

codec.js, line 278

Parameters:

Name	Type	Description
`code`	`string`	队伍数据编码
`length`	`number`	队伍数量

Returns:

Type:: Uint8Array

队伍数据

decodeTerrains(scene, code, width, height) → {SceneTerrainArray}

解码地形

Source:

codec.js, line 193

Parameters:

Name	Type	Description
`scene`	`SceneContext`	场景上下文对象
`code`	`string`	地形数据编码
`width`	`number`	场景宽度
`height`	`number`	场景高度

Returns:

Type:: SceneTerrainArray

场景地形数据列表

decodeTiles(code, width, height) → {Uint32Array}

解码图块

Source:

codec.js, line 72

Parameters:

Name	Type	Description
`code`	`string`	图块数据编码
`width`	`number`	瓦片地图宽度
`height`	`number`	瓦片地图高度

Returns:

Type:: Uint32Array

图块数据列表

delete(actorId)

删除全局角色

Source:

actor.js, line 401

Parameters:

Name	Type	Description
`actorId`	`string`	角色文件ID

(async) delete()

删除当前场景

Source:

scene.js, line 237

deleteGameData(number) → {Promise.<undefined>}

删除游戏数据存档文件

Source:

data.js, line 651

Parameters:

Name	Type	Description
`number`	`string`	存档编号

Returns:

Type:: Promise.<undefined>

disable(id)

禁用全局事件(立即)

Source:

event.js, line 263

Parameters:

Name	Type	Description
`id`	`string`	全局事件文件ID

displayErrorMessage(event)

显示错误消息事件

Source:

util.js, line 475

Parameters:

Name	Type	Description
`event`	`ErrorEvent`	错误事件

doubleclick(event)

鼠标双击事件

Source:

controller.js, line 391

Parameters:

Name	Type	Description
`event`	`PointerEvent`	指针事件

doubleclick()

鼠标双击事件

Source:

ui.js, line 814

emit(type, …params)

发送输入事件

Source:

controller.js, line 159

Parameters:

Name	Type	Attributes	Description
`type`	`string`		输入事件类型
`params`	`Array`	<repeatable>	传递参数

emit(type, priority, optionsopt)

发送全局事件

Source:

event.js, line 189

Parameters:

Name	Type	Attributes	Default	Description
`type`	`string`			全局事件类型
`priority`	`boolean`		null	是不是优先事件
`options`	`Object`	<optional>		传递事件上下文属性

emit(type)

发送游戏事件

Source:

main.js, line 157

Parameters:

Name	Type	Description
`type`	`string`	游戏事件类型

emit(type, parameter)

发送场景事件

Source:

scene.js, line 363

Parameters:

Name	Type	Description
`type`	`string`	场景事件类型
`parameter`	`any`	场景事件传递参数

emitInputEvent(type, parameter)

发送场景输入事件

Source:

scene.js, line 374

Parameters:

Name	Type	Description
`type`	`string`	场景事件类型
`parameter`	`any`	场景事件传递参数

enable(id)

启用全局事件(延迟)

Source:

event.js, line 243

Parameters:

Name	Type	Description
`id`	`string`	全局事件文件ID

encodeTeamData(data) → {string}

编码队伍数据

Source:

codec.js, line 250

Parameters:

Name	Type	Description
`data`	`Uint8Array`	队伍数据列表

Returns:

Type:: string

队伍数据编码

encodeTerrains(terrains) → {string}

编码地形

Source:

codec.js, line 134

Parameters:

Name	Type	Description
`terrains`	`Uint8Array`	地形数组

Returns:

Type:: string

executeCallbacks()

执行时间缩放过渡结束回调

Source:

time.js, line 162

find(elements, x, y) → {UIElement|undefined}

查找目标元素(通过屏幕坐标)

Source:

ui.js, line 282

Parameters:

Name	Type	Description
`elements`	`Array.<UIElement>`	元素列表
`x`	`number`	屏幕X
`y`	`number`	屏幕Y

Returns:

Type:: UIElement | undefined

follow(target, easingIdopt, durationopt)

摄像机跟随目标角色

Source:

camera.js, line 128

Parameters:

Name	Type	Attributes	Description
`target`	`Actor`		目标角色
`easingId`	`string`	<optional>	过渡曲线ID
`duration`	`number`	<optional>	持续时间(毫秒)

gamepadbuttonpress()

手柄按钮按下事件

Source:

ui.js, line 830

gamepadbuttonrelease()

手柄按钮弹起事件

Source:

ui.js, line 868

gamepadleftstickchange()

手柄左摇杆改变事件

Source:

ui.js, line 894

gamepadrightstickchange()

手柄右摇杆改变事件

Source:

ui.js, line 925

generate32bit() → {string}

生成32位GUID(8个字符)

Source:

file.js, line 283

Returns:

Type:: string

generate64bit() → {string}

生成64位GUID(16个字符)

Source:

file.js, line 293

Returns:

Type:: string

get(teamId) → {Object}

通过ID获取队伍

Source:

actor.js, line 233

Parameters:

Name	Type	Description
`teamId`	`string`	队伍ID

Returns:

Type:: Object

队伍

get(actorId) → {GlobalActor|undefined}

获取全局角色

Source:

actor.js, line 425

Parameters:

Name	Type	Description
`actorId`	`string`	角色文件ID

Returns:

Type:: GlobalActor | undefined

get() → {boolean}

获取事件冒泡状态

Source:

controller.js, line 16

Returns:

Type:: boolean

false=停止传递事件

get(id) → {Array.<function()>}

获取指定ID的事件指令

Source:

event.js, line 142

Parameters:

Name	Type	Description
`id`	`string`	事件ID

Returns:

Type:: Array.<function()>

get(descriptor) → {Promise.<(Object|Image|null)>}

获取文件

Source:

file.js, line 52

Parameters:

Name	Type	Description
`descriptor`	`Object`	文件描述器

Returns:

Type:: Promise.<(Object|Image|null)>

get() → {SceneContext|null}

获取当前场景上下文

Source:

scene.js, line 268

Returns:

Type:: SceneContext | null

get(entityId) → {Object|undefined}

从映射表中获取对象

Source:

scene.js, line 6275

Parameters:

Name	Type	Description
`entityId`	`string`	实体对象ID

Returns:

Type:: Object | undefined

返回实体对象

get(key) → {EasingMap}

获取过渡曲线映射表

Source:

time.js, line 295

Parameters:

Name	Type	Description
`key`	`string`	过渡曲线ID或键

Returns:

Type:: EasingMap

get(presetId) → {UIElement|undefined}

获取已经创建的元素实例(通过ID)

Source:

ui.js, line 231

Parameters:

Name	Type	Description
`presetId`	`string`	预设元素ID

Returns:

Type:: UIElement | undefined

get(key) → {any}

获取变量值

Source:

variable.js, line 19

Parameters:

Name	Type	Description
`key`	`string`	变量ID

Returns:

Type:: any

get(key) → {any}

获取变量值

Source:

variable.js, line 109

Parameters:

Name	Type	Description
`key`	`string`	变量ID

Returns:

Type:: any

get(attrId) → {Object|undefined}

获取属性

Source:

variable.js, line 194

Parameters:

Name	Type	Description
`attrId`	`string`	属性ID

Returns:

Type:: Object | undefined

get(stringId) → {Object|undefined}

获取字符串对象

Source:

variable.js, line 530

Parameters:

Name	Type	Description
`stringId`	`string`	字符串ID

Returns:

Type:: Object | undefined

getElementAtMouse() → {UIElement}

获取鼠标位置的元素

Source:

ui.js, line 313

Returns:

Type:: UIElement

getGroup(groupId) → {Object|undefined}

获取属性群组

Source:

variable.js, line 221

Parameters:

Name	Type	Description
`groupId`	`string`	群组ID

Returns:

Type:: Object | undefined

getGroup(groupId) → {Object|undefined}

获取枚举字符串群组

Source:

variable.js, line 557

Parameters:

Name	Type	Description
`groupId`	`string`	群组ID

Returns:

Type:: Object | undefined

getItem(key) → {Promise.<any>}

获取数据内容

Source:

data.js, line 841

Parameters:

Name	Type	Description
`key`	`string`	键(存档文件名)

Returns:

Type:: Promise.<any>

读取的数据

getKey(attrId) → {string}

获取属性键

Source:

variable.js, line 212

Parameters:

Name	Type	Description
`attrId`	`string`	属性ID

Returns:

Type:: string

getKeys() → {Promise.<Array.<string>>}

获取所有数据键(游戏存档文件名)

Source:

data.js, line 825

Returns:

Type:: Promise.<Array.<string>>

键列表

getName(attrId) → {string}

获取属性名称(未使用)

Source:

variable.js, line 203

Parameters:

Name	Type	Description
`attrId`	`string`	属性ID

Returns:

Type:: string

getName(stringId) → {string}

获取字符串名称(未使用)

Source:

variable.js, line 539

Parameters:

Name	Type	Description
`stringId`	`string`	字符串ID

Returns:

Type:: string

getParallaxAnchor(parallax) → {Object}

获取视差图锚点

Source:

scene.js, line 431

Parameters:

Name	Type	Description
`parallax`	`SceneParallax` \| `SceneTilemap`	视差图或瓦片地图对象

Returns:

Type:: Object

getPathByGUID(guid) → {string}

获取文件路径(通过GUID)

Source:

file.js, line 185

Parameters:

Name	Type	Description
`guid`	`string`	文件GUID

Returns:

Type:: string

文件路径或空字符串

getPointerEventRoot() → {UIElement}

获取指针事件根元素

Source:

ui.js, line 239

Returns:

Type:: UIElement

getRelationByIndexes(teamIndex1, teamIndex2) → {number}

通过队伍索引获取队伍关系

Source:

actor.js, line 243

Parameters:

Name	Type	Description
`teamIndex1`	`number`	队伍索引1
`teamIndex2`	`number`	队伍索引2

Returns:

Type:: number

队伍关系(0:敌对, 1:友好)

getValue(stringId) → {string}

获取字符串值

Source:

variable.js, line 548

Parameters:

Name	Type	Description
`stringId`	`string`	字符串ID

Returns:

Type:: string

initialize()

初始化队伍管理器

Source:

actor.js, line 23

initialize()

初始化

Source:

actor.js, line 168

initialize()

初始化音频管理器

Source:

audio.js, line 35

initialize()

初始化摄像机

Source:

camera.js, line 69

initialize()

初始化输入控制器

Source:

controller.js, line 98

initialize()

初始化鼠标管理器

Source:

controller.js, line 306

initialize() → {Promise}

初始化数据管理器

Source:

data.js, line 39

Returns:

Type:: Promise

initialize()

初始化全局事件管理器

Source:

event.js, line 81

initialize()

初始化插件管理器

Source:

event.js, line 296

(async) initialize()

初始化游戏

Source:

main.js, line 20

initialize()

初始化场景管理器

Source:

scene.js, line 122

(async) initialize()

初始化舞台

Source:

stage.js, line 12

initialize()

初始化游戏时间管理器

Source:

time.js, line 46

initialize()

初始化

Source:

time.js, line 286

initialize()

初始化界面管理器

Source:

ui.js, line 62

initialize()

初始化错误报告器

Source:

util.js, line 463

initialize()

初始化全局变量

Source:

variable.js, line 61

initialize()

初始化属性管理器

Source:

variable.js, line 184

initialize()

初始化枚举管理器

Source:

variable.js, line 520

isEnemy(teamId1, teamId2) → {boolean}

判断敌对关系

Source:

actor.js, line 253

Parameters:

Name	Type	Description
`teamId1`	`string`	队伍ID1
`teamId2`	`string`	队伍ID2

Returns:

Type:: boolean

是否为敌对关系

isFriendly(teamId1, teamId2) → {boolean}

判断友好关系

Source:

actor.js, line 263

Parameters:

Name	Type	Description
`teamId1`	`string`	队伍ID1
`teamId2`	`string`	队伍ID2

Returns:

Type:: boolean

是否为友好关系

isMacOS() → {boolean}

判断是不是Mac平台

Source:

util.js, line 24

Returns:

Type:: boolean

keydown(event)

键盘按下事件

Source:

controller.js, line 198

Parameters:

Name	Type	Description
`event`	`KeyboardEvent`	键盘事件

keydown()

键盘按下事件

Source:

ui.js, line 661

keydownFilter(event)

按键过滤器

Source:

controller.js, line 176

Parameters:

Name	Type	Description
`event`	`KeyboardEvent`	键盘事件

keyup(event)

键盘弹起事件

Source:

controller.js, line 236

Parameters:

Name	Type	Description
`event`	`KeyboardEvent`	键盘事件

keyup()

键盘弹起事件

Source:

ui.js, line 701

(async) load(id) → {Promise.<SceneContext>}

加载场景

Source:

scene.js, line 219

Parameters:

Name	Type	Description
`id`	`string`	场景文件ID

Returns:

Type:: Promise.<SceneContext>

loadData(party)

加载队伍角色数据

Source:

actor.js, line 129

Parameters:

Name	Type	Description
`party`	`Object`

loadData(team)

加载队伍关系数据

Source:

actor.js, line 314

Parameters:

Name	Type	Description
`team`	`Object`

loadData(actors)

加载全局角色列表数据

Source:

actor.js, line 444

Parameters:

Name	Type	Description
`actors`	`Object`

(async) loadData(camera)

加载摄像机数据

Source:

camera.js, line 311

Parameters:

Name	Type	Description
`camera`	`Object`

loadData(data)

加载场景数据

Source:

scene.js, line 463

Parameters:

Name	Type	Description
`data`	`Object`

loadData(variables)

加载独立变量数据(无法删除旧存档中的无效数据)

Source:

variable.js, line 46

Parameters:

Name	Type	Description
`variables`	`Object`	保存的独立变量数据

loadData(groupIndex, variables)

加载全局变量数据

Source:

variable.js, line 157

Parameters:

Name	Type	Description
`groupIndex`	`number`	变量分组索引(0:常规, 1:共享)
`variables`	`Object`	保存的全局变量数据

loadFile(filename) → {Promise.<object>}

加载数据文件

Source:

data.js, line 383

Parameters:

Name	Type	Description
`filename`	`string`	/data目录下的文件名

Returns:

Type:: Promise.<object>

(async) loadGameData(number) → {Promise.<undefined>}

从文件中加载游戏数据

Source:

data.js, line 540

Parameters:

Name	Type	Description
`number`	`string`	存档编号

Returns:

Type:: Promise.<undefined>

(async) loadGlobalData() → {Promise.<undefined>}

从文件中加载全局数据

Source:

data.js, line 720

Returns:

Type:: Promise.<undefined>

loadMeta() → {Promise}

加载文件的元数据清单

Source:

data.js, line 69

Returns:

Type:: Promise

(async) loadObjects()

加载各种对象数据文件

Source:

data.js, line 115

loadPresets()

加载预设元素

Source:

ui.js, line 118

(async) loadSaveMeta() → {Promise.<Array.<Object>>}

加载存档元数据列表

Source:

data.js, line 583

Returns:

Type:: Promise.<Array.<Object>>

loadScene(id) → {Promise.<Object>}

加载场景数据

Source:

data.js, line 398

Parameters:

Name	Type	Description
`id`	`string`	场景文件ID

Returns:

Type:: Promise.<Object>

(async) loadScripts()

加载脚本文件(动态导入模块)

Source:

data.js, line 334

loadUI(uiId) → {Array.<UIElement>}

加载界面中的所有元素

Source:

ui.js, line 139

Parameters:

Name	Type	Description
`uiId`	`string`	界面文件ID

Returns:

Type:: Array.<UIElement>

mousedown()

鼠标按下事件

Source:

ui.js, line 727

mousedownLB()

鼠标左键按下事件

Source:

ui.js, line 740

mousedownRB()

鼠标右键按下事件

Source:

ui.js, line 747

mouseleave()

鼠标离开事件

Source:

ui.js, line 806

mousemove()

鼠标移动事件

Source:

ui.js, line 781

mouseup()

鼠标弹起事件

Source:

ui.js, line 754

mouseupLB()

鼠标左键弹起事件

Source:

ui.js, line 761

mouseupRB()

鼠标右键弹起事件

Source:

ui.js, line 774

moveTo(x, y, easingIdopt, durationopt)

移动摄像机到指定位置

Source:

camera.js, line 94

Parameters:

Name	Type	Attributes	Description
`x`	`number`		场景X
`y`	`number`		场景Y
`easingId`	`string`	<optional>	过渡曲线ID
`duration`	`number`	<optional>	持续时间(毫秒)

off(type, listener)

移除输入事件侦听器

Source:

controller.js, line 142

Parameters:

Name	Type	Description
`type`	`string`	输入事件类型
`listener`	`function`	回调函数

off(type, listener)

移除场景事件侦听器(未使用)

Source:

scene.js, line 346

Parameters:

Name	Type	Description
`type`	`string`	场景事件类型
`listener`	`function`	回调函数

off(type, listener)

移除界面事件侦听器(未使用)

Source:

ui.js, line 641

Parameters:

Name	Type	Description
`type`	`string`	界面事件类型
`listener`	`function`	回调函数

on(type, listener, priorityopt)

添加输入事件侦听器

Source:

controller.js, line 126

Parameters:

Name	Type	Attributes	Default	Description
`type`	`string`			输入事件类型
`listener`	`function`			回调函数
`priority`	`boolean`	<optional>	false	是否将该事件设为最高优先级

on(type, listener)

添加游戏事件侦听器

Source:

main.js, line 149

Parameters:

Name	Type	Description
`type`	`string`	游戏事件类型
`listener`	`function`	回调函数

on(type, listener, priorityopt)

添加场景事件侦听器

Source:

scene.js, line 330

Parameters:

Name	Type	Attributes	Default	Description
`type`	`string`			场景事件类型
`listener`	`function`			回调函数
`priority`	`boolean`	<optional>	false	是否将该事件设为最高优先级

on(type, listener, priorityopt)

添加界面事件侦听器

Source:

ui.js, line 625

Parameters:

Name	Type	Attributes	Default	Description
`type`	`string`			界面事件类型
`listener`	`function`			回调函数
`priority`	`boolean`	<optional>	false	是否将该事件设为最高优先级

onTransitionEnd(callback)

设置时间缩放过渡结束回调

Source:

time.js, line 153

Parameters:

Name	Type	Description
`callback`	`function`	回调函数

(async) open() → {Promise.<IDBObjectStore>}

打开数据库

Source:

data.js, line 800

Returns:

Type:: Promise.<IDBObjectStore>

parseCSSColor(hex) → {string}

解析十六进制字符串返回CSS颜色

Source:

util.js, line 260

Parameters:

Name	Type	Description
`hex`	`string`	十六进制颜色

Returns:

Type:: string

parseDateTimestamp(timestamp, format) → {string}

解析日期时间戳

Source:

time.js, line 135

Parameters:

Name	Type	Description
`timestamp`	`number`	时间戳
`format`	`string`	日期格式

Returns:

Type:: string

parseFloatArray(hex) → {Float64Array}

解析十六进制字符串返回浮点型数组颜色

Source:

util.js, line 300

Parameters:

Name	Type	Description
`hex`	`string`	十六进制颜色

Returns:

Type:: Float64Array

parseFloatArrayTag(hex) → {Float64Array}

解析颜色标签字符串返回浮点型数组颜色

Source:

util.js, line 314

Parameters:

Name	Type	Description
`hex`	`string`	十六进制颜色

Returns:

Type:: Float64Array

parseGUID(meta) → {string}

从元数据中解析文件GUID

Source:

data.js, line 430

Parameters:

Name	Type	Description
`meta`	`Object`	文件的元数据

Returns:

Type:: string

文件GUID

parseInt(hex) → {number}

解析十六进制字符串返回整数颜色(32位整数)

Source:

util.js, line 273

Parameters:

Name	Type	Description
`hex`	`string`	十六进制颜色

Returns:

Type:: number

parseIntArray(hex) → {Uint8Array}

解析十六进制字符串返回整型数组颜色

Source:

util.js, line 286

Parameters:

Name	Type	Description
`hex`	`string`	十六进制颜色

Returns:

Type:: Uint8Array

pause()

暂停场景活动

Source:

scene.js, line 181

pointerdown(event)

指针按下事件

Source:

controller.js, line 330

Parameters:

Name	Type	Description
`event`	`PointerEvent`	指针事件

pointerenter(event)

指针进入事件

Source:

controller.js, line 374

Parameters:

Name	Type	Description
`event`	`PointerEvent`	指针事件

pointerleave(event)

指针离开事件

Source:

controller.js, line 382

Parameters:

Name	Type	Description
`event`	`PointerEvent`	指针事件

pointermove(event)

指针移动事件

Source:

controller.js, line 365

Parameters:

Name	Type	Description
`event`	`PointerEvent`	指针事件

pointerup(event)

指针弹起事件

Source:

controller.js, line 346

Parameters:

Name	Type	Description
`event`	`PointerEvent`	指针事件

pop()

弹出事件冒泡状态

Source:

controller.js, line 34

(async) precompile()

预编译对象数据

Source:

data.js, line 217

precompileActors()

预编译角色数据

Source:

data.js, line 232

precompileAnimations()

预编译动画数据

Source:

data.js, line 282

precompileEquipments()

预编译装备数据

Source:

data.js, line 268

precompileItems()

预编译物品数据

Source:

data.js, line 256

precompileSkills()

预编译技能数据

Source:

data.js, line 241

precompileStates()

预编译状态数据

Source:

data.js, line 275

precompileTriggers()

预编译触发器数据

Source:

data.js, line 248

preventInput()

阻止场景输入

Source:

scene.js, line 191

push(bubble)

推入事件冒泡状态

Source:

controller.js, line 29

Parameters:

Name	Type	Description
`bubble`	`boolean`	冒泡状态

push(fn)

推送回调函数，稍后执行

Source:

event.js, line 17

Parameters:

Name	Type	Description
`fn`	`function`	回调函数

remapScripts()

重新映射脚本路径(TS->JS)

Source:

data.js, line 364

remove(object)

从映射表中移除对象

Source:

scene.js, line 6298

Parameters:

Name	Type	Description
`object`	`Object`	实体对象

remove(element)

从管理器中移除元素

Source:

ui.js, line 6188

Parameters:

Name	Type	Description
`element`	`UIElement`	元素实例

removeItem(key) → {Promise.<undefined>}

移除数据内容

Source:

data.js, line 874

Parameters:

Name	Type	Description
`key`	`string`	键(存档文件名)

Returns:

Type:: Promise.<undefined>

removeLatestPointerEventRoot()

移除最新的焦点

Source:

ui.js, line 265

removeMember(actor)

移除玩家队伍成员

Source:

actor.js, line 93

Parameters:

Name	Type	Description
`actor`	`GlobalActor`	队伍成员

removePointerEventRoot(element)

移除指针事件根元素

Source:

ui.js, line 258

Parameters:

Name	Type	Description
`element`	`UIElement`	根元素

render()

开始渲染离屏画面

Source:

filter.js, line 7

render()

结束渲染离屏画面

Source:

filter.js, line 20

render()

渲染场景色调

Source:

filter.js, line 89

render()

渲染场景

Source:

scene.js, line 259

render()

渲染元素

Source:

ui.js, line 208

renderLoadingProgress()

渲染同步加载进度

Source:

file.js, line 230

reset()

重置队伍角色

Source:

actor.js, line 30

reset()

重置全局角色

Source:

actor.js, line 359

reset()

重置所有音频播放器

Source:

audio.js, line 110

reset()

重置摄像机

Source:

camera.js, line 77

reset()

重置回调堆栈

Source:

event.js, line 31

reset()

重置全局事件的开关状态

Source:

event.js, line 147

reset()

重置色调

Source:

filter.js, line 76

reset()

重置游戏

Source:

main.js, line 120

reset()

重置所有场景

Source:

scene.js, line 164

reset()

重置游戏时间管理器

Source:

time.js, line 51

reset()

重置界面，销毁所有元素

Source:

ui.js, line 213

reset()

重置变量值

Source:

variable.js, line 10

reset()

重置变量值

Source:

variable.js, line 95

resetPointerEventRoots()

重置指针事件根元素

Source:

ui.js, line 271

resize()

重新调整位置

Source:

controller.js, line 431

resize()

重新调整大小事件

Source:

stage.js, line 115

resize()

重新调整大小事件

Source:

ui.js, line 654

restoreInput()

恢复场景输入

Source:

scene.js, line 196

rotateAndScaleCanvas(resolution)

旋转并缩放画布

Source:

stage.js, line 88

Parameters:

Name	Type	Description
`resolution`	`Object`	分辨率数据对象

route()

获取文件路径(客户端专用)

Source:

file.js, line 168

saveData()

保存队伍角色数据

Source:

actor.js, line 118

saveData()

保存队伍关系数据

Source:

actor.js, line 285

saveData()

保存全局角色列表数据

Source:

actor.js, line 430

saveData()

保存摄像机数据

Source:

camera.js, line 298

saveData()

保存场景数据

Source:

scene.js, line 448

saveData()

保存独立变量数据

Source:

variable.js, line 38

saveData(groupIndex) → {Object}

保存全局变量数据

Source:

variable.js, line 141

Parameters:

Name	Type	Description
`groupIndex`	`number`	变量分组索引(0:常规, 1:共享)

Returns:

Type:: Object

saveGameData(number, meta) → {Promise.<undefined>}

保存游戏数据到文件

Source:

data.js, line 490

Parameters:

Name	Type	Description
`number`	`string`	存档编号
`meta`	`Object`	存档元数据(时间、地点、截图等附加数据)

Returns:

Type:: Promise.<undefined>

saveGlobalData() → {Promise.<undefined>}

保存全局数据到文件

Source:

data.js, line 683

Returns:

Type:: Promise.<undefined>

scaleCanvas(resolution)

缩放画布

Source:

stage.js, line 59

Parameters:

Name	Type	Description
`resolution`	`Object`	分辨率数据对象

set(tint, easingId, duration)

设置场景色调: 红[-255, 255] 绿[-255, 255] 蓝[-255, 255] 灰[0, 255]

Source:

filter.js, line 104

Parameters:

Name	Type	Description
`tint`	`Array.<number>`	色调数组
`easingId`	`string`	过渡曲线ID
`duration`	`number`	持续时间(毫秒)

set(scene) → {SceneContext|null}

设置当前场景上下文

Source:

scene.js, line 277

Parameters:

Name	Type	Description
`scene`	`SceneContext` \| `null`	场景上下文对象

Returns:

Type:: SceneContext | null

set(key, value)

设置变量值

Source:

variable.js, line 28

Parameters:

Name	Type	Description
`key`	`string`	变量ID
`value`	`any`	变量值

set(key, value)

设置变量值

Source:

variable.js, line 118

Parameters:

Name	Type	Description
`key`	`string`	变量ID
`value`	`any`	变量值

setBypass(bypass)

设置绕开角色开关

Source:

scene.js, line 896

Parameters:

Name	Type	Description
`bypass`	`boolean`

setItem(key, value) → {Promise.<undefined>}

设置数据内容

Source:

data.js, line 858

Parameters:

Name	Type	Description
`key`	`string`	键(存档文件名)
`value`	`any`	写入的数据

Returns:

Type:: Promise.<undefined>

setPlayer(actor)

设置玩家角色

Source:

actor.js, line 65

Parameters:

Name	Type	Description
`actor`	`GlobalActor`	玩家角色

setResolution(width, height, sceneScale, uiScale)

设置分辨率

Source:

stage.js, line 46

Parameters:

Name	Type	Description
`width`	`number`	分辨率宽度
`height`	`number`	分辨率高度
`sceneScale`	`number`	场景缩放系数
`uiScale`	`number`	界面缩放系数

setTimeScale(timeScale, easingId, duration)

设置增量时间缩放比例

Source:

time.js, line 111

Parameters:

Name	Type	Description
`timeScale`	`number`	增量时间缩放比例
`easingId`	`string`	过渡曲线ID
`duration`	`number`	持续时间(毫秒)

setToHighestPriority(id)

设置全局事件为最高优先级

Source:

event.js, line 275

Parameters:

Name	Type	Description
`id`	`string`	全局事件文件ID

setZoomFactor(zoom, easingIdopt, durationopt)

设置摄像机缩放系数

Source:

camera.js, line 167

Parameters:

Name	Type	Attributes	Description
`zoom`	`number`		缩放系数[1-8]
`easingId`	`string`	<optional>	过渡曲线ID
`duration`	`number`	<optional>	持续时间(毫秒)

shake(modeopt, poweropt, speedopt, easingIdopt, durationopt)

震动屏幕

Source:

camera.js, line 368

Parameters:

Name	Type	Attributes	Default	Description
`mode`	`string`	<optional>	random	震动模式
`power`	`number`	<optional>	5	强度
`speed`	`number`	<optional>	5	速度
`easingId`	`string`	<optional>		过渡曲线ID
`duration`	`number`	<optional>	1000	持续时间(ms)

shareInventory()

共享玩家角色库存

Source:

actor.js, line 106

simulateButton(button)

模拟鼠标按键

Source:

controller.js, line 281

Parameters:

Name	Type	Description
`button`	`number`

simulateKey(keycode)

模拟键盘按键

Source:

controller.js, line 271

Parameters:

Name	Type	Description
`keycode`	`string`

start()

开始游戏

Source:

main.js, line 139

stop()

停止事件冒泡

Source:

controller.js, line 21

switchGameInfoDisplay()

开关游戏信息显示面板

Source:

main.js, line 164

testConditions(node) → {boolean}

测试场景对象初始化条件

Source:

scene.js, line 388

Parameters:

Name	Type	Description
`node`	`Object`	场景对象预设数据

Returns:

Type:: boolean

unfollow()

解除摄像机跟随目标

Source:

camera.js, line 157

unpack(items)

解包变量数据

Source:

variable.js, line 81

Parameters:

Name	Type	Description
`items`	`Array.<Object>`	变量数据列表

unpack(items, groupKeys)

解包属性数据

Source:

variable.js, line 230

Parameters:

Name	Type	Description
`items`	`Array.<Object>`	属性数据列表
`groupKeys`	`Array.<string>`	群组ID的栈列表

unpack(items, groupKeys)

解包枚举字符串和群组的数据

Source:

variable.js, line 566

Parameters:

Name	Type	Description
`items`	`Array.<Object>`	枚举字符串列表
`groupKeys`	`Array.<string>`	群组ID的栈列表

unpackTeamData(keys, code) → {Object}

解包角色队伍数据

Source:

actor.js, line 199

Parameters:

Name	Type	Description
`keys`	`Array.<string>`	队伍的ID列表
`code`	`string`	队伍的关系代码

Returns:

Type:: Object

update(deltaTime)

更新摄像机的位置以及相关参数

Source:

camera.js, line 202

Parameters:

Name	Type	Description
`deltaTime`	`number`	增量时间(毫秒)

update()

更新输入状态

Source:

controller.js, line 115

update()

更新鼠标的场景坐标

Source:

controller.js, line 322

update()

执行回调函数

Source:

event.js, line 22

update(deltaTime)

更新管理器中的已激活事件处理器

Source:

event.js, line 225

Parameters:

Name	Type	Description
`deltaTime`	`number`	增量时间(毫秒)

update()

更新场景色调

Source:

filter.js, line 63

update(timestamp)

更新游戏循环

Source:

main.js, line 94

Parameters:

Name	Type	Description
`timestamp`	`number`	增量时间(毫秒)

update(deltaTime)

更新场景

Source:

scene.js, line 251

Parameters:

Name	Type	Description
`deltaTime`	`number`	增量时间(毫秒)

update(timestamp)

更新当前帧的时间相关参数

Source:

time.js, line 62

Parameters:

Name	Type	Description
`timestamp`	`number`	增量时间(毫秒)

update()

更新元素

Source:

ui.js, line 202

update()

更新已连接的元素

Source:

ui.js, line 6215

update()

擦除数据

Source:

util.js, line 451

updateLoadingProgress() → {boolean}

更新同步加载进度

Source:

file.js, line 193

Returns:

Type:: boolean

加载是否完成

wheel(event)

鼠标滚轮事件

Source:

controller.js, line 423

Parameters:

Name	Type	Description
`event`	`WheelEvent`	滚轮事件

wheel()

鼠标滚轮事件

Source:

ui.js, line 822

xhr($) → {Promise}

使用XHR加载文件

Source:

file.js, line 141

Parameters:

Name	Type	Description
`$`	`Object`
`$.path`	`string`	文件路径
`$.sync`	`boolean`	同步开关
`$.type`	`string`	类型

Returns:

Type:: Promise

Name	Type	Attributes	Description
`update`	`function`	<optional>	更新模块
`render`	`function`	<optional>	渲染模块

Members

GL :WebGLRenderingContext

Type:

Methods

_createElement(node) → {UIElement}

Parameters:

Returns:

_updateBubbleState(target)

Parameters:

(async) activate(pointer)

Parameters:

activate(element)

Parameters:

add(object)

Parameters:

add(presetId) → {UIElement}

Parameters:

Returns:

addMember(actor)

Parameters:

addPointerEventRoot(element)

Parameters:

append(event)

Parameters:

append(element)

Parameters:

autorun()

bind(scene)

Parameters:

blur(event)

Parameters:

buildPath(startX, startY, destX, destY, endIndex) → {Float64Array}

Parameters:

Returns:

calculateCoords(event)

Parameters:

calculateSceneCoords()

call(id) → {EventHandler|undefined}

Parameters:

Returns:

callAutorunEvents()

callSpecialEvent()

changeRelation(teamId1, teamId2, relation)

Parameters:

checkIfRemovedHover()

clearGlobalActors()

compileEvents(data, eventPath) → {Object}

Parameters:

Returns:

continue()

convertToScreenCoords(scenePos) → {Object}

Parameters:

Returns:

create(actorId, savedDataopt) → {GlobalActor|null}

Parameters:

Returns:

createAutotileMap()

createEasingMap()

createElement(presetId) → {UIElement}

Parameters:

Returns:

createFollower() → {Object}

Returns:

createMembers()

createPath(startX, startY, destX, destY, passage, bypass) → {Float64Array}

Parameters:

Returns:

createPlayer()

createUnitPath(destX, destY) → {Float64Array}

Parameters:

Returns:

decodeClone(array, index) → {Object}

Parameters:

Returns:

decodeTeamData(code, length) → {Uint8Array}

Parameters:

Returns:

decodeTerrains(scene, code, width, height) → {SceneTerrainArray}

Parameters: