案例展示 开发工具 文档 教程 在线开发
登录 注册

_Archive

文档类。用于生成或处理foa文件。 全部展开

目录隐藏

属性展开

  • + appName : string

    应用程序名称。

    • 示例

       archive.appName = 'app'
  • + appTitle : string

    应用程序的标题。

    • 示例

       archive.appTitle = 'This is an app'
  • + appVersion : string

    应用程序的版本号。

    • 示例

       archive.appVersion = 1
  • + compressMode : uint

    打包格式(默认为CompressZip格式，可选Compress7z格式)。

    • 示例

       archive.compressMode = _Archive.Compress7z
  • + externalPack: string

    用作文件检查的foa文件名。

    • 示例

       archive.externalPack = "temp.foa"
  • + fileFolder : string

    应用程序文件夹的根目录。
  • + ignoreResPath : bool

    是否忽略资源路径。默认值为false，即不忽略资源的路径，需要按照原来的逻辑加载资源。可以设置为true，即忽略资源的路径，加载文件时只需要传入文件名即可。

    • 示例

       archive.ignoreResPath = true
  • + launchFile : string

    应用程序的启动参数。
  • + mainPlugin : string

    应用程序启动的主插件。

    • 示例

       archive.mainPlugin = 'fancy3d.fob'
  • + mipQuality: number

    纹理贴图的品质，有由低到高4个级别, 分别是MipNone，MipLow，MipMedium，MipHigh

    • 示例

       archive.mipQuality = _Archive.MipNone
  • + pluginVersion : string

    插件版本。

    • 示例

       print(archive.pluginVersion)

静态常量展开

  • + Compress7z: uint

    7z格式。
  • + CompressNone: uint

    打包时不压缩文件。
  • + CompressZip: uint

    ZIP格式。
  • + MipHigh: uint

    纹理品质级别：高。
  • + MipLow: uint

    纹理品质级别：低。
  • + MipMedium: uint

    纹理品质级别：中。
  • + MipNone: uint

    纹理品质级别：无。
  • + TypeAnima : uint

    文件类型san, man。
  • + TypeConfig: uint

    全局静态配置表文件，用于指示打包程序将这类文件转为C结构的存储表。
  • + TypeImage : uint

    文件类型TEX。
  • + TypeImageNoMip : uint

    文件类型ICON。
  • + TypeMesh : uint

    文件类型msh, skn。
  • + TypeScene: uint

    文件类型sen。
  • + TypeScript: uint

    lua脚本文件类型，用于指示打包程序将这类文件转换为字节码。
  • + TypeStream: uint

    流媒体文件，打包程序不会对这类文件压缩。

构造方法展开

  • + function _Archive() : _Archive

公共方法展开

  • + function addFile(filename : string, groupname : string, format : uint, logicname : string)

    增加文件。

    • 参数
    • filename : 文件名。
    • groupname : 文件所在的组名(可以为空)。
    • fomat : 文件的格式。
    • logicname : 在组中的文件名(默认为文件名)。

    • 示例

       local archive = _Archive.new()
       archive:addFile(realname, 'scene1', _Archive.TypeMesh, logicname)
  • + function addPack(filename : string, packname : string, logicname : string)

    添加文件到指定包名的文件夹下。

    • 参数
    • filename : 文件名。
    • packname : 文件所在的包名。
    • logicname : 在包中的文件名(默认是文件名)。

    • 示例

       local archive = _Archive.new()
       archive:addPack('cha_f_buff.tag','tag','cha_f_buff.tag')
  • + function addPlugin(res : string)

    添加插件。

    • 参数
    • res : 插件文件名。

    • 示例

       local archive = _Archive.new()
       archive.addPlugin('fancy3d.fob')
  • + function addPreGroup(groupname : string)

    添加分组。打包之后先添加的组在前，后添加的在后。

    • 参数
    • group : 组名。

    • 示例

        local archive = _Archive.new()
        archive:addPreGroup('img')
  • + function compressFile(srcname: string[, desname: string]) : bool

    将源文件压缩为目标文件。

    • 参数
    • srcname: 源文件名。
    • desname : 目标文件。

    • 示例

       local archive = _Archive.new()
       archive:compressFile('abc.txt', 'abc.zip')
  • + function convertConfig(tbl: table, vname: string, fname: string)

    转化lua配置表为C结构。

    • 参数
    • tbl: lua配置表。
    • vname: 字符流。
    • fname: 用来保存配置的文件。

    • 示例

       local archive = _Archive.new()
       archive:convertConfig(cfg, str, [[cfg_access_method.lua.tmp]])
  • + function convertToByteCode(filelist: string) : bool

    将目标文件转换成字节码。

    • 参数

    • filelist: 目标文件。

    • 返回

    • 是否转换成功

    • 示例

       local archive = _Archive.new()
       archive:convertToByteCode('xxx.lua')
  • + function decompressFile(srcname: string[, desname: string]) : bool

    解压文件。

    • 参数
    • srcname: 源文件名。
    • desname : 可选参数，目标文件。

    • 示例

       local archive = _Archive.new()
       archive:decompressFile('abc.zip')
  • + function encrypt(srcname : string, desname, userkey) : bool

    加密文件。

    • 参数
    • srcname : 源文件名。
    • desname: 加密后的文件名

    • userkey: 密钥

    • 示例

       local archive = _Archive.new()
       archive:encrypt('xxxx.cfg', 'abcd.cfg', '124fdf1b73f0b109dd435a366c9eef09')
  • + function sameAsExternalPack(filename : string) : bool

    比较文件和foa包中的文件内容是否相同， 相同返回true，否则返回false。

    • 参数
    • filename : 待比较的文件名。

    • 示例

       local archive = _Archive.new()
       archive.compressMode = _Archive.Compress7z
       archive.externalPack = "temp.foa"
       archive:sameAsExternalPack('presetground01.bmp')
  • + function save(filename : string[, listfile : string])

    保存为foa文件。

    • 参数
    • filename : 文件名。
    • lisefile : 可选参数，_Archive中checklist文件的复制，用于查看包。

    • 示例

       local archive = _Archive.new()
       archive:save('addPack.foa')

静态方法展开

  • + function beginRecord()

    开始录制。
  • + function endRecord()

    结束录制。
  • + function getRecord()

    得到录制。
问题反馈（登录才可以发表哦！）