Модуль FileTools — различия между версиями

ГлавнаяInnerCoreМодуль FileTools — различия между версиями
(Created page with " Хотя Core Engine загружает ресурсы самостоятельно, иногда их нужно загружать из другого места или и...")
 
 
(не показано 7 промежуточных версий 2 участников)
Строка 1: Строка 1:
 +
<div class="mw-parser-output"><div class="mw-parser-output">
 +
Для создания, чтения и редактирования файлов Inner Core имеет модуль FileTools, который предоставляет удобные функции для работы с файлами, а также ряд переменных, используемых при работе с файлами.
  
−
Хотя Core Engine загружает ресурсы самостоятельно, иногда их нужно загружать из другого места или из интернета, а потом в CE. Здесь пригодится FileTools. Также ручная работа с файлами полезна при создании файлов настроек.
+
== Переменные для работы с файлами в Inner Core ==
  
−
&nbsp;
+
*FileTools.mntdir - возвращает путь до хранилища смонтированных папок Android ("/mnt")
 +
*FileTools.root - возвращает путь до внешнего хранилища файлов устройства (путь к домашней папке), заканчивается на "/"
 +
*FileTools.workdir - возвращает относительный путь до папки Core Engine ("games/com.mojang/coreengine/")
 +
*FileTools.moddir - возвращает относительный&nbsp;путь до папки с модами ("games/com.mojang/mods/")
 +
*FileTools.modpedir - возвращает относительный путь до папки ModPE ("games/com.mojang/modpe/"). На данный момент в этой папке иногда пролетают перекатиполе, больше там ничего нету
  
−
Если в строке с путем не прописан корень файловой системы, то путь будет относительным от FileTools.root
+
== Методы для работы с файлами в Inner Core ==
  
−
&nbsp;
+
*FileTools.mkdir(path) - создает папку по указанному пути
 +
*FileTools.mkworkdirs() - создает рабочие папки Core Engine (workdir, moddir, modpedir)
 +
*FileTools.getFullPath(path) - возвращает абсолютный путь к файлу по его относительному к пути. Относительный путь не должен начинаться с "/". Если аргумент уже является полным путём к файлам внешнего хранилища или хранилища смонтированных папок&nbsp;Android, функция вернёт путь без изменений. Большинство других методов ''FileTools ''работают через него, поэтому в них можно передавать относительный путь
 +
*FileTools.isExists(path) - проверяет, существует ли файл или папка по пути ''path''. Параметр может быть как абсолютным путём, так и относительным
 +
*FileTools.WriteText(path, value, add) - записывает строку ''value ''в файл по пути ''path'', если ''add ''равен ''true'', то добавляет value в конец файла, если ''false ''или не указан, то файл перезаписывается
 +
*FileTools.ReadText(path) - считывает файл по пути ''path ''в строку
 +
*FileTools.WriteImage(path, image) - записывает изображение, объект типа ''Bitmap'', в файл&nbsp;по пути ''path''
 +
*FileTools.ReadImage(path) - считывает&nbsp;изображение по пути path в объект типа ''Bitmap''
 +
*FileTools.ReadTextAsset(path) - считывает файл из ресурспака по пути path в строку
 +
*FileTools.ReadImageAsset(path) - считывает&nbsp;изображение&nbsp;из ресурспака по пути path в объект типа Bitmap
 +
*FileTools.ReadBytesAsset(path) - считывает байты из ресурспака по пути&nbsp;path в Java-массив типа ''byte''
 +
*FileTools.GetListOfDirs(path) - возвращает список каталогов по данному пути в виде Javascript-массива объектов ''File''
 +
*FileTools.GetListOfFiles(path, extension) - возвращает список файлов по данному пути в виде Javascript-массива объектов ''File''. Если задан второй аргумент, возвращает только файлы с заданным расширением
 +
*FileTools.ReadKeyValueFile(path, separator) - возвращает объект, состоящих из пар ключ-значение, считанных из файла по пути ''path''. Если не задан разделитель, по умолчанию используется разделитель ":". При этом ни ключ, ни значение не очищаются от пробелов, поэтому следует делать это вручную при необходимости. Пример файла:
 +
<pre>key1:value1
 +
key2:value2
 +
key3:value3
 +
</pre>
  
−
*FileTools.mntdir - возвращает путь до хранилища смонтированных папок Linux.
+
*FileTools.WriteKeyValueFile(path, object, separator) - записывает объект, состоящий из пар ключ-значение, по пути ''path'', используя ''separator ''в качестве разделителя. Если ''separator ''не задан, используется разделитель ":". Пример файла приведён в описании к методу&nbsp;''ReadKeyValueFile''
−
*FileTools.root - возвращает папку Minecraft PE.
+
*FileTools.ReadJSON(path) - считывает файл с объектом&nbsp;JSON по заданому пути в Javascript-объект
−
*FileTools.workdir - возвращает путь до папки Core Engine.
+
*FileTools.WriteJSON(path, json, beautify) - записывает в&nbsp;JSON-файл по заданому пути&nbsp;Javascript-объект, если ''beautify ''равен ''true'', то вывод будет красиво отформатирован
−
*FileTools.moddir - возвращает путь до папки с модами.
+
</div> </div>
−
*FileTools.mkdir(path) - создает папку по указанному пути.
 
