Редактирование:GuideAPI

<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><h2> GuideAPI </h2>
<div class="mw-parser-output"><b>GuideAPI </b>– мод-библиотека, предоставляющая большие возможности для создания игровых документаций.</div> <div class="mw-parser-output"><pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">ModAPI.addAPICallback(&quot;GuideAPI&quot;, function(api) {
    const GuideAPI = api.GuideAPI;
    const GuideHelper = api.GuideHelper;
    const PageControllers = api.PageControllers;

    IDRegistry.genItemID(&quot;testGuide&quot;);
    Item.createItem(&quot;testGuide&quot;, &quot;Test Guide&quot;, {
        name: &quot;stick&quot;
    });

    GuideAPI.registerGuide(&quot;guideTest&quot;, {
        item: ItemID.testGuide,
        debug: false,
        textures: {
            background: &quot;your_texture&quot;,
            nextLink: &quot;your_texture&quot;,
            preLink: &quot;your_texture&quot;,
            close: &quot;your_texture&quot;,
        },
        pages: {
            &quot;default&quot;: {
                nextLink: &quot;test&quot;,
                left: {
                    controller: PageControllers.BASIC_PAGE,
                    elements: []
                },

                right: {
                    controller: PageControllers.BASIC_PAGE,
                    elements: []
                }
            }
        }
    });
});</syntaxhighlight></pre>
<p>Регистрация происходит через метод <i>GuideAPI.registerGuide(unique, params)</i>, где <i><b>unique</b></i>– уникальный идентификатор, <i><b>params</b></i>– объект с параметрами.<br /> Параметры:
</p>
<ul><li>Объект <i><b>textures</b></i>задаёт текстуры для интерфейса. Если не объявлен, будет использоваться стандартное оформление 
<ul><li><u><i>background</i></u><i>&#160;</i>– текстура заднего фона </li>
<li><u><i>nextLink</i></u><i>– текстура для кнопки “вперёд”</i> </li>
<li><u><i>preLink</i></u> – текстура для кнопки “назад” </li>
<li><i><u>сlose</u></i> – текстура для кнопки закрытия интерфейса   </li></ul></li>
<li>Объект <b>item</b> задаёт ид предмета, при клике которым происходит открытие интерфейса. Является необязательным параметром </li>
<li>Если <b>debug</b> объявлен и равен true, у интерфейса вызывается метод setDebugEnabled(true) </li>
<li>Объект <b>pages</b> содержит страницы. Каждая имеет правую<i><b>(right)</b></i> и левую<i><b>(left)</b></i> секции, для которых задаются контроллеры<i><b>(controller)</b></i>. Любую из них можно пропустить. <i><b>nextLink</b></i>содержит идентификатор страницы, на которую происходит переход при нажатии кнопки “вперёд”, <i><b>preLink</b></i>при нажатии кнопки “назад”. При открытии интерфейса происходит загрузка страницы с идентификатором <i><b>default</b></i>. </li></ul>
<div class="mw-parser-output">
<div class="mw-parser-output">
<h2> Контроллеры </h2>
<p><b>Контроллер </b>– функция, указанная под идентификатором <i><b>controller</b></i>&#160;в объекте секции. GuideAPI предоставляет стандартные контроллеры, находящиеся в объекте <i>PageControllers</i>, которые позволяют решить большинство задач.
</p>
<div class="mw-parser-output">
<h3> BASIC_PAGE </h3>
<div class="mw-parser-output">Контроллер <i>BASIC_PAGE</i>&#160;позволяет создавать простые страницы с текстом.</div> <div class="mw-parser-output"><pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">{
    controller: PageControllers.BASIC_PAGE,
    elements: [
        {text: &quot;I'm simple text!&quot; },
        { text: &quot;I'm big text!&quot;, size: 20 },
        { text: &quot;I'm red text!&quot;, color: android.graphics.Color.RED },
        { text: &quot;I'm underlined bold text!&quot;, underline: true, bold: true },
        { text: &quot;I'm link. Click me, please!&quot;, color: android.graphics.Color.BLUE, link: &quot;page2&quot; }
    ]
}</syntaxhighlight></pre>
<p>Объект <i><b>elements</b></i> доступен для использования во всех стандартных контроллерах. Он содержит массив строк, каждая из которых отображается на новой строке. Если текст не влезает в границы секции, он будет перенесён.<br /> Параметры текста:
</p>
<ul><li><b>size</b> – размер шрифта </li>
<li><b>color</b>&#160;– цвет текста(android.graphics.Color.RED, android.graphics.Color.BLUE и тд) </li>
<li><b>underline</b> – подчёркнутый ли текст </li>
<li><b>bold</b> – жирный ли текст </li>
<li><b>link</b> – идентификатор страница, на которую будет осуществлён переход при клике на текст </li></ul>
</div> </div> 
<div class="mw-parser-output">
<h3> ITEM_PAGE </h3>
<p>Котроллер <i>ITEM_PAGE </i>позволяет создавать страницы с группой предметов и текстом.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">{
    controller: PageControllers.ITEM_PAGE,
    items: [
        { id: 1, data: 1 },
        { id: 264 },
        { id: 266 },
    ],
    elements: [
        { text: &quot;I'm text&quot;, size: 20 },
        { text: &quot;And I'm text too&quot; }
    ]
}</syntaxhighlight></pre>
</p><p><i><b>items</b></i> – массив из отображаемых предметов. Первый из них будет помещён в большой слот.
</p>
</div>
<div class="mw-parser-output">
<h3> ITEM_GRID_PAGE </h3>
<p>Контроллер <i>ITEM_GRID_PAGE </i>позволяет располагать предметы сеткой.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">{
    controller: PageControllers.ITEM_GRID_PAGE,
    columns: 8,
    item_size: 30,
    items: [
        { id: 1, data: 1, count: 34 },
        { id: 264, link: &quot;test&quot; },
        {
            id: 265,
            clicker: {
                onClick: function() {
                    alert(&quot;CLICK!!!!!!!!!!!!!!!!!!11&quot;);
                }
            }
        },
        { id: 4 },
        { id: 5 },
        { id: 6 },
        { id: 7 },
        { id: 8 },
        { id: 9 },
        { id: 10 },
    ],
    elements: [
        { text: &quot;HELLO&quot;, size: 15, underline: true, bold: true }
    ]
}</syntaxhighlight></pre>
</p><p><i><b>items</b></i> – массив из отображаемых предметов<br /> <i><b>сolumns</b></i> – количество колонок. По умолчанию 6<br /> <i><b>item_size</b></i> – размер предмета. По умолчанию 60<br /> Параметры для предметов:
</p>
<ul><li><i><b>link</b></i> – идентификатор страница, на которую будет осуществлён переход при клике на текст </li>
<li><i><b>clicker</b></i> – объект клика. 
<ul><li><u><i>onClick</i></u> – короткий клик </li>
<li><i><u>onLongClick</u></i> - длинный   </li></ul></li></ul>
</div>
<div class="mw-parser-output">
<h3> OTO_RECIPE_PAGE </h3>
<p>Котроллер <i>OTO_RECIPE_PAGE</i> позволяет создавать страницы с рецептами <i>“Один к одному”</i>.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">{
    controller: PageControllers.OTO_RECIPE_PAGE,
    title: &quot;Furnace Recipe&quot;,
    type: 0,
    bar_texture: &quot;furnace_bar_guide&quot;,
    recipes: [
        {
            input: { id: 4, data: 1, count: 10 },
            output: { id: 264 }
        },
        {
            input: { id: 264 },
            output: { id: 265 }
        }
    ],
    elements: [
        { text: &quot;Text&quot; },
        { text: &quot;And Text&quot; },
    ]
}</syntaxhighlight></pre>
</p><p>Если <i><b>type</b></i> равен 0, <i><b>recipes</b></i> – массив из объектов, в которых содержится предмет на вход<i><b>(input)</b></i> и предмет на выход<i><b>(output)</b></i>.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">{
    controller: PageControllers.OTO_RECIPE_PAGE,
    title: &quot;Furnace Recipe&quot;,
    type: 1,
    bar_texture: &quot;furnace_bar_guide&quot;,
    recipes: [
        { id: 1 },
        { id: 17, data: 1 }
    ],
    elements: [
        { text: &quot;This is type 1&quot; }
    ]
}</syntaxhighlight></pre>
</p><p>Если <i><b>type</b></i> равен 1, <i><b>recipes</b></i> – массив из объектов, которые содержат информацию о предмет на вход. В выходной слот будет помещаться результат обработки указанного предмета в печи.<br /> Остальные параметры:
</p>
<ul><li><i><b>title</b></i> – заголовок страницы </li>
<li><i><b>bar_texture</b></i> – текстура для индикатора прогресса </li></ul>
</div>
<div class="mw-parser-output">
<h3> GRID_3x3_PAGE </h3>
<p>Котроллер <i>GRID_3x3_PAGE</i> позволяет создавать страницы рецептов с сеткой 3x3.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">{
    controller: PageControllers.GRID_3x3_PAGE,
    title: &quot;Workbench Recipe&quot;,
    recipes: [{
        grid: [
            [&quot;b&quot;, &quot;b&quot;, &quot;b&quot;],
            [&quot;b&quot;, &quot;g&quot;, &quot;b&quot;],
            [&quot;b&quot;, &quot;8&quot;, &quot;b&quot;]
        ],
        materials: {
            &quot;b&quot;: { id: 4, data: 0 },
            &quot;g&quot;: { id: 1, data: 0 },
        },
        result: { id: 61, count: 3 }
    }],
    elements: [
        { text: &quot;Text&quot;}
    ],
}
</syntaxhighlight></pre>
</p>
</div>
<div class="mw-parser-output">
<h3> Создание собственных контроллеров </h3>
<p>Для создания собственных контроллеров необходимо в поле <i>controller</i> передать функцию, которая будет рисовать элементы на странице.
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="JavaScript">PageControllers[&quot;MY_TEST_PAGE&quot;] = function(params, elements, container, section) {
    let x = section === &quot;left&quot; ? 50 : 550;
    elements[&quot;text_&quot; + section + &quot;_&quot; + i] = {
        type: &quot;text&quot;,
        x: section,
        y: 40,
        text: params.title
    };

    if (params.elements)
        GuideHelper.drawTextArray(params.elements, x, 55, globalSize, elements, section);
};
//...
{
    controller: PageControllers.MY_TEST_PAGE,
    title: &quot;I'm title&quot;,
    elements: [
        { text: &quot;Text&quot; }
    ],
}
//...</syntaxhighlight></pre>
</p><p>Передаваемые аргументы:
</p>
<ul><li><i><b>params</b></i> – объект секции, для которой вызывается функция </li>
<li><i><b>elements</b></i> – элементы интерфейса </li>
<li><i><b>container</b></i> – контейнер интерфейса </li>
<li><i><b>section</b></i> – название секции(left, right) </li></ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
@@ Строка 1: / Строка 1: @@
 <div class="mw-parser-output"><div class="mw-parser-output">
-<div class="mw-parser-output">
 == GuideAPI ==
 <div class="mw-parser-output">'''GuideAPI '''– мод-библиотека, предоставляющая большие возможности для создания игровых документаций.</div> <div class="mw-parser-output"><syntaxhighlight lang="JavaScript">ModAPI.addAPICallback("GuideAPI", function(api) {
@@ Строка 38: / Строка 37: @@
 });</syntaxhighlight>
-Регистрация происходит через метод ''GuideAPI.registerGuide(unique, params)'', где '''''unique'''''&nbsp;– уникальный идентификатор, '''''params'''''&nbsp;– объект с параметрами.<br/> Параметры:
+Регистрация происходит через метод ''GuideAPI.registerGuide(unique, params)'', где '''''unique'''''– уникальный идентификатор, '''''params'''''– объект с параметрами.<br/> Параметры:
-*Объект '''''textures''''' задаёт текстуры для интерфейса. Если не объявлен, будет использоваться стандартное оформление
+*Объект '''''textures'''''задаёт текстуры для интерфейса. Если не объявлен, будет использоваться стандартное оформление
 **<u>''background''</u>''&nbsp;''– текстура заднего фона
 **<u>''nextLink''</u>''– текстура для кнопки “вперёд”''
@@ Строка 47: / Строка 46: @@
 *Объект '''item''' задаёт ид предмета, при клике которым происходит открытие интерфейса. Является необязательным параметром
 *Если '''debug''' объявлен и равен true, у интерфейса вызывается метод setDebugEnabled(true)
-*Объект '''pages''' содержит страницы. Каждая имеет правую'''''(right)''''' и левую'''''(left)''''' секции, для которых задаются контроллеры'''''(controller)'''''. Любую из них можно пропустить. '''''nextLink'''''&nbsp;содержит идентификатор страницы, на которую происходит переход при нажатии кнопки “вперёд”, '''''preLink'''''при нажатии кнопки “назад”. При открытии интерфейса происходит загрузка страницы с идентификатором '''''default'''''.
+*Объект '''pages''' содержит страницы. Каждая имеет правую'''''(right)''''' и левую'''''(left)''''' секции, для которых задаются контроллеры'''''(controller)'''''. Любую из них можно пропустить. '''''nextLink'''''содержит идентификатор страницы, на которую происходит переход при нажатии кнопки “вперёд”, '''''preLink'''''при нажатии кнопки “назад”. При открытии интерфейса происходит загрузка страницы с идентификатором '''''default'''''.
-<div class="mw-parser-output"><div class="mw-parser-output">&nbsp;</div> </div> </div> </div>
+<div class="mw-parser-output">
+<div class="mw-parser-output">
 == Контроллеры ==