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-12-17 19:31:42 +00:00
Code Issues Releases Activity Actions
The-Modding-Tree/docs/trees-and-tree-customization.md
Harley White 3a7cd62bcc Moved tutorials, added startNavTab
2021-05-27 00:54:58 -04:00

3 KiB
Raw Blame History

Trees and tree customization

If you want to have something beyond the standard tree on the left tab, you can do that in tree.js. You can change the layout of the tree, including making non-layer nodes, change it into something other than a tree, or hide the left tab altogether. This also introduces the "tree" component, which can be used in your layers as well.

layoutInfo

The most important part is layoutInfo, containing:

  • startTab: The id of the default tab to show on the right at the start.

  • startNavTab: The id of the default tab to show on the left at the start.

  • showTree: True if the tree tab should be shown at the start of the game. (The other tab will fill the whole page)

  • treeLayout: If present, overrides the tree layout and places nodes as you describe instead (explained in the next section).

Additionally, if you want the main layout to not be a tree, you can edit the "tree-tab" layer at the bottom of tree.js to modify it just like a normal layer's tab. You can even switch between left tabs, using showNavTab(layer) to make that layer appear on the left.

Trees

The tree component is defined as an array of arrays of names of layers or nodes to show in the tree. They work just like layers/ nodes in the main tree (but branches between nodes will only work on the first node if you have duplicates.)

Here is an example tree:

[["p"],
 ["left", "blank", "right", "blank"]
 ["a", "b", "blank", "c", "weirdButton"]]

Nodes

Nodes are non-layer buttons that can go in trees. They are defined similarly to layers, but with addNode instead of addLayer.

Features:

  • color: optional, The node's color. (A string in hex format with a #)

  • symbol: optional The text on the button (The id capitalized by default)

  • canClick(): Returns true if the player can click the node. ()

  • onClick(): The function called when the node is clicked.

  • layerShown(): optional, A function returning a bool which determines if this node should be visible. It can also return "ghost", which will hide the layer, but its node will still take up space in its tree.

  • branches: optional. An array of layer/node ids. On a tree, a line will appear from this node to all of the nodes in the list. Alternatively, an entry in the array can be a 2-element array consisting of the id and a color value. The color value can either be a string with a hex color code, or a number from 1-3 (theme-affected colors).

  • nodeStyle: optional. A CSS object, where the keys are CSS attributes, which styles this node on the tree.

  • tooltip() / tooltipLocked(): optional. Functions that return text, which is the tooltip for the node when the layer is unlocked or locked, respectively. By default the tooltips behave the same as in the original Prestige Tree.

  • row: optional, the row that this node appears in (for the default tree).

  • position: optional, Determines the horizontal position of the layer in its row in a default tree. By default, it uses the id, and layers/nodes are sorted in alphabetical order.