−
*FileTools.mkworkdirs() - создает рабочую папку.
 
−
*FileTools.getFullPath(path) - возвращает абсолютный путь, принимая path.
 
−
*FileTools.isExists(path) - проверяет, существует ли файл или папка на пути path.
 
−
*FileTools.WriteText(path, value, add) - записывает value по пути path, если add равен true, то добавляет value в конец файла.
 
−
*FileTools.ReadText(path) - читает строку по пути path.
 
−
*FileTools.WriteImage(path, image) - записывает изображение по пути path.
 
−
*FileTools.ReadImage(path) - читает изображение по пути path.
 
−
*FileTools.ReadTextAsset(path) - читает текст из текстурпака.
 
−
*FileTools.ReadImageAsset(path) - читает изображение из текстурпака.
 
−
*FileTools.ReadBytesAsset(path) - читает бинарное значение из текстурпака.
 
−
*FileTools.GetListOfDirs(path) - возвращает список папок по данному пути.
 
−
*FileTools.GetListOfFiles(path, [object]) - возвращает список файлов по данному пути.  
 
−
*FileTools.ReadJSON(path) - читает файл JSON по данному пути.
 
−
*FileTools.WriteJSON(path, json, beautify) - пишет файл JSON json по данному пути с количеством отступов beautify.
 

Текущая версия на 23:36, 15 марта 2019

Для создания, чтения и редактирования файлов Inner Core имеет модуль FileTools, который предоставляет удобные функции для работы с файлами, а также ряд переменных, используемых при работе с файлами.

Переменные для работы с файлами в Inner Core[править]

  • FileTools.mntdir - возвращает путь до хранилища смонтированных папок Android ("/mnt")
  • FileTools.root - возвращает путь до внешнего хранилища файлов устройства (путь к домашней папке), заканчивается на "/"
  • FileTools.workdir - возвращает относительный путь до папки Core Engine ("games/com.mojang/coreengine/")
  • FileTools.moddir - возвращает относительный путь до папки с модами ("games/com.mojang/mods/")
  • FileTools.modpedir - возвращает относительный путь до папки ModPE ("games/com.mojang/modpe/"). На данный момент в этой папке иногда пролетают перекатиполе, больше там ничего нету

Методы для работы с файлами в Inner Core[править]

  • FileTools.mkdir(path) - создает папку по указанному пути
  • FileTools.mkworkdirs() - создает рабочие папки Core Engine (workdir, moddir, modpedir)
  • FileTools.getFullPath(path) - возвращает абсолютный путь к файлу по его относительному к пути. Относительный путь не должен начинаться с "/". Если аргумент уже является полным путём к файлам внешнего хранилища или хранилища смонтированных папок Android, функция вернёт путь без изменений. Большинство других методов FileTools работают через него, поэтому в них можно передавать относительный путь
  • FileTools.isExists(path) - проверяет, существует ли файл или папка по пути path. Параметр может быть как абсолютным путём, так и относительным
  • FileTools.WriteText(path, value, add) - записывает строку value в файл по пути path, если add равен true, то добавляет value в конец файла, если false или не указан, то файл перезаписывается
  • FileTools.ReadText(path) - считывает файл по пути path в строку
  • FileTools.WriteImage(path, image) - записывает изображение, объект типа Bitmap, в файл по пути path
  • FileTools.ReadImage(path) - считывает изображение по пути path в объект типа Bitmap
  • FileTools.ReadTextAsset(path) - считывает файл из ресурспака по пути path в строку
  • FileTools.ReadImageAsset(path) - считывает изображение из ресурспака по пути path в объект типа Bitmap
  • FileTools.ReadBytesAsset(path) - считывает байты из ресурспака по пути path в Java-массив типа byte
  • FileTools.GetListOfDirs(path) - возвращает список каталогов по данному пути в виде Javascript-массива объектов File
  • FileTools.GetListOfFiles(path, extension) - возвращает список файлов по данному пути в виде Javascript-массива объектов File. Если задан второй аргумент, возвращает только файлы с заданным расширением
  • FileTools.ReadKeyValueFile(path, separator) - возвращает объект, состоящих из пар ключ-значение, считанных из файла по пути path. Если не задан разделитель, по умолчанию используется разделитель ":". При этом ни ключ, ни значение не очищаются от пробелов, поэтому следует делать это вручную при необходимости. Пример файла: 
key1:value1
key2:value2
key3:value3
  • FileTools.WriteKeyValueFile(path, object, separator) - записывает объект, состоящий из пар ключ-значение, по пути path, используя separator в качестве разделителя. Если separator не задан, используется разделитель ":". Пример файла приведён в описании к методу ReadKeyValueFile
  • FileTools.ReadJSON(path) - считывает файл с объектом JSON по заданому пути в Javascript-объект
  • FileTools.WriteJSON(path, json, beautify) - записывает в JSON-файл по заданому пути Javascript-объект, если beautify равен true, то вывод будет красиво отформатирован
Источник — «https://wiki.mineprogramming.org/index.php?title=InnerCore/Модуль_FileTools&oldid=1901»
Навигация
Инструменты