Редактирование:Модуль ModAPI

<div class="mw-parser-output"><p>Core Engine имеет модуль для обмена объектами API между различными модами - ModAPI, обмен API осуществляется с помощью методов регистрации и публикации API и с помощью методов его получения.
</p><p>&#160;
</p><p>Чтобы сделать объект API доступным для других модов используется метод ModAPI.registerAPI("имя API", объект API) - после вызова этого метода, остальные моды смогут получить объект API по данному имени.
</p><p>&#160;
</p><p>Чтобы получить объект API нужно добавить специальное событие на имя объекта API, который требуется получить. Событие используется потому, что моды загружаются в произвольном порядке и неизвестно, зарегистрирован ли данный API на момент загрузки мода, который в нем нуждается, даже если мод, который регистрирует, присутсвует.
</p><p>Для этого используется такой метод:
</p>
<pre>ModAPI.addAPICallback(&quot;имя API&quot;, function(api){

     // api является объектом api, зарегистрированным под данным именем

})</pre>
<p>&#160;
</p><p>Это событие произойдет 1 раз после добавления, при этом если API уже зарегистрирован, то событие произойдет сразу после добавления, иначе оно будет ожидать регистрации.
</p><p>В этом событии вы можете произвести какие-то действия, связанные с работой с данным API, например при получении ThaumAPI (api таумкрафта), добавить предметам вашего мода аспекты. Если событие не произойдет, значит таумкрафт не установлен и аспекты регистрировать не надо.
</p><p>&#160;
</p><p>&#160;
</p>
<h3> Использование событий в скрипте-лаунчере </h3>
<p>Если мод не может работать без какого-то объекта API (например это дополнение к какому-то моду), то разумно будет сделать так, что мод запускается по событию регистрации данного API и сразу передать ему объект API.
</p><p>&#160;
</p><p>К примеру вот код лаунчера мода, который является дополнением к таумкрафту и которому обязателен ThaumAPI:
</p><p>&#160;
</p>
<pre>ModAPI.addAPICallback(&quot;ThaumAPI&quot;, function(api){

     // по событию регистрации ThaumAPI запустить основной мод

     Launch({

          ThaumAPI: api // в качестве дополнительного значения при запуске под именем ThaumAPI передать полученный объект api

     });

});</pre>
<p>&#160;
</p><p>&#160;
</p>
<h3> Другие методы ModAPI </h3>
<ul><li>ModAPI.requireAPI("имя API") - отдает объект API по данному имени, если он зарегистрирован. Несовершенен, потому что порядок загрузки неизвестен. Лучше используйте ModAPI.addAPICallback. </li>
<li>ModAPI.getModByName("имя мода") - отдает объект мода, отвечающий за его файлы и загрузку, если мод загружен. Несовершенен, потому что порядок загрузки неизвестен. Лучше используйте ModAPI.addModCallback. </li>
<li>ModAPI.addModCallback("имя мода", function(mod){ &#160;<br /> &#160; // mod является объектом мода<br /> }) - добавляет событие, которое произойдет при загрузке мода под данным именем, которому будет передан объект мода. Аналогичен по действию ModAPI.addAPICallback, только для модов. </li>
<li>ModAPI.isModLoaded("имя мода") - проверяет, загружен ли мод с этим именем. Актуальна в в событиях PostLoaded и ModsLoaded, которые происходят после загрузки всех модов. </li>
<li>ModAPI.requireGlobal("имя переменной или исполняемая строка") - возвращает переменную с данным именем из самого Core Engine, если передана исполняемая строка, выполняет ее в пространстве имен Core Engine и возвращает результат, при возникновении ошибки возвращает null и пишет ошибку в лог. Может быть использована для получения скрытых модулей или значений ModPE (они могут работать некорректно).</li></ul>
</div>
@@ Строка 57: / Строка 57: @@
 *ModAPI.getModByName("имя мода") - отдает объект мода, отвечающий за его файлы и загрузку, если мод загружен. Несовершенен, потому что порядок загрузки неизвестен. Лучше используйте ModAPI.addModCallback.
 *ModAPI.addModCallback("имя мода", function(mod){ &nbsp;<br/> &nbsp; // mod является объектом мода<br/> }) - добавляет событие, которое произойдет при загрузке мода под данным именем, которому будет передан объект мода. Аналогичен по действию ModAPI.addAPICallback, только для модов.
-*ModAPI.isModLoaded("имя мода") - проверяет, загружен ли мод с этим именем. Актуальна в событиях PostLoaded и ModsLoaded, которые происходят после загрузки всех модов.
+*ModAPI.isModLoaded("имя мода") - проверяет, загружен ли мод с этим именем. Актуальна в в событиях PostLoaded и ModsLoaded, которые происходят после загрузки всех модов.
 *ModAPI.requireGlobal("имя переменной или исполняемая строка") - возвращает переменную с данным именем из самого Core Engine, если передана исполняемая строка, выполняет ее в пространстве имен Core Engine и возвращает результат, при возникновении ошибки возвращает null и пишет ошибку в лог. Может быть использована для получения скрытых модулей или значений ModPE (они могут работать некорректно).