worked on documentation. Switching to new branch for major documentation changes
This commit is contained in:
parent
af970be519
commit
9d3f1ea12f
@ -1,148 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>4dguns documentation</title>
|
||||
<link rel="stylesheet" href="../ldoc_new.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>4dguns</h1>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>Gun</strong></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/item_entities.lua.html">item_entities.lua</a></li>
|
||||
<li><a href="../scripts/misc_helpers.html">misc_helpers</a></li>
|
||||
<li><a href="../scripts/play_sound.html">play_sound</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="../topics/readme.md.html">readme</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>Gun</code></h1>
|
||||
<p>Gun class
|
||||
this is the system used to represent guns and their attributes directly.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#properties">properties</a></td>
|
||||
<td class="summary">properties</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "properties"></a>
|
||||
<strong>properties</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
properties
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">infinite_inventory_overlay</span>
|
||||
defines the filename to to be used as the overlay on the item when the player has infinite ammo.
|
||||
</li>
|
||||
<li><span class="parameter">breathing_scale</span>
|
||||
the max angluler offset caused by breathing.
|
||||
</li>
|
||||
<li><span class="parameter">flash_offset</span>
|
||||
used by fire() (for fsx and ray start pos) [RENAME NEEDED]
|
||||
</li>
|
||||
<li><span class="parameter">firerateRPM</span>
|
||||
used by update() and by extent fire() + default controls. The firerate of the gun. Rounds per minute
|
||||
</li>
|
||||
<li><span class="parameter">burst</span>
|
||||
how many rounds in burst using when firemode is at "burst"
|
||||
</li>
|
||||
<li><span class="parameter">ammo_handler</span>
|
||||
absurd. @table hip @field I can't believe i'm doing this
|
||||
</li>
|
||||
<li><span class="parameter">hip</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">sway_vel_mul</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">sway_angle_mul</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
@ -1,112 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>4dguns documentation</title>
|
||||
<link rel="stylesheet" href="../ldoc_new.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>4dguns</h1>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>misc_helper</strong></li>
|
||||
<li><a href="../scripts/play_sound.html">play_sound</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="../topics/readme.md.html">readme</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Script <code>misc_helper</code></h1>
|
||||
<p>misc.</p>
|
||||
<p> common tools for 4dguns</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Guns4d.math.weighted_randoms">Guns4d.math.weighted_randoms (tbl)</a></td>
|
||||
<td class="summary">picks a random index, with odds based on it's value.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Guns4d.math.weighted_randoms"></a>
|
||||
<strong>Guns4d.math.weighted_randoms (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
picks a random index, with odds based on it's value. Returns the index of the selected.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
|
||||
<p> a table containing weights, example</p>
|
||||
<pre><code> {
|
||||
["sound"] = 999, --999 in 1000 chance this plays
|
||||
["rare_sound"] = 1 --1 in 1000 chance this plays
|
||||
}
|
||||
</code></pre>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-01-16 17:04:01 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
@ -1,6 +1,5 @@
|
||||
--- Gun class
|
||||
-- this is the system used to represent guns and their attributes directly.
|
||||
-- @module Gun
|
||||
-- @classmod Gun
|
||||
|
||||
local Vec = vector
|
||||
local gun_default = {
|
||||
@ -11,13 +10,18 @@ local gun_default = {
|
||||
registered = {},
|
||||
property_modifiers = {},
|
||||
|
||||
--ldoc will fuck this up, so fields are handled by external post-generation script.
|
||||
|
||||
--- properties
|
||||
-- the table containing every attribute of the gun.
|
||||
-- @table properties
|
||||
properties = {
|
||||
infinite_inventory_overlay = "inventory_overlay_inf_ammo.png", -- defines the filename to to be used as the overlay on the item when the player has infinite ammo.
|
||||
breathing_scale = .5, -- the max angluler offset caused by breathing.
|
||||
flash_offset = Vec.new(), -- used by fire() (for fsx and ray start pos) [RENAME NEEDED]
|
||||
firerateRPM = 600, -- used by update() and by extent fire() + default controls. The firerate of the gun. Rounds per minute
|
||||
burst = 3, -- how many rounds in burst using when firemode is at "burst"
|
||||
--%start "properties"
|
||||
infinite_inventory_overlay = "inventory_overlay_inf_ammo.png",
|
||||
breathing_scale = .5, --the max angluler offset caused by breathing.
|
||||
flash_offset = Vec.new(), --used by fire() (for fsx and ray start pos) [RENAME NEEDED]
|
||||
firerateRPM = 600, --used by update() and by extent fire() + default controls. The firerate of the gun. Rounds per minute
|
||||
burst = 3, --how many rounds in burst using when firemode is at "burst"
|
||||
ammo_handler = Ammo_handler,
|
||||
item = {
|
||||
collisionbox = ((not Guns4d.config.realistic_items) and {-.1,-.1,-.1, .1,.1,.1}) or {-.1,-.05,-.1, .1,.15,.1},
|
||||
@ -215,6 +219,7 @@ local gun_default = {
|
||||
--inventory_image_empty
|
||||
--used by ammo_handler
|
||||
},
|
||||
--- offsets
|
||||
offsets = {
|
||||
recoil = {
|
||||
gun_axial = Vec.new(),
|
||||
@ -480,7 +485,7 @@ function gun_default:update_look_rotation(dt)
|
||||
local player_rot = self.player_rotation
|
||||
player_rot.y = -handler.look_rotation.y
|
||||
local rot_factor = Guns4d.config.vertical_rotation_factor*dt
|
||||
rot_factor = rot_factor*(.5*(1+handler.ads_location))
|
||||
rot_factor = rot_factor
|
||||
local next_vert_aim = ((player_rot.x-look_rotation.x)/(1+rot_factor))+look_rotation.x --difference divided by a value and then added back to the original
|
||||
if math.abs(look_rotation.x-next_vert_aim) > .005 then
|
||||
player_rot.x = next_vert_aim
|
||||
@ -490,11 +495,18 @@ function gun_default:update_look_rotation(dt)
|
||||
|
||||
if not handler.control_handler.ads then
|
||||
local pitch = self.total_offset_rotation.player_axial.x+player_rot.x
|
||||
self.offsets.look_snap.gun_axial.x = (pitch*(1-self.consts.HIP_ROTATION_RATIO))+(handler.look_rotation.x-player_rot.x)
|
||||
local gun_axial = self.offsets.look_snap.gun_axial
|
||||
local offset = handler.look_rotation.x-player_rot.x
|
||||
gun_axial.x = Guns4d.math.clamp(offset, 0, 15*(offset/math.abs(offset)))
|
||||
gun_axial.x = gun_axial.x+(pitch*(1-self.consts.HIP_ROTATION_RATIO))
|
||||
self.offsets.look_snap.player_axial.x = -pitch*(1-self.consts.HIP_ROTATION_RATIO)
|
||||
else
|
||||
self.offsets.look_snap.gun_axial.x = 0
|
||||
self.offsets.look_snap.player_axial.x = 0
|
||||
--quick little experiment...
|
||||
--[[local pitch = self.total_offset_rotation.player_axial.x+player_rot.x
|
||||
self.offsets.look_snap.gun_axial.x = handler.look_rotation.x-player_rot.x
|
||||
self.offsets.look_snap.player_axial.x = 0]]
|
||||
end
|
||||
end
|
||||
--============================================== positional info =====================================
|
||||
|
@ -6,6 +6,6 @@ backtick_references=false
|
||||
file = {
|
||||
"../",
|
||||
}
|
||||
dir='../autogen_docs'
|
||||
dir='./outputted documentation'
|
||||
readme='../README.md'
|
||||
style='!new'
|
||||
style='!new'
|
3
docs/guns4d_doc_gen/config.guns4d
Normal file
3
docs/guns4d_doc_gen/config.guns4d
Normal file
@ -0,0 +1,3 @@
|
||||
guns4d_classes = {
|
||||
"Gun"
|
||||
}
|
50
docs/guns4d_doc_gen/init.lua
Normal file
50
docs/guns4d_doc_gen/init.lua
Normal file
@ -0,0 +1,50 @@
|
||||
local config = {}
|
||||
local ld_chunk = assert(loadfile("./config.ld"))
|
||||
setfenv(ld_chunk, config)
|
||||
ld_chunk()
|
||||
local guns4d_chunk = assert(loadfile("./config.guns4d"))
|
||||
setfenv(guns4d_chunk, config)
|
||||
guns4d_chunk()
|
||||
|
||||
|
||||
function trim_leading_space(line)
|
||||
local white_space = 0
|
||||
while string.sub(line, 1, 1) == " " do
|
||||
line = string.sub(line, 2)
|
||||
white_space = white_space+1
|
||||
end
|
||||
return line, white_space
|
||||
end
|
||||
--there should be
|
||||
function generate_field_hyperlink_string(name)
|
||||
return "<a name = \""..name.."\"></a>"
|
||||
end
|
||||
|
||||
local field_tag = "<h3>Fields:</h3>"
|
||||
for _, class in pairs(config.guns4d_classes) do
|
||||
|
||||
--read the file, break down into a modifiable structure.
|
||||
local fp = config.dir.."/classes/"..class..".html"
|
||||
local file_stream = io.open(fp, "r")
|
||||
assert(file_stream, "file not found while generating class docs, check class '"..class.."' is tagged as an @class")
|
||||
local line = 0
|
||||
local file = {}
|
||||
for line_text in file_stream:lines("*a") do
|
||||
line=line+1
|
||||
file[line]=line_text
|
||||
end
|
||||
|
||||
--find fields and their associated class (with their hyperlink)
|
||||
for i, text in pairs(file) do
|
||||
--print(i,text)
|
||||
local trm_text, indent = trim_leading_space(text)
|
||||
if trm_text==field_tag then
|
||||
local line = i
|
||||
while
|
||||
|
||||
do
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
@ -44,6 +44,7 @@
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
@ -62,8 +63,7 @@
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>Gun</code></h1>
|
||||
<p>Gun class
|
||||
this is the system used to represent guns and their attributes directly.</p>
|
||||
<p>Gun class</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
@ -73,7 +73,12 @@
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#gun.properties">gun.properties</a></td>
|
||||
<td class="summary">properties</td>
|
||||
<td class="summary">properties
|
||||
the table containing every attribute of the gun.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#gun.offsets">gun.offsets</a></td>
|
||||
<td class="summary">offsets</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@ -90,6 +95,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
properties
|
||||
the table containing every attribute of the gun.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
@ -110,22 +116,64 @@
|
||||
how many rounds in burst using when firemode is at "burst"
|
||||
</li>
|
||||
<li><span class="parameter">ammo_handler</span>
|
||||
absurd. @table hip @field I can't believe i'm doing this
|
||||
</li>
|
||||
<li><span class="parameter">hip</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">sway_vel_mul</span>
|
||||
<li><span class="parameter">item</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">sway_angle_mul</span>
|
||||
<li><span class="parameter">-</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">-</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">.</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">.</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">.</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "gun.offsets"></a>
|
||||
<strong>gun.offsets</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
offsets
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">recoil</span>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">player_axial</span>
|
||||
move<em>dynamic</em>crosshair = false, this would make the dynamic crosshair move instead of get larger
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@ -141,7 +189,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:40:54 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -40,11 +40,12 @@
|
||||
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><strong>Instantiatable_class</strong></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Gun.html">Gun</a></li>
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
@ -194,7 +195,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -32,7 +32,7 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="modules/Gun.html">Gun</a></li>
|
||||
<li><a href="modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
@ -43,6 +43,7 @@
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="classes/Gun.html">Gun</a></li>
|
||||
<li><a href="classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
@ -60,9 +61,10 @@
|
||||
<h2>Modules</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/Gun.html">Gun</a></td>
|
||||
<td class="summary">Gun class
|
||||
this is the system used to represent guns and their attributes directly.</td>
|
||||
<td class="name" nowrap><a href="modules/classes.player_model_handler.html">classes.player_model_handler</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/default_controls.html">default_controls</a></td>
|
||||
@ -86,6 +88,10 @@
|
||||
</table>
|
||||
<h2>Classes</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/Gun.html">Gun</a></td>
|
||||
<td class="summary">Gun class</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="classes/Instantiatable_class.html">Instantiatable_class</a></td>
|
||||
<td class="summary">Instantiatable_class.</td>
|
||||
@ -103,7 +109,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -35,12 +35,20 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>misc_helpers</strong></li>
|
||||
<li><strong>classes.player_model_handler</strong></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/item_entities.lua.html">item_entities.lua</a></li>
|
||||
<li><a href="../scripts/misc_helpers.html">misc_helpers</a></li>
|
||||
<li><a href="../scripts/play_sound.html">play_sound</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="../topics/readme.md.html">readme</a></li>
|
||||
@ -50,9 +58,13 @@
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>misc_helpers</code></h1>
|
||||
<p>picks a random index, with odds based on it's value.</p>
|
||||
<p> Returns the index of the selected.</p>
|
||||
<h1>Module <code>classes.player_model_handler</code></h1>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
@ -66,7 +78,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-01-16 17:00:50 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -35,7 +35,7 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Gun.html">Gun</a></li>
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><strong>default_controls</strong></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
@ -46,6 +46,7 @@
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
@ -75,7 +76,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -46,11 +46,12 @@
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Gun.html">Gun</a></li>
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
@ -165,7 +166,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -45,11 +45,12 @@
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Gun.html">Gun</a></li>
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
@ -118,7 +119,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -46,11 +46,12 @@
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Gun.html">Gun</a></li>
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
<h2>Topics</h2>
|
||||
@ -173,11 +174,23 @@
|
||||
a <a href="../scripts/misc_helpers.html#weighted_randoms"> weighted_randoms table</a> for randomly selecting sounds. The output will overwrite the <code>sound</code> field.
|
||||
</li>
|
||||
<li><span class="parameter">to_player</span>
|
||||
4dguns changes <code>to_player</code> so it only plays positionless audio (as it is only intended for first person audio)
|
||||
4dguns changes <code>to_player</code> so it only plays positionless audio (as it is only intended for first person audio). If set to string "from_player" and player present
|
||||
</li>
|
||||
<li><span class="parameter">player</span>
|
||||
this is so to<em>player being set to "from</em>player". It's to be set to the player which fired the weapon.
|
||||
</li>
|
||||
<li><span class="parameter">delay</span>
|
||||
delay the playing of the sound
|
||||
</li>
|
||||
<li><span class="parameter">attenuation_rate</span>
|
||||
float the rate of dropoff for a sound. I figure this is a bit more intuitive then jacking the gain up super high for every sound... Set the default in config.
|
||||
</li>
|
||||
<li><span class="parameter">split_audio_by_perspective</span>
|
||||
true [GUN CLASS SPECIFIC] tells the gun wether to split into third and first person (positionless) audio and adjust gain.
|
||||
</li>
|
||||
<li><span class="parameter">third_person_gain_multiplier</span>
|
||||
float [GUN CLASS SPECIFIC] replaces the constant/config value "third<em>person</em>gain<em>multiplier/THIRD</em>PERSON<em>GAIN</em>MULTIPLIER".
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -192,7 +205,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -39,7 +39,7 @@
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/Gun.html">Gun</a></li>
|
||||
<li><a href="../modules/classes.player_model_handler.html">classes.player_model_handler</a></li>
|
||||
<li><a href="../modules/default_controls.html">default_controls</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
@ -50,6 +50,7 @@
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Gun.html">Gun</a></li>
|
||||
<li><a href="../classes/Instantiatable_class.html">Instantiatable_class</a></li>
|
||||
</ul>
|
||||
|
||||
@ -66,7 +67,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
|
||||
<i style="float:right;">Last updated 2024-03-28 12:47:10 </i>
|
||||
<i style="float:right;">Last updated 2024-06-18 17:20:58 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
@ -1,3 +1,3 @@
|
||||
# literally just so I dont have to open powershell every time.
|
||||
@echo off
|
||||
ldoc .
|
||||
ldoc ./
|
Loading…
x
Reference in New Issue
Block a user