Confirmedusers
409
edits
(Updating to match new version of source page) |
No edit summary |
||
(26 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages /> | <languages /> | ||
__FORCETOC__ | __FORCETOC__ | ||
{{GameVersion|1.19.3}} | {{GameVersion|1.19.3}} | ||
Этот руководство по '''code mod''' требует наличия среды разработки. Если у вас её еще нет, прочтите руководство по {{ll|Modding:Setting up your Development Environment|настройке среды для разработки}}. Также рекомендуется сначала прочитать про {{ll|Modding:Basic Block|Простые Блоки}} и изучить их устройство если вы не сделали этого ранее. | |||
= Создание Батута = | |||
В этом уроке мы создадим блок с более продвинутой функциональностью: Батут. | |||
В этом уроке мы создадим | |||
== Ассеты Блока == | == Ассеты Блока == | ||
Как и в случае с нашим {{ll|Modding:Basic Block|Простым Блоком}}, первое, что нам нужно - это assets блока. Создайте тип блока <code>trampoline.json</code> на основе нашего блока, созданного в предыдущем руководстве. | |||
</ | |||
В нашем файле blocktype нам нужно добавить свойство <code>class</code>. Это свойство, по сути, указывает нашему новому блоку, что он будет управляться определенным классом C#. | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
class: "trampoline", | class: "trampoline", | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Мы создадим этот класс в нашей среде разработки, чтобы придать блоку желаемую функциональность. Вы можете скачать ассеты мода [https://wiki.vintagestory.at/images/b/b9/Trampoline_-_No_CS_FILE.zip здесь]. | |||
Мы создадим этот класс, чтобы | Все, что вам нужно сделать, это поместить содержимое этого zip-файла в директорию <code>assets</code> в вашем проекте разработки. | ||
== Класс Блока == | == Класс Блока == | ||
Чтобы создать наш мод, нам понадобится несколько новых файлов <code>*.cs</code> в нашем проекте. | |||
=== Система Мода === | === Система Мода === | ||
Для того чтобы создать мод, нам нужно создать класс, который будет наследоваться от <code>ModSystem</code>. Это позволит регистрировать всевозможные вещи, но пока мы ограничимся регистрацией только нашего класса блока. | |||
Для того чтобы создать мод, | |||
<syntaxhighlight lang="c#"> | <syntaxhighlight lang="c#"> | ||
Line 49: | Line 34: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Теперь вам нужно переопределить метод <code>Start(ICoreAPI)</code> и зарегистрировать класс. | |||
Теперь вам нужно переопределить метод <code>Start(ICoreAPI)</code> и зарегистрировать класс. | |||
Функция <code>RegisterBlockClass</code> имеет два параметра: первый - идентификатор класса блока, который мы используем в json-файлах blocktype. Убедитесь, что он идентичен классу, который мы указали в нашем предыдущем файле активов. Второй параметр - это тип нашего класса блока. | |||
<syntaxhighlight lang="c#"> | <syntaxhighlight lang="c#"> | ||
Line 68: | Line 49: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Так как класса <code>TrampolineBlock</code> ещё | Так как класса <code>TrampolineBlock</code> ещё не существует, это место будет отображаться как синтаксическая ошибка. | ||
=== Класс Блока === | === Класс Блока === | ||
Давайте создадим наш класс блока, который, конечно, должен унаследовать класс <code>Block</code>: | Давайте создадим наш класс блока, который, конечно, должен унаследовать класс <code>Block</code>: | ||
</ | |||
Давайте создадим наш класс блока. При именовании скриптов блоков рекомендуется называть их в формате "{Name}Block". В случае с батутом мы назовем наш скрипт <code>TrampolineBlock.cs</code>. Любой класс блока должен наследоваться от <code>Block</code>, предоставляющий ему необходимую нам функциональность: | |||
<syntaxhighlight lang="c#"> | <syntaxhighlight lang="c#"> | ||
public class TrampolineBlock : Block | public class TrampolineBlock : Block | ||
Line 86: | Line 67: | ||
Итак, как же нам реализовать прыгучий блок? Будет не лишним взглянуть на [https://apidocs.vintagestory.at/api/Vintagestory.API.Common.Block.html документацию API], чтобы найти правильный способ. | Итак, как же нам реализовать прыгучий блок? Будет не лишним взглянуть на [https://apidocs.vintagestory.at/api/Vintagestory.API.Common.Block.html документацию API], чтобы найти правильный способ. | ||
Метод <code>void OnEntityCollide(IWorldAccessor world, Entity entity, BlockPos pos, BlockFacing facing, Vec3d collideSpeed, bool isImpact)</code> выглядит как неплохой вариант для реализации прыгучего функционала. Заметьте, что каждый блок батута размещенный в игре будет {{ll|Modding:Block_Cardinality|совместно использовать}} один и тот же экземпляр <code>TrampolineBlock</code>. Поскольку этот объект используется несколькими блоками, он не имеет поля для позиции блока. Поэтому в обработчике события присутствует параметр <code>pos</code>. | |||
Метод <code>void | |||
'''Когда объект должен отскочить?''' | '''Когда объект должен отскочить?''' | ||
# Сущность должна отскочить в тот момент, когда она приземляется на вершину блока, а не, когда она уже стоит на нем. Поэтому <code>isImpact</code> должно быть <code>true</code>. | # Сущность должна отскочить в тот момент, когда она приземляется на вершину блока, а не, когда она уже стоит на нем. Поэтому <code>isImpact</code> должно быть <code>true</code>. | ||
# | # Сущность должна сталкиваться вертикально. Стороны блока не должны отталкивать сущность. Таким образом, осью стороны <code>axis</code> <code>facing</code> должна быть <code>Y</code>. | ||
'''Как мы можем заставить объект подпрыгивать?''' | '''Как мы можем заставить объект подпрыгивать?''' | ||
Чтобы заставить объект подпрыгнуть, нам нужно изменить его направление. Поэтому мы можем просто изменить направление его движения. Чем быстрее сущность будет двигаться во время столкновения, тем дальше она будет отброшена. Но простое изменение направления движения не будет идеальным. Сущность никогда не потеряет своего движения и будет бесконечно отскакивать. Поэтому давайте сделаем что-нибудь, что заставит сущность терять 20% своего движения при каждом отскоке: | |||
<syntaxhighlight lang="c#"> | <syntaxhighlight lang="c#"> | ||
entity.Pos.Motion.Y *= -0.8; | entity.Pos.Motion.Y *= -0.8; | ||
Line 187: | Line 159: | ||
== Распространение == | == Распространение == | ||
=== Использование нового шаблона мода === | |||
Если вы используете шаблон мода, следуйте инструкциям [[Modding:Setting up your Development Environment#Packaging the Mod|Настройка среды разработки]], чтобы упаковать ваш мод для дальнейшего распространения. | |||
=== Использование Modtools (старый способ) === | |||
Если вы используете программу modtools, откройте её и введите <code>pack <your mod id></code>. Теперь вы можете взять zip-файл и поделиться им с другими людьми. Он будет работать так же, как и обычные моды, вы можете установить его, скопировав в папку <code>mods</code>. | |||
= Скачать Мод = | = Скачать Мод = | ||
Варианты мода из этого руководства: | |||
* для версии 1.9: [https://wiki.vintagestory.at/images/2/24/Trampoline_vs1.9_v1.0.0.zip Trampoline_vs1.9_v1.0.0.zip] | * для версии 1.9: [https://wiki.vintagestory.at/images/2/24/Trampoline_vs1.9_v1.0.0.zip Trampoline_vs1.9_v1.0.0.zip] | ||
* для версии 1.5: [https://wiki.vintagestory.at/images/c/ce/Trampoline.zip Trampoline.zip] | * для версии 1.5: [https://wiki.vintagestory.at/images/c/ce/Trampoline.zip Trampoline.zip] | ||
Line 204: | Line 173: | ||
= Дальнейшие Шаги = | = Дальнейшие Шаги = | ||
Теперь, когда вы успешно создали функциональный блок, вы можете пойти еще дальше, научившись использовать '''[[Modding:Block Entity| Сущность Блоков]]''' и создавать собственные '''[[Modding:Adding Block Behavior | Поведения Блоков]]'''. Оба эти руководства научат вас добавлять еще больше механики в ваши пользовательские блоки. | |||
Теперь, когда вы успешно создали функциональный блок, вы можете пойти еще дальше, научившись использовать '''[[ | |||
Или вы можете попробовать создать '''[[Modding:Advanced Items | Или вы можете попробовать создать '''[[Modding:Advanced Items | Функциональный Предмет]]''', если вы еще этого не сделали. | ||
{{Navbox/modding|Vintage Story}} | {{Navbox/modding|Vintage Story}} |