80LK (обсуждение | вклад) м |
80LK (обсуждение | вклад) м |
||
Строка 1: | Строка 1: | ||
− | <div class="mw-parser-output"><div class="mw-parser-output">'''GuideAPI '''– мод-библиотека, предоставляющая большие возможности для создания игровых документаций.</div> <div class="mw-parser-output"><syntaxhighlight lang="JavaScript">ModAPI.addAPICallback("GuideAPI", function(api) { | + | <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) { | ||
const GuideAPI = api.GuideAPI; | const GuideAPI = api.GuideAPI; | ||
const GuideHelper = api.GuideHelper; | const GuideHelper = api.GuideHelper; | ||
Строка 39: | Строка 41: | ||
*Объект '''''textures'''''задаёт текстуры для интерфейса. Если не объявлен, будет использоваться стандартное оформление | *Объект '''''textures'''''задаёт текстуры для интерфейса. Если не объявлен, будет использоваться стандартное оформление | ||
**<u>''background''</u>'' ''– текстура заднего фона | **<u>''background''</u>'' ''– текстура заднего фона | ||
− | **<u>''nextLink''</u>''– текстура для кнопки “вперёд” | + | **<u>''nextLink''</u>''– текстура для кнопки “вперёд”'' |
**<u>''preLink''</u> – текстура для кнопки “назад” | **<u>''preLink''</u> – текстура для кнопки “назад” | ||
**''<u>сlose</u>'' – текстура для кнопки закрытия интерфейса | **''<u>сlose</u>'' – текстура для кнопки закрытия интерфейса | ||
Строка 45: | Строка 47: | ||
*Если '''debug''' объявлен и равен true, у интерфейса вызывается метод setDebugEnabled(true) | *Если '''debug''' объявлен и равен true, у интерфейса вызывается метод setDebugEnabled(true) | ||
*Объект '''pages''' содержит страницы. Каждая имеет правую'''''(right)''''' и левую'''''(left)''''' секции, для которых задаются контроллеры'''''(controller)'''''. Любую из них можно пропустить. '''''nextLink'''''содержит идентификатор страницы, на которую происходит переход при нажатии кнопки “вперёд”, '''''preLink'''''при нажатии кнопки “назад”. При открытии интерфейса происходит загрузка страницы с идентификатором '''''default'''''. | *Объект '''pages''' содержит страницы. Каждая имеет правую'''''(right)''''' и левую'''''(left)''''' секции, для которых задаются контроллеры'''''(controller)'''''. Любую из них можно пропустить. '''''nextLink'''''содержит идентификатор страницы, на которую происходит переход при нажатии кнопки “вперёд”, '''''preLink'''''при нажатии кнопки “назад”. При открытии интерфейса происходит загрузка страницы с идентификатором '''''default'''''. | ||
− | |||
<div class="mw-parser-output"> | <div class="mw-parser-output"> | ||
== Контроллеры == | == Контроллеры == | ||
Строка 52: | Строка 53: | ||
=== BASIC_PAGE === | === BASIC_PAGE === | ||
− | |||
<div class="mw-parser-output"> | <div class="mw-parser-output"> | ||
=== ITEM_PAGE === | === ITEM_PAGE === | ||
Строка 63: | Строка 63: | ||
=== Создание собственных контроллеров === | === Создание собственных контроллеров === | ||
− | </div> | + | </div> </div> </div> </div> </div> |
ModAPI.addAPICallback("GuideAPI", function(api) {
const GuideAPI = api.GuideAPI;
const GuideHelper = api.GuideHelper;
const PageControllers = api.PageControllers;
IDRegistry.genItemID("testGuide");
Item.createItem("testGuide", "Test Guide", {
name: "stick"
});
GuideAPI.registerGuide("guideTest", {
item: ItemID.testGuide,
debug: false,
textures: {
background: "your_texture",
nextLink: "your_texture",
preLink: "your_texture",
close: "your_texture",
},
pages: {
"default": {
nextLink: "test",
left: {
controller: PageControllers.BASIC_PAGE,
elements: []
},
right: {
controller: PageControllers.BASIC_PAGE,
elements: []
}
}
}
});
});
Регистрация происходит через метод GuideAPI.registerGuide(unique, params), где unique– уникальный идентификатор, params– объект с параметрами.
Параметры:
Контроллер – функция, указанная под идентификатором controllerв объекте секции. GuideAPI предоставляет стандартные контроллеры, находящиеся в объекте PageControllers, которые позволяют решить большинство задач.