Документация
Docs/ru/reference/particle-format/xml.md
Правила исходников частиц
Сгенерированный справочник. Не редактируйте эту страницу напрямую. Обновите
BuildTools/ParticleFormatInterface.json, затем выполнитеpython BuildTools/docs_particle_format.py --write.
| Индекс справочника | Правила исходников | Форматы и backend-ы | Отрисовка | Инструменты | Runtime | Интеграция | Проверка | Каноническая JSON-модель | Руководство | Инструменты авторинга |
| Стабильный ID | Правило | Требование | Причина | Источник |
|---|---|---|---|---|
particle-format.xml.spark-graph |
XML-граф SPARK | Исходник .spark должен приниматься vendored XML-loader SPARK и содержать рабочий граф System. | Запекание завершается ошибкой, когда loadFromBuffer(“xml”, …) не возвращает систему. | Source/Tools/ParticleBaker.cpp |
particle-format.xml.spark-textures |
Пути текстур SPARK | Пути текстур SPARK должны быть относительными, не содержать управляющих символов строки и оставаться внутри resource source частицы. | Baker отклоняет абсолютные и выходящие наружу пути до создания .spk. | Source/Tools/ParticleBaker.cpp |
particle-format.xml.effekseer-project |
XML-проект Effekseer | Исходник .efkproj должен быть непустым XML-документом EffekseerProject, поддерживаемым фиксированным профилем компилятора. | Native-компилятор отклоняет malformed XML и неподдерживаемые функции профиля во время запекания. | Source/Tools/EffekseerCompiler.cpp |
particle-format.xml.effekseer-dependencies |
Пути зависимостей Effekseer | Оставляйте сообщаемые компилятором зависимости относительными и внутри directory resource source, владеющего проектом. | Snapshots зависимостей и компиляция разрешают пути относительно физической директории проекта и отклоняют escapes. | Source/Tools/ParticleBaker.cpp |
particle-format.xml.root |
Корень документа SPARK | Корневой элемент должен точно называться SPARK. | XML-loader отклоняет отсутствующий или иначе названный корень до построения графа. | ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLLoader.cpp |
particle-format.xml.single-system |
Ровно один System | Граф должен содержать ровно один объект System; вложенные вспомогательные объекты его не заменяют, а второй System невалиден. | Проверка графа выбирает единственный System как результат загрузки. | ThirdParty/spark/spark/src/Core/IO/SPK_IO_Loader.cpp |
particle-format.xml.object-tags |
Зарегистрированные теги объектов | Имя каждого элемента объекта должно совпадать с одним из зарегистрированных тегов в generated-каталоге. | Graph::addNode завершается ошибкой, когда IOManager не может создать объект с таким именем. | ThirdParty/spark/spark/src/Core/IO/SPK_IO_Loader.cpp |
particle-format.xml.attributes |
Элементы атрибутов | Сериализуйте значения descriptor как дочерние attrib с непустым id, совпадающим с именем атрибута descriptor объекта. | Loader игнорирует дочерние элементы не attrib на уровне атрибутов и ищет каждый id в descriptor. | ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLLoader.cpp |
particle-format.xml.values |
XML-атрибут value или текст | Скалярное или массивное значение можно записать в XML-атрибуте value элемента attrib или как текст элемента; при наличии обоих приоритет имеет value. | XMLLoader::getValue сначала проверяет атрибут value, а иначе читает текст дочернего элемента. | ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLLoader.cpp |
particle-format.xml.arrays |
Массивы через точку с запятой | Разделяйте значения массива точками с запятой; каждый элемент преобразуется независимо, а до присваивания требуется хотя бы одно преобразованное значение. | convert2Array разделяет только по точкам с запятой и возвращает false для пустого результата преобразования. | ThirdParty/spark/spark/include/Extensions/IOConverters/SPK_IO_XMLLoader.h |
particle-format.xml.references |
Вложенные объекты и ссылки | Reference-атрибуты могут вкладывать объект напрямую или идентифицировать ранее описанный shared object через ref; массивы ссылок используют вложенные объекты и дочерние Ref. | Loader разрешает как inline-узлы графа, так и целочисленные ID ссылок, а saver записывает ссылки в соответствии с sharing графа. | ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLLoader.cpp ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLSaver.cpp |
particle-format.xml.names-and-unknowns |
Имена и неизвестные атрибуты | Запишите опциональное display name объекта в его XML-атрибут name. Неизвестные непустые attrib id логируются как warnings и пропускаются, а не становятся custom data. | Имена имеют отдельный descriptor path, а опечатки в атрибутах не влияют на загруженный объект. | ThirdParty/spark/spark/src/Extensions/IOConverters/SPK_IO_XMLLoader.cpp |