Cookie Clicker – Справочник по функциям Mod API + info.txt 1 – steamlists.com

Справочник по многим полезным или необходимым функциям для моддинга, а также по ключевым значениям info.txt.

Обратите внимание, что это руководство является неполным и будет обновляться по мере того, как я найду новые функции, которые стоит задокументировать.

Это не руководство по созданию модов!

## info.txt

info.txt следует структуре JSON. Вот список всех ключей, они обязательны, если не указано иное.

Описания взяты из sampleMod main.js.

Имена типов, написанные в скобках после них, имеют определенное форматирование. то есть:

String (id) => V – «какой-то идентификатор» X – «какой-то идентификатор, ϗ»

Введите имена с [square brackets] после них указывают, что это массив этого типа.

Эти два правила применяются ко всему руководству.

Строка имени

Пример: «Мой крутой мод»

Видимо отображаемое имя вашего мода.

Строка идентификатора (id)

Пример: «мой крутой мод»

Текстовый идентификатор вашего мода (только буквенно-цифровые символы и пробелы), используемый в качестве его ключа при сохранении или загрузке данных.

Также используется в качестве идентификаторов в зависимостях других модов.

Этот идентификатор должен совпадать с первым параметром, используемым в вашем Game.registerMod (id, hooks).

Строка автора

Пример: «Ты!»

Ваше имя здесь!

Описание Строка

Пример: «Мод, который делает крутые вещи».

Описание вашего мода.

Номер ModVersion

Пример: 1

Числовое значение версии вашего мода.

Номер версии игры

Пример: 2.031

Последняя версия Cookie Clicker для этого мода была подтверждена для работы.

Строка даты (ММ / ДД / ГГГГ)

Пример: «20.04.2069»

Дата выпуска или последнего обновления вашего мода.

Строка зависимостей (id)[]

Пример: [“cool mod template”]

По желанию.

Массив идентификаторов других модов, которые должны быть загружены перед этим.

LanguagePacks String (имя файла)[]

Пример: [“lang.js”]

По желанию.

Массив локальных файлов, содержащих данные локализации. (например, изменение текста игры, добавление переводов и т. д.)

Номер для инвалидов (0 | 1)

Пример: 1

По желанию.

Если установлено значение 1, этот мод будет отключен по умолчанию.

Число AllowSteamAchievs (0 | 1)

Пример: 0

По желанию.

По умолчанию моды (если они не состоят только из языковых файлов) блокируют разблокировку достижений Steam, пока они включены.

Установите значение 1, если это хороший, честный мод, который не сильно разбалансирует игру.

Они были взяты из раздела MODDING API скрипта main.js игры.

Game.registerMod (id, mod) недействителен

Вызовите эту функцию в файле main.js вашего мода.

Доступ к модам и их данным можно получить с помощью Game.mods.[‘mod id’].

id String – ID вашего мода. Объект mod – объект мода. Должны иметь следующие функции:

{init: function () {// Вызывается, как только мод зарегистрирован. Объявите здесь крючки. }, save: function () {return ‘сохранить данные’; // Используется для хранения постоянных данных. }, load: function (str) {// Получить постоянные данные, которые вы сохранили с помощью `save`. // str {String} – данные. }}

Game.registerHook (id, func) void

Зарегистрируйте одну или несколько ловушек в указанном ID ловушки.

id String – Функция ID.func ловушки (ов) | функция[] – Что делают крючки. Если вы хотите позже удалить ловушку, объявите функцию (ы) где-нибудь еще, а затем просто укажите на нее (их) здесь.

Game.removeHook (id, func) void

Снимите крючок.

Если вы добавили хук «мой хук» с помощью Game.registerHook («мой хук», hookFunc), вы захотите удалить хук с помощью Game.removeHook («мой хук», hookFunc).

id String – Ловушка (ов) ID.func функция – Ловушка.

Game.Loader.Replace (what, forWhat) void

Заменить существующее изображение холста во время выполнения.

Аргументы – это имена файлов, например /img/unCookie.png.

какая строка

Картинка, которую нужно заменить. For What String

Картинка какая заменена.

Game.Notify (title, desc, pic, quick ?, noLog?) Void

Создает уведомление внизу экрана.

строка заголовка

Уведомление title.desc String

Описание. Обратите внимание, что здесь вы можете использовать HTML.

При использовании элементов HTML, которые принимают JS в свойствах, вы можете использовать == CLOSETHIS () == для автоматического закрытия уведомления при вызове указанного JS.

т.е. Делай что-нибудь номер картинки[] | Нить

Какой значок использовать. (Установите пустую строку без значка)

Представляет [x, y] координаты на src / img / icons.png.

Например, [2, 3] такое обычное печенье icon.quick? = 6 цифр

Еще не реконструирован. Предположили, что это время на экране?

Не может быть установлено значение выше `6`. NoLog? = ложное логическое значение

Установите значение true, чтобы предотвратить регистрацию уведомления.

Хуки – это функции, которые игра вызывает автоматически при определенных обстоятельствах, например, при подсчете файлов cookie за клик или при перерисовке экрана.

function customLogic () {// …} // Чтобы добавить перехватчик Game.registerHook (‘logic’, customLogic); Game.registerHook (‘логика’, function () {// …}); Game.registerHook (‘логика’, () => {/ * … * /}); // Чтобы удалить перехватчик Game.removeHook (‘logic’, customLogic);

Чтобы добавить ловушку, например, логику, вызовите Game.registerHook (‘logic’, function () {…}); в init.

Чтобы удалить его, вызовите Game.removeHook (‘logic’, theSameFunc) ;. (Обратите внимание, что theSameFunc должен быть одним и тем же функциональным объектом!)

Перехватчики функций предусмотрены для удобства, а более продвинутая функциональность мода, вероятно, будет включать в себя ручную инъекцию кода.

Помните о длине данных, которые вы сохраняете, поскольку это увеличивает функцию экспорта-сохранения в строку.

ПРИМЕЧАНИЕ. API моддинга подвержен изменениям и не всегда может работать хорошо.

Кроме того, это руководство является неофициальным и может быть устаревшим!

логика :() недействительна

Вызывается каждая логическая галочка.

ничья :() недействительно

Вызывается каждый тик розыгрыша.

сброс: (жесткий) недействителен

Вызывается, когда игрок сбрасывает пробег.

жесткое логическое значение

Верно, когда игрок жестко перезагружается вместо вознесения

перевоплощение :() пустота

Вызывается, когда игрок перевоплощается после вознесения.

тикер :() Строка[]

Вызывается при определении текста тикера новости.

Вернуть массив возможных вариантов.

cps: (текущий) номер

Вызывается при определении CpS.

Используйте для изменения CpS.

текущий номер

Текущий CpS.

cookiesPerClick: (текущий) номер

Вызывается при определении файлов cookie за клик.

Используйте для изменения файлов cookie за клик.

текущий номер

Текущие файлы cookie на клик.

нажмите :() недействительно

Вызывается при нажатии на большой файл cookie.

создать :() void

Вызывается, когда в игре объявляются все постройки, улучшения и достижения.

Используйте это, чтобы объявить свое собственное.

* Обратите внимание, что функция сохранения / загрузки для пользовательского контента явно не реализована и может быть непредсказуемой и неработающей. *

проверить :() недействительно

Вызывается каждые несколько секунд, когда мы проверяем условия разблокировки улучшений / достижений.

Вы также можете использовать это для других проверок, которые вам не нужно выполнять в каждом логическом кадре.

Полезные функции находятся в разделе MISC HELPER FUNCTIONS сценария игры main.js.

l (что) HtmlElement

Получает элемент HTML по идентификатору.

Сокращение для document.getElementById (what);

какая строка

ID элемента.

выбрать (обр) Любой

Возвращает случайный элемент в массиве.

arr: любой[]

Массив.

escapeRegExp (str) Строка

Экранирует общие символы, используемые в регулярных выражениях.

str String

Неэкранированная строка.

replaceAll (найти, заменить, str) Строка

Возвращает str, при этом все экземпляры find заменяются на replace.

найти строку

RegExp String. Что найти. Заменить String

Что заменить. Str String

Струна.

cap (str) Строка

Делает первую букву строки заглавной.

str String

Струна.

романизировать (число) Строка

Романизирует число.

числовой номер

Номер.

В этом разделе описывается функция загрузчика, отвечающая за загрузку ресурсов.

Game.Loader.Load (активы) недействительны

Загружает массив активов.

Не совсем уверен, что это предназначено для использования модами.

Активы Строка (URL)[]

Путь к загружаемым активам.

Game.Loader.Replace (старый, новый) void

Замените существующий актив новым.

старая строка (URL)

Заменяемый актив. Новая строка (url)

Актив, заменяющий старый.

Прочие функции.

AddEvent (html_element, event_name, event_function) void

Присоединяет событие к элементу HTML.

html_element HTMLElement

Элемент для получения события. Event_name String

Название мероприятия.

Рекомендуется назвать событие с помощью kebab-case.event_function function () => void

Что делает элемент при срабатывании события.

FireEvent (el, etype) недействителен

Запускает событие, прикрепленное к элементу el.

el HTMLElement

Строка element.eltype

Событие на огонь.

PlaySound (url, vol, pitchVar) недействительно

Воспроизводит звук.

url String

URL-адрес воспроизводимого звука. (Будет кэшироваться, поэтому загружается только один раз) vol? = 1 число

Громкость от 0 до 1. (Умноженная на настройку громкости игры) pitchVar? = 0,05 число

Отключено!

Отклонение высоты тона в браузерах, которые его поддерживают. (Firefox только на данный момент)

По умолчанию 0,05, что означает, что высота звука может составлять до -5% или + 5% в любое время, когда воспроизводится звук.

PlayMusicSound (url, vol, pitchVar) недействительно

То же, что и PlaySound (), но использует громкость музыки вместо громкости звука.

Все аргументы имеют ту же цель, что и PlaySound ().

Если вы знаете функцию, которую следует задокументировать, прокомментируйте!

(Желательно с именем файла сценария и номером строки, в которой он находится)

Автор: ThEnderYoshi

Надеюсь, вам понравится Руководство по Cookie Clicker – Функции для Mod API Reference + info.txt, если вы считаете, что нам следует добавить дополнительную информацию или что-то забыть, сообщите нам об этом в комментариях ниже, и мы сделаем все возможное, чтобы исправить или обновить как как можно скорее!