major recoil changes (wrong branch...), documented properties

ammo_api.lua

@@ -205,7 +205,7 @@ function Guns4d.ammo.magazine(magname)
 end
 
 function Guns4d.ammo.magazine_of_gun(gunname, full, string)
-    local gprops = Guns4d.gun.registered[gunname].properties
+    local gprops = Guns4d.gun._registered[gunname].properties
     local magname = gprops.ammo.accepted_magazines[1]
     assert(magname, "magazines are not accepted")
     local mag = ItemStack(magname)

classes/Ammo_handler.lua

@@ -28,8 +28,10 @@ Ammo_handler = Instantiatable_class:inherit({
                     meta:set_int("guns4d_spawn_with_ammo", 0)
                     def:update_meta()
                 else
+                    --create or reinitialize ammo data
                     if meta:get_string("guns4d_loaded_bullets") == "" then
-                        def.ammo.loaded_mag = gun.properties.ammo.initial_mag or "empty"
+                        local ammo_props = gun.properties.ammo
+                        def.ammo.loaded_mag = ammo_props.initial_mag or (ammo_props.accepted_magazines and ammo_props.accepted_magazines[1]) or "empty"
                         def.ammo.next_bullet = "empty"
                         def.ammo.total_bullets = 0
                         def.ammo.loaded_bullets = {}

classes/Instantiatable_class.lua

@@ -1,5 +1,5 @@
---- Instantiatable_class. The system for defining classes in 4dguns. Please note the capital "I", Ldoc converts it to a lowercase in all of this file
--- @classmod Instantiatable_class
+--- The system for defining classes in 4dguns. Please note the capital "I", Ldoc converts it to a lowercase in all of this file
+-- @class Instantiatable_class
 
 Instantiatable_class = {
     instance = false,

classes/Player_handler.lua

@@ -173,7 +173,7 @@ end
 function player_handler:is_holding_gun()
     assert(self.instance, "attempt to call object method on a class")
     if self.wielded_item then
-        for name, obj in pairs(Guns4d.gun.registered) do
+        for name, obj in pairs(Guns4d.gun._registered) do
             if obj.itemstring == self.wielded_item:get_name() then
                 return obj
             end

classes/gun_construct.lua

@@ -157,9 +157,9 @@ local function initialize_b3d_animation_data(self, props)
     }
     --print(table.tostring(self.b3d_model))
     --precalculate keyframe "samples" for intepolation.
-    local left = mtul.b3d_nodes.get_node_by_name(self.b3d_model, props.visuals.arm_left, true)
-    local right = mtul.b3d_nodes.get_node_by_name(self.b3d_model, props.visuals.arm_right, true)
-    local main = mtul.b3d_nodes.get_node_by_name(self.b3d_model, props.visuals.root, true)
+    local left = mtul.b3d_nodes.get_node_by_name(self.b3d_model, self.consts.ARM_LEFT_BONE, true)
+    local right = mtul.b3d_nodes.get_node_by_name(self.b3d_model, self.consts.ARM_RIGHT_BONE, true)
+    local main = mtul.b3d_nodes.get_node_by_name(self.b3d_model, self.consts.ROOT_BONE, true)
     --we add 2 because we have to add 1 for the loop to make it there if it's a float val, and MTUL uses a system where frame 0 is 1
     for target_frame = 0, self.b3d_model.node.animation.frames+1, self.consts.KEYFRAME_SAMPLE_PRECISION do
         --we need to check that the bone exists first.
@@ -261,6 +261,7 @@ function gun_default:construct_base_class()
     self.consts = Guns4d.table.fill(self.parent_class.consts, self.consts or {})
     props = self.properties
     validate_controls(props)
+    assert((self.properties.recoil.velocity_correction_factor.gun_axial>=1) and (self.properties.recoil.velocity_correction_factor.player_axial>=1), "velocity correction must not be less than one.")
 
     initialize_b3d_animation_data(self, props) --this is for animation offsets (like the spritescope uses)
 
@@ -278,6 +279,6 @@ function gun_default:construct_base_class()
         self.accepted_magazines[v] = true
     end
 
-    Guns4d.gun.registered[self.name] = self --add gun self to the registered table
+    Guns4d.gun._registered[self.name] = self --add gun self to the registered table
     register_visual_entity(self, props)  --register the visual entity
 end

docs/luadox/luadox.conf

@@ -0,0 +1,28 @@
+[project]
+# Project name that is displayed on the top bar of each page
+name = Guns4d | The ultimate 3d gun mod.
+# HTML title that is appended to every page. If not defined, name is used.
+title = Guns4d
+# A list of files or directories for LuaDox to parse.  Globs are supported.
+# This can be spread across multiple lines if you want, as long as the
+# other lines are indented.
+files = ../../*.lua
+    ../../classes/*.lua
+# The directory containing the rendered output files, which will be created
+# if necessary.
+outdir = ../out
+# Path to a custom css file that will be included on every page.  This will
+# be copied into the outdir.
+# css = custom.css
+# Path to a custom favicon. This will be copied into the outdir.
+# favicon = img/favicon.png
+# If require()d files discovered in source should also be parsed.
+follow = true
+
+[manual]
+# Custom manual pages in the form: id = filename.
+#
+# The ids must not conflict with any class or module name otherwise references
+# will not properly resolve.
+# index = intro.md
+# tutorial = tut.md

docs/luadox/run.bat

@@ -0,0 +1,4 @@
+::literally just so I dont have to open powershell every time. 
+::python 3.8+ required.
+@echo off
+python ./luadox -c ./luadox.conf