diff --git a/Common.lua b/Common.lua index ee409bfa..22320b19 100644 --- a/Common.lua +++ b/Common.lua @@ -1,3 +1,9 @@ +-- Path of Building +-- +-- Module: Common +-- Libaries, functions and classes used by various modules. +-- + common = { } common.curl = require("lcurl") diff --git a/Gems/act_dex.lua b/Gems/act_dex.lua index 25e2c33b..2558b8b6 100644 --- a/Gems/act_dex.lua +++ b/Gems/act_dex.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Active Dexterity skills +-- Skill gem data (c) Grinding Gear Games +-- local gems = ... gems["Animate Weapon"] = { diff --git a/Gems/act_int.lua b/Gems/act_int.lua index 37751fdb..de851b0b 100644 --- a/Gems/act_int.lua +++ b/Gems/act_int.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Active Intelligence skills +-- Skill gem data (c) Grinding Gear Games +-- local gems = ... gems["Arc"] = { diff --git a/Gems/act_str.lua b/Gems/act_str.lua index cfd9e602..7e8f4f08 100644 --- a/Gems/act_str.lua +++ b/Gems/act_str.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Active Strength skills +-- Skill gem data (c) Grinding Gear Games +-- local gems = ... gems["Abyssal Cry"] = { diff --git a/Gems/sup_dex.lua b/Gems/sup_dex.lua index 86ad0655..2482b344 100644 --- a/Gems/sup_dex.lua +++ b/Gems/sup_dex.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Dexterity support gems +-- Skill gem data (c) Grinding Gear Games +-- local gems = ... gems["Added Cold Damage"] = { diff --git a/Gems/sup_int.lua b/Gems/sup_int.lua index c3a0acf9..e8046ee3 100644 --- a/Gems/sup_int.lua +++ b/Gems/sup_int.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Intelligence support gems +-- Skill gem data (c) Grinding Gear Games +-- local gems = ... gems["Added Chaos Damage"] = { diff --git a/Gems/sup_str.lua b/Gems/sup_str.lua index acd794f9..4e591d91 100644 --- a/Gems/sup_str.lua +++ b/Gems/sup_str.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Strength support gems +-- Skill gem data (c) Grinding Gear Games +-- local gems = ... gems["Added Fire Damage"] = { diff --git a/Items/axe.lua b/Items/axe.lua index 5a0b83ba..533caae7 100644 --- a/Items/axe.lua +++ b/Items/axe.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Rusted Hatchet"] = { diff --git a/Items/body.lua b/Items/body.lua index 65e9a9e2..d7b88953 100644 --- a/Items/body.lua +++ b/Items/body.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Plate Vest"] = { diff --git a/Items/boots.lua b/Items/boots.lua index 23bc340e..ab82ca30 100644 --- a/Items/boots.lua +++ b/Items/boots.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Iron Greaves"] = { diff --git a/Items/bow.lua b/Items/bow.lua index 55695935..c97fd668 100644 --- a/Items/bow.lua +++ b/Items/bow.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Crude Bow"] = { diff --git a/Items/claw.lua b/Items/claw.lua index dac6708c..d7794b6b 100644 --- a/Items/claw.lua +++ b/Items/claw.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Nailed Fist"] = { diff --git a/Items/dagger.lua b/Items/dagger.lua index 4cac2cb2..e0a85502 100644 --- a/Items/dagger.lua +++ b/Items/dagger.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Glass Shank"] = { diff --git a/Items/glove.lua b/Items/glove.lua index 075ae7d0..f62b2374 100644 --- a/Items/glove.lua +++ b/Items/glove.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Iron Gauntlets"] = { diff --git a/Items/helm.lua b/Items/helm.lua index f3bca4ef..66df413b 100644 --- a/Items/helm.lua +++ b/Items/helm.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Iron Hat"] = { diff --git a/Items/mace.lua b/Items/mace.lua index 6c1d0b6d..ddf68cdf 100644 --- a/Items/mace.lua +++ b/Items/mace.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Driftwood Club"] = { diff --git a/Items/misc.lua b/Items/misc.lua index 94a2797e..e392daca 100644 --- a/Items/misc.lua +++ b/Items/misc.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Paua Amulet"] = { diff --git a/Items/shield.lua b/Items/shield.lua index 863c4630..da59a5ef 100644 --- a/Items/shield.lua +++ b/Items/shield.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Splintered Tower Shield"] = { diff --git a/Items/staff.lua b/Items/staff.lua index 2a35b904..406f4dbe 100644 --- a/Items/staff.lua +++ b/Items/staff.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Gnarled Branch"] = { diff --git a/Items/sword.lua b/Items/sword.lua index c9da756a..d959c60d 100644 --- a/Items/sword.lua +++ b/Items/sword.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Rusted Sword"] = { diff --git a/Items/wand.lua b/Items/wand.lua index 4894ba11..78262101 100644 --- a/Items/wand.lua +++ b/Items/wand.lua @@ -1,3 +1,4 @@ +-- Item data (c) Grinding Gear Games local itemBases = ... itemBases["Driftwood Wand"] = { diff --git a/Launch.lua b/Launch.lua index ae5d8d8b..43d8680b 100644 --- a/Launch.lua +++ b/Launch.lua @@ -1,4 +1,9 @@ #@ SimpleGraphic +-- Path of Building +-- +-- Module: Launch +-- Program entry point; runs the Main module within a protected environment +-- SetWindowTitle("PathOfBuilding") ConExecute("vid_mode 1") diff --git a/Modules/Build.lua b/Modules/Build.lua index 6df1c4ae..48dbc639 100644 --- a/Modules/Build.lua +++ b/Modules/Build.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Build +-- Loads and manages the active build. +-- local launch, cfg, main = ... local ipairs = ipairs diff --git a/Modules/List.lua b/Modules/BuildList.lua similarity index 98% rename from Modules/List.lua rename to Modules/BuildList.lua index 578dc63d..121f9da2 100644 --- a/Modules/List.lua +++ b/Modules/BuildList.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: BuildList +-- Displays the list of builds. +-- local launch, cfg, main = ... local vfs = require("vfs") diff --git a/Modules/Calcs.lua b/Modules/Calcs.lua index ce5c94d9..131a01a8 100644 --- a/Modules/Calcs.lua +++ b/Modules/Calcs.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Calcs +-- Calculations view for the active build +-- local launch, cfg, main = ... cfg.gridHeight = 18 diff --git a/Modules/CalcsControl.lua b/Modules/CalcsControl.lua index 28353e1b..40f978a9 100644 --- a/Modules/CalcsControl.lua +++ b/Modules/CalcsControl.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: CalcsControl +-- Control script for calculations +-- local grid = ... local m_abs = math.abs diff --git a/Modules/CalcsView.lua b/Modules/CalcsView.lua index 6e2982d9..6162646b 100644 --- a/Modules/CalcsView.lua +++ b/Modules/CalcsView.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: CalcsView +-- Configures the grid display in the calculations view +-- local grid = ... local s_format = string.format diff --git a/Modules/Data.lua b/Modules/Data.lua index d3762bd3..ce69d46b 100644 --- a/Modules/Data.lua +++ b/Modules/Data.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Data +-- Contains static data used by other modules +-- data = { } diff --git a/Modules/Items.lua b/Modules/Items.lua index 263447a7..0d68df9f 100644 --- a/Modules/Items.lua +++ b/Modules/Items.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Items +-- Items view for the active build +-- local launch, cfg, main = ... local t_insert = table.insert diff --git a/Modules/Main.lua b/Modules/Main.lua index c46465e3..1fa1e2ad 100644 --- a/Modules/Main.lua +++ b/Modules/Main.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Main +-- Main module of program. +-- local launch = ... local ipairs = ipairs @@ -83,7 +88,7 @@ main.SpecClass = LoadModule("Modules/Spec", launch, cfg, main) main.TreeViewClass = LoadModule("Modules/TreeView", launch, cfg, main) main.modes = { } -main.modes["LIST"] = LoadModule("Modules/List", launch, cfg, main) +main.modes["LIST"] = LoadModule("Modules/BuildList", launch, cfg, main) main.modes["BUILD"] = LoadModule("Modules/Build", launch, cfg, main) function main:SetMode(newMode, ...) diff --git a/Modules/ModParser.lua b/Modules/ModParser.lua index 303e6a73..f30a6f2a 100644 --- a/Modules/ModParser.lua +++ b/Modules/ModParser.lua @@ -1,3 +1,9 @@ +-- Path of Building +-- +-- Module: ModParser +-- Parser function for modifier names +-- + -- List of modifier forms local formList = { ["^(%d+)%% increased"] = "INC", diff --git a/Modules/ModTools.lua b/Modules/ModTools.lua index 6aa5e299..15fe8d19 100644 --- a/Modules/ModTools.lua +++ b/Modules/ModTools.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: ModTools +-- Various functions for dealing with modifier lists and databases +-- local t_insert = table.insert diff --git a/Modules/Spec.lua b/Modules/Spec.lua index 80532bae..46c45d91 100644 --- a/Modules/Spec.lua +++ b/Modules/Spec.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Spec +-- Passive tree spec class. +-- local launch, cfg, main = ... local pairs = pairs diff --git a/Modules/Tree.lua b/Modules/Tree.lua index f0fb14fd..d38c7571 100644 --- a/Modules/Tree.lua +++ b/Modules/Tree.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: Tree +-- Passive skill tree class. +-- local launch, cfg, main = ... local pairs = pairs diff --git a/Modules/TreeView.lua b/Modules/TreeView.lua index 100c5c14..86d03f79 100644 --- a/Modules/TreeView.lua +++ b/Modules/TreeView.lua @@ -1,3 +1,8 @@ +-- Path of Building +-- +-- Module: TreeView +-- Passive skill tree view for the active build +-- local launch, cfg, main = ... local pairs = pairs diff --git a/PathOfBuilding.sln b/PathOfBuilding.sln index 0eb79c40..e50cebf0 100644 --- a/PathOfBuilding.sln +++ b/PathOfBuilding.sln @@ -40,12 +40,12 @@ EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Modules", "Modules", "{35D8BE82-CD83-4C2D-AD31-47026E724F46}" ProjectSection(SolutionItems) = preProject Modules\Build.lua = Modules\Build.lua + Modules\BuildList.lua = Modules\BuildList.lua Modules\Calcs.lua = Modules\Calcs.lua Modules\CalcsControl.lua = Modules\CalcsControl.lua Modules\CalcsView.lua = Modules\CalcsView.lua Modules\Data.lua = Modules\Data.lua Modules\Items.lua = Modules\Items.lua - Modules\List.lua = Modules\List.lua Modules\Main.lua = Modules\Main.lua Modules\ModParser.lua = Modules\ModParser.lua Modules\ModTools.lua = Modules\ModTools.lua