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

<div class="mw-parser-output"><div class="mw-parser-output">Dimensions - библиотека, значительно упрощающая процесс создания измерений. В этой документации будут описаны ее основные возможности и функционал. <div class="mw-parser-output">
<div class="mw-parser-output">
<h2> Загрузка </h2>
<table border="1" cellpadding="1" cellspacing="1">

<tr>
<td> Версия
</td>
<td> Ссылка
</td>
<td> Список изменений
</td></tr>
<tr>
<td> <b>2</b>
</td>
<td> <a href="https://github.com/mineprogramming/APO_craft/blob/master/lib/dimensions.js" alt="https://github.com/mineprogramming/APO_craft/blob/master/lib/dimensions.js" title="https://github.com/mineprogramming/APO_craft/blob/master/lib/dimensions.js">Скачать</a>
</td>
<td> Фикс ошибки получения координат в функции генерации чанка (by IchZerowan)
</td></tr></table>
<h2> Подключение </h2>
<p>Для подключения данной библиотеки используется следующая строка:
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">IMPORT(&quot;dimensions&quot;);
</syntaxhighlight></pre>
</p>
</div>
<h2> Генерация </h2>
<p>Для генерации измерения используется объект<span><span class="fctbNone">Dimension. В конструктор передаются параметры, связанные с измерением в следующем формате:</span></span>
</p><p>&#160;
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">
var dim007 = new Dimension({
    name: &quot;dim007&quot;, // Название измерения
    
    generation: { //Генерация
        layers: [
             //Слои генерации 
        ],
        
        decoration: {
            
        }
    },
    
    environment: {
        
    },
    
    callbacks: { 
        // Основные коллбеки измерения
        // Здесь приведены все коллбеки измерений, ненужные можно опустить.
        tick: function() { 
            
        },

        generateChunk: function(chunkX, chunkZ) { 
            // Генерация чанка
        },

        loaded: function() {
            // Загрузка измерения
        },

        unloaded: function() {
            // Выгрузка  измерения
        }
});
</syntaxhighlight></pre>
</p>
<div class="mw-parser-output"><div class="mw-parser-output">
<h3> Слои генерации </h3>
<p>Основной единицей генерации является слой. Слоев может быть несколько и каждый из них отвечает за отдельную часть генерации ландшафта: различные биомы, слой бедрока, метеориты, парящие в воздухе. Каждый слой представляет из себя json-объект следующего содержания:
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">{ 
    range: [0, 80],
    noise: {
        octaves: {
            count: 4,
            weight: 0.6,
            scale: [1, 0.4, 1]
        }
    },
                
    gradient: [[-1, 0.8], [-0.6, 0.5], [-0.2, 0.2], [0.2, 0.9], [0.6, 0.7], [1, 0.1]],
    terrain: {
        base: 1,
        cover: {
             height: 4,
             top: 2,
             block: 3
        },
    }
},</syntaxhighlight></pre>
</p>
<div class="mw-parser-output"><div class="mw-highlight mw-content-ltr" dir="ltr">Рассмотрим каждую часть кода подробнее:</div> </div> <div class="mw-parser-output">
<ul><li>range - диапазон высоты, в котором работает генерация. В данном примере ландшафт будет генерироваться на высоте 0-80 блоков. Единственный обязательный параметр. </li>
<li>noise - описание <a href="https://ru.wikipedia.org/wiki/Шум_Перлина" alt="https://ru.wikipedia.org/wiki/Шум_Перлина" title="https://ru.wikipedia.org/wiki/Шум_Перлина">шума Перлина </a>, лежащего в основе генерации Подробнее в разделе <a href="https://wiki.mineprogramming.org/index.php?title=InnerCore/Libs/Dimensions#.D0.9A.D0.B0.D1.80.D1.82.D1.8B_.D1.88.D1.83.D0.BC.D0.B0" alt="https://wiki.mineprogramming.org/index.php?title=InnerCore/Libs/Dimensions#.D0.9A.D0.B0.D1.80.D1.82.D1.8B_.D1.88.D1.83.D0.BC.D0.B0" title="https://wiki.mineprogramming.org/index.php?title=InnerCore/Libs/Dimensions#.D0.9A.D0.B0.D1.80.D1.82.D1.8B_.D1.88.D1.83.D0.BC.D0.B0">Карты шума</a>. Таких шумов может несколько, в таком случае их следует записывать в виде массива и они будут накладываться. </li>
<li>heights - сродни noise, но накладывается поверх шума. Имеет такой же формат. Используется для генерации мелких биомов (речки, горы) <div class="mceNonEditableOverlay">&#160;</div>  </li>
<li>gradient - описание функции <a href="https://ru.wikipedia.org/wiki/Градиент" alt="https://ru.wikipedia.org/wiki/Градиент" title="https://ru.wikipedia.org/wiki/Градиент">градиента </a>, которая будет применена к шуму. Отвечает за то, как примерно будет выглядеть ландшафт. Задается в виде набора точек. Между точками интерполируется (соединяется плавной кривой). </li>
<li>terrain - настройки блоков нашей генерации, могут содержать следующее: 
<ul><li>base - блок, служащий основанием для генерации. В данном случае, камень. Можно указать как id и дату (в виде массива из двух элементов либо объекта с полями id, deata), так и просто id. </li>
<li>cover - слои блоков, покрывающих генерацию сверху (в нормальной генерации мира это земля и трава). Объект cover имеет три поля: height - высота верхнего слоя, block - основной блок покрытия, top - самый верхний слой. Все блоки задаются таким же образом, как и base. </li>
<li>filling - параметры заполнения пустот в генерации чем-либо. Пример - вода в обычном мире и лава в нижнем. Объект состоит из полей height - высота, до которой будет заполнен слой, и block - непосредственно сам блок, которым производится заполнение.   </li></ul></li></ul>
</div> <div class="mceNonEditableOverlay">&#160;</div> </div> </div>
<h3> Карты шума </h3>
<p>Как уже было сказано выше, генерация поверхности происходит по принципу шума Перлина. Подробную информацию о нем можно найти <a href="https://habr.com/post/265775/" alt="https://habr.com/post/265775/" title="https://habr.com/post/265775/">здесь </a>.Каждая карта состоит из октав. Октавы - шум разного масштаба. Подробнее в той же статье.
</p><p>В библиотеке dimensions октавы для генерации (octaves) задаются двумя способами: одним объектом описания для программной генерации нескольких октав или массивом описаний отдельных октав. Начнем с первого случая, при этом поля у объекта октав будут следующие:
</p>
<ul><li>count - количество октав. Чем больше октав, тем мельче и труднопроходимее будет рельеф. Чаще всего используют 4 октавы. </li>
<li>weight -&#160;? </li>
<li>scale -&#160;? </li>
<li>mt -&#160;? </li>
<li>mw -&#160;? </li></ul>
<p>Всему шуму (не отдельным октавам) также можно задавать следующие параметры:
</p>
<ul><li>gradient - градиент для данной карты шума. </li>
<li>seed - зерно генерации (сид). </li></ul>
<div style="display: inline !important;">При создании карты шума отдельными октавами (octaves - массив), каждая октава будет иметь следующие параметры: <div class="mw-parser-output">
<ul><li>weight -? </li>
<li>offset -? </li>
<li>scale -? </li></ul>
<h3> Environment </h3>
<p>Объект environment предлагает инструменты для настройки среды, а именно цвета неба и туман. Может содержать следующие поля:
</p>
<ul><li>sky - цвет неба, задается массивом из трех составляющих RGB (от 0 до 1), каждая из которых может быть как значением, так и массивом из двух значений для более тонкой настройки цветов. </li>
<li>fog - цвет тумана, имеет аналогичный sky массив описания. </li></ul>
</div> </div> </div>
<h2> Объект Dimensions и его методы </h2>
<p>Результатом создания нового измерения будет объект Dimension. От будет использоваться для дальнейшей работы с измерением и имеет для этого следующие методы:
</p>
<ul><li>setupGeneration(description) -&#160;? </li>
<li>setupTransfer(description) -&#160;? </li>
<li>setupEnvironment(description) -&#160;? </li>
<li>setupCallbacks(callbacks) - устанавливает коллбеки в формате, описанном выше. </li>
<li>getName() - возвращает имя измерения, заданное при его создании. </li>
<li>getId() - получает уникальное id биома. </li>
<li>getWrappedObject() - получает лежащий в основе библиотеки java-объект CustomDimention. </li>
<li>getRegion() -&#160;? </li>
<li>getTeleporter() - возвращает телепортер из обічного мира в измерение. </li>
<li>getTeleporterBack() - возвращает телепортер из измерения в обычный мир. </li>
<li>getAllTeleporters() - возвращает массив из getTeleporter() и getTeleporterBack(). </li>
<li>transferTo(tp) - переносит вас в место, заданное телепортером tp. </li>
<li>transferIn() - переносит игрока в измерение. </li>
<li>transferOut() - переносит игрока из измерения. </li>
<li>isInDimension() - проверяет, находинся ли игрок в данном измерении. </li></ul>
<p>Следующие два метода слишком важны, чтобы оставить их в списке наравне с остальными, поскольку позволяют ускорить процесс отладки генерации в разы. stride в обоих случаях показывает, сколько блоков будет соответствовать одному пикселю битмапы:
</p>
<ul><li>debugTerrainMap(size, stride) - генерирует и показывает всплывающим окном при загрузке InnerCore битмапу с видом на сгенерированный ландшафт сверху размером size*size. </li>
<li>debugTerrainSlice(size, stride) - генерирует и показывает всплывающим окном при загрузке InnerCore битмапу со срезом сгенерированного ландшафтавысотой size (вид сбоку). </li></ul>
<h2> PortalRegistry </h2>
<p>Объект&#160;PortalRegistry позволяет создавать и управлять блоками порталов с их анимациями.
</p><p>Для создания нового блока порталда используется метод&#160;<i>newPortalBlock</i>. Он принимает следующие аргументы:
</p>
<ul><li>id - строковой id блока портала </li>
<li>texture - параметры текстуры в формате [name, data] </li>
<li>portal - объект типа Portal, возвращаемый метдом <i>dimension..getPortal()</i> </li>
<li>portalRenderParams - параметры рендера портала, имеет следующий формат: 
<ul><li>frameId -&#160;? </li>
<li>type - одна из следующих констант   </li></ul></li></ul>
<pre class="fck_mw_syntaxhighlight"><syntaxhighlight lang="Javascript">PortalRegistry.RENDER_TYPE_FULL = &quot;full&quot;;
PortalRegistry.RENDER_TYPE_VERTICAL_PLANE = &quot;v-plane&quot;;
PortalRegistry.RENDER_TYPE_HORIZONTAL_PLANE = &quot;h-plane&quot;;
PortalRegistry.RENDER_TYPE_UNIVERSAL_PLANE = &quot;u-plane&quot;;
</syntaxhighlight></pre></div>
</div>
@@ Строка 2: / Строка 2: @@
 <div class="mw-parser-output">
 <div class="mw-parser-output">
-<div class="mw-parser-output"><div class="mw-parser-output">
 == Загрузка ==
@@ Строка 12: / Строка 11: @@
 |-
 | '''2'''
-| [https://raw.githubusercontent.com/mineprogramming/APO_craft/d93907979d4113ec9d05da892502eee27264a848/lib/dimensions.js Скачать]
+| [https://github.com/mineprogramming/APO_craft/blob/master/lib/dimensions.js Скачать]
 | Фикс ошибки получения координат в функции генерации чанка (by IchZerowan)
 |}
-</div> </div>
 == Подключение ==