SinglePlayerGame 单机游戏类

对于单机游戏追加的初始化、存档取档等功能
-- 全局信息在游戏启动时会自动读取：如二周目变量、存档数信息、自定义全局数据等

维护人员：黑暗之神KDS
创建时间：2020-02-02

继承 无
子类 无

Public 属性

Public 方法

详情

EVENT_RECOVER_TRIGGER

EVENT_RECOVER_TRIGGER : string;

静态事件：读档后恢复的事件触发线
可以在SinglePlayerGame.recoveryData调用前监听

EventUtils.addEventListenerFunction(SinglePlayerGame,SinglePlayerGame.EVENT_RECOVER_TRIGGER,(trigger:CommandTrigger)=>{
   // to do
},this);

EVENT_ON_BEFORE_RECOVERY_DATA

EVENT_ON_BEFORE_RECOVERY_DATA : string;

静态事件：调用recoveryData前派发

EventUtils.addEventListenerFunction(SinglePlayerGame,SinglePlayerGame.EVENT_ON_BEFORE_RECOVERY_DATA,()=>{
   // to do
},this);

EVENT_ON_AFTER_RECOVERY_DATA

EVENT_ON_AFTER_RECOVERY_DATA : string;

静态事件：调用recoveryData后派发

EventUtils.addEventListenerFunction(SinglePlayerGame,SinglePlayerGame.EVENT_ON_AFTER_RECOVERY_DATA,()=>{
   // to do
},this);

syncSaveMode

syncSaveMode : boolean;

静态同步储存模式：存档时保证当前帧打包好存档数据，以便保证不会出现异步储存时数据发生了改变导致储存信息不太正确的问题（但也会更耗时）
默认值 = true

saveConfig

saveConfig : any;

静态存档配置 系统根据该存档配置进行储存一些基础的信息
event: boolean; // 事件：存档时记录当前正在执行的事件，在读档时会恢复
audioVolume: booean; // 全局音量：BGM/BGS/SE/TS 音量
bgm: true; // 当前正在播放的BGM
bgs: true; // 当前正在播放的BGS

newGame

newGame(): void :

静态新的游戏：新游戏会进入一个预设好的出生点场景，所有玩家变量和属性等都是初始值
项目层可以通过监听事件来以新游戏的方式进入到场景里，参考ClientScene的EVENT_IN_NEW_SCENE事件
新游戏并不会清空全局数据：如二周目变量、自定义全局数据、存档目录信息等
在调用该函数之前，默认的场景：Game.currentScene=ClientScene.EMPTY

getSaveInfo

getSaveInfo() :

静态获取全档案信息，返回全部存档列表信息

返回

格式：
-- id = 存档的唯一编号，如1,3,61 表示存档了1号、3号、61号文件
-- now = 存档时unix时间戳
-- indexInfo = 自定义信息（比如存放地图名称，方便档案列表中玩家可以快速识别）

getSaveInfoByID

getSaveInfoByID(id : number) :

静态获取档案列表中指定的存档信息

参数

指定的存档信息（目录中的简单信息），null 表示无该存档

返回

格式：
-- indexInfo 自定义信息
-- id = 存档的唯一编号，如1,3,61 表示对应存档1号、3号、61号
-- now = 存档时unix时间戳

saveGlobalData

saveGlobalData(onFin : Callback): void :

静态储存自定义全局信息，全局数据在任何新的游戏、存档都通用的数据（比如用于储存用户的按键设置或多周目数据）
调用此函数也会同时储存二周目变量信息
储存时会额外储存SinglePlayerGame.regSaveCustomGlobalData注册的自定义存档数据

参数

onFin 当储存完毕时 onFin(success:boolean)

deleteGlobalData

deleteGlobalData(onFin? : Callback): void :

静态删除全局自定义数据信息，同时也会删除二周目变量信息

参数

onFin [可选] 默认值=null 删除完毕后回调

saveGame

saveGame(index : number, onFin : Callback, indexInfo? : any): void :

静态存档：支持事件执行中调用存档
储存时会额外储存SinglePlayerGame.regSaveCustomData注册的自定义存档数据
同时会储存全局数据（同调用了SinglePlayerGame.saveGlobalData）
-- 设备储存（PC、移动端等设备以文件形式的储存）
-- cookies 缓存（Web支持LocalStorage的形式储存）
-- 云存档（GC游戏平台自动支持云存档服务）

参数

index 存档位置
onFin 存档完毕时回调 onFin(success:boolean)
indexInfo [可选] 默认值=null 存档目录用的信息，可被JSON化的信息（写入至LIFE-DATA，用于在读档列表中看到一些自定义的信息，可以使用SinglePlayerGame.getSaveInfo来获取）

loadGame

loadGame(index : number, onFin : Callback): void :

静态读档 调用此函数会派发ClientScene.EVENT_IN_NEW_SCENE事件以便项目层实现进入相应的场景

参数

index 读档位置
onFin 读档完毕回调 onFin(success:boolean);

delSaveFile

delSaveFile(index : number, onFin : Callback): void :

静态删除存档

参数

onFin 回调是否删除成功 onFin(success:boolean)

getSceneObjectSwitch

getSceneObjectSwitch(sceneID : number, soIndex : number): number :

静态获取对象开关，一般用于更换场景后安装对象的开关，对象开关并不会随着切换场景而重置，并且也会存入至存档中

参数

sceneID 场景ID
soIndex 对象ID

返回

number

recoveryData

recoveryData(): void :

静态恢复存档数据，一般以读档形式进入场景后恢复数据，包含：
-- 所有对象的属性和行为（进行到一半的行为会接着继续执行）
-- 所有图像系统的图片、立绘、动画的状态，正在执行中的任务也会得到恢复继续中途继续执行
-- 所有正在执行的事件会恢复中途继续执行
-- 所有已打开的界面和层次
-- 恢复之前正在播放的BGM和BGS（背景音乐、场景音效）
-- 恢复之前的场景雾效果、色调、镜头状态（即将调整，由于该功能会放到项目层实现，后期会以自定义储存数据的形式储存读取）

regSaveCustomData

regSaveCustomData(dataName : string, dataFunction : Callback): void :

静态注册与存档绑定的自定义数据
  --尽可能只储存数据而非图片等资源，以免导致存档文件过大，对部分环境造成影响（如steam云存档）

参数

dataName 数据名
dataFunction 数据函数回调，通过此回调获取需要储存的数据

regSaveCustomGlobalData

regSaveCustomGlobalData(globalDataName : string, globalDataFunction : Callback): void :

静态注册与游戏绑定的自定义数据（与存档无关，游戏启动即会自动加载的数据 GC-LifeData）
  --尽可能只储存数据而非图片等资源，以免导致存档文件过大，对部分环境造成影响（如steam云存档）

参数

globalDataName 全局数据名称
globalDataFunction 数据函数回调，通过此回调获取需要储存的数据

getSaveCustomData

getSaveCustomData(dataName : string): any :

静态获取当前存档的自定义数据，读档后才能够获取

参数

dataName 数据名

getSaveCustomGlobalData

getSaveCustomGlobalData(globalDataName : string): any :

静态读取自定义全局数据

参数

全局数据名称