incremental-social/The-Modding-Tree
incremental-social/The-Modding-Tree
Template
1
0
Fork 0
mirror of https://github.com/Acamaeda/The-Modding-Tree.git synced 2025-05-11 20:41:10 +00:00
Code Issues Releases Activity Actions

Improved milestone completion + docs

Browse source
This commit is contained in:
Harley White 2021-06-02 16:45:05 -04:00
parent ef48c4fe48
commit b6bc8beb21
5 changed files with 9 additions and 4 deletions

4
docs/!general-info.md
View file

@ -28,8 +28,8 @@ While reading this documentation, the following key will be used when describing
### General
- [Getting Started](tutorial/getting-started.md): A guide to getting your own copy of the code set up with Github Desktop.
- [Making a Mod](tutorial/making-a-mod.md): A guide to using TMT to make a basic mod.
- [Getting Started](tutorials/getting-started.md): A guide to getting your own copy of the code set up with Github Desktop.
- [Making a Mod](tutorials/making-a-mod.md): A guide to using TMT to make a basic mod.
- [Main mod info](main-mod-info.md): How to set up general things for your mod in [mod.js](/js/mod.js).
- [Basic layer breakdown](basic-layer-breakdown.md): Breaking down the components of a layer with minimal features.
- [Layer features](layer-features.md): Explanations of all of the different properties that you can give a layer.

4
docs/milestones.md
View file

@ -23,6 +23,8 @@ Milestone features:
- done(): A function returning a boolean to determine if the milestone should be awarded.
- onComplete() - **optional**. this function will be called when the milestone is completed.
- toggles: **optional**. Creates toggle buttons that appear on the milestone when it is unlocked. The toggles can toggle a given boolean value in a layer. It is defined as an array of paired items, one pair per toggle. The first is the internal name of the layer the value being toggled is stored in, and the second is the internal name of the variable to toggle. (e.g. [["b", "auto"], ["g", "auto"])
**Tip:** Toggles are not de-set if the milestone becomes locked! In this case, you should also check if the player has the milestone.
@ -35,4 +37,4 @@ Milestone features:
- id: **assigned automagically**. It's the "key" which the milestone was stored under, for convenient access. The milestone in the example's id is 0.
Disaable milestone popups by adding `milestonePopups: false` to the layer.
Disable milestone popups by adding `milestonePopups: false` to the layer.