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 2024-11-21 16:13:55 +00:00
Code Issues Releases Activity Actions

Fixed documentation

Browse source
This commit is contained in:
Acamaeda 2020-10-01 01:45:05 -04:00
parent fa5dbbf0b5
commit 2f588b5215
4 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/basic-layer-breakdown.md
View file

@ -2,7 +2,7 @@
This is a very minimal layer with minimal features. Most things will require additional features: This is a very minimal layer with minimal features. Most things will require additional features:
``p: { p: {
startData() { return { // startData is a function that returns default data for a layer. startData() { return { // startData is a function that returns default data for a layer.
unl: false, // You can add more variables here to add them to your layer. unl: false, // You can add more variables here to add them to your layer.
points: new Decimal(0), // "points" is the internal name for the main resource of the layer. points: new Decimal(0), // "points" is the internal name for the main resource of the layer.
@ -30,4 +30,4 @@ This is a very minimal layer with minimal features. Most things will require add
}, },
layerShown() {return true}, // Returns a bool for if this layer's node should be visible in the tree. layerShown() {return true}, // Returns a bool for if this layer's node should be visible in the tree.
}, `` },

20
docs/buyables.md
View file

@ -5,18 +5,18 @@ the player can reset the purchases to get their currency back.
Buyables should be formatted like this: Buyables should be formatted like this:
``buyables: { buyables: {
rows: # of rows rows: # of rows
cols: # of columns cols: # of columns
respec() {}, **optional**, implement it to reset things and give back your currency. respec() {}, **optional**, implement it to reset things and give back your currency.
Having this function makes a respec button appear Having this function makes a respec button appear
respecText: **optional**, text that appears on the respec button respecText: **optional**, text that appears on the respec button
11: { 11: {
desc: "Blah", desc: "Blah",
etc
}
etc etc
} }
etc
}``
Features: Features:

14
docs/challenges.md
View file

@ -2,15 +2,15 @@
Challenges are stored in the following format: Challenges are stored in the following format:
``challs: { challs: {
rows: # of rows rows: # of rows
cols: # of columns cols: # of columns
11: { 11: {
name: "Ouch", name: "Ouch",
etc
}
etc etc
} }
etc
}``
You can use inChall(layer, id) and hasChall(layer, id) to determine if the player is currently in a challenge, You can use inChall(layer, id) and hasChall(layer, id) to determine if the player is currently in a challenge,
or has completed the challenge, respectively. These are useful for implementing effects. or has completed the challenge, respectively. These are useful for implementing effects.

4
docs/custom-tab-layouts.md
View file

@ -2,7 +2,7 @@
Custom tab layouts can be used to do basically anything in a tab window, especially combined with the "style" layer feature. The tabFormat feature is an array of things, like this: Custom tab layouts can be used to do basically anything in a tab window, especially combined with the "style" layer feature. The tabFormat feature is an array of things, like this:
``
tabFormat: ["main-display", tabFormat: ["main-display",
["prestige-button", function(){return "Melt your points into "}], ["prestige-button", function(){return "Melt your points into "}],
["raw-html", function() {return "<button onclick='console.log(`yeet`)'>'HI'</button>"}], ["raw-html", function() {return "<button onclick='console.log(`yeet`)'>'HI'</button>"}],
@ -11,7 +11,7 @@ Custom tab layouts can be used to do basically anything in a tab window, especia
{"color": "red", "font-size": "32px", "font-family": "Comic Sans MS"}], {"color": "red", "font-size": "32px", "font-family": "Comic Sans MS"}],
"blank", "blank",
["toggle", ["c", "beep"]], ["toggle", ["c", "beep"]],
"milestones", "blank", "blank", "upgrades"] `` "milestones", "blank", "blank", "upgrades"]
It is a list of components, which can be either just a name, or an array with arguments. If it's an array, the first item is the name of the component, the second is the data passed into it, and the third (optional) is a CSS object, It is a list of components, which can be either just a name, or an array with arguments. If it's an array, the first item is the name of the component, the second is the data passed into it, and the third (optional) is a CSS object,
which applies its style to the component. which applies its style to the component.