properties which define the vast majority of gun attributes and may change accross instances

constants which define gun attributes and should not be changed in an instance of the gun

runtime storage of offsets generated by recoil sway wag or any other element.

string the name of the gun. Set to __template for guns which have no instances and serve as a template. It is safe to set name to the same as gun.itemstring

string the itemstring of the gun- i.e. "guns4d_pack_1:m4". Set to "" for __template guns.

ItemStack the gun itemstack. Remember to player:set_wielded_item(self.itemstack) when making meta or itemstack changes.

ObjRef the operator of the weapon. This may at some point be deprecated when I start to implement AI/mob usage

MetaDataRef itemstack meta

string the ID of the gun used for tracking of it's inventory

ObjRef the gun entity

list of registered guns, DO NOT MODIFY I really need a metatable for this class...

bool is the bolt charged

table list of particle spawner handles (generated by firing)

int the active index of the firemode from firemodes

float walking time used to generate the figure 8 for wag

float

float

float time left for the chamber to cycle (for firerates)

int number of rounds left that need to be fired after a burst fire

vec3 translation of the gun relative to the "gun" bone or the player axial rotation.

table indexed list of functions which are called when the gun's properties need to be built. This is used for things like attachments, etc.

table a list of ObjRefs that are attached to the gun as a result of attached_objects

table list of subclass instances (i.e. Sprite_scope)

vector containing the rotation offset from the current frame, this will be factored into the gun's direction if consts.ANIMATIONS_OFFSET_AIM=true

vector containing the translational/positional offset from the current frame

all offsets from gun.offset of a type added together gun in the same format as a an offset (that is, five vectors, gun_axial, player_axial, etc.). Note that if offsets are changed after update, this will not be updated automatically until the next update. update_rotations() must be called to do so.

velocities in the format of offsets, but only containing angular (gun_axial and player_axial) offsets.

table hipfire properties

table aiming ("aiming down sights") properties

table list of firemodes

table defines the guns recoil

table defines the guns idle sway

table defines the movement of the gun while walking

table defines how rounds are chambered into the gun

table defines what ammo the gun uses

table defines visual attributes of the gun

table defines sounds to be used by functions of the gun

table inventory related attributes

float starting vertical rotation of the gun

float=.5 max angular deviation (vertical) from breathing

vector the offset from the center of the muzzle flash. Used by fire()

int=600 The number of rounds (cartidges) this gun can throw per minute. Used by update(), fire() and default controls

an ordered list of reloading states used by default_controls.

the default reload states for a magazine operated weapon, copied from the m4.

Example

{action="charge", time=.5, anim="charge", sounds={sound="ar_charge", delay = .2}},
{action="unload_mag", time=.25, anim="unload", sounds = {sound="ar_mag_unload"}},
{action="store", time=.5, anim="store", sounds = {sound="ar_mag_store"}},
{action="load", time=.5, anim="load", sounds = {sound="ar_mag_load", delay = .25}},
{action="charge", time=.5, anim="charge", sounds={sound="ar_charge", delay = .2}}

table (optional) a table {x1,y1,z1, x2,y2,z2} specifying the bounding box of the model. The first 3 (x1,y1,z1) are the lower of their counterparts. This is autogenerated from the model when not present, reccomended that you leave nil.

string overlay on the item to use when infinite ammo is on

int=3 how many rounds in burst using when firemode is at "burst"

table containing a list of actions for PC users passed to Control_handler. __replace_only = true in this table, meaning if the table exists in the new definition, it will be replaced.

table containing a list of actions for touch screen users passed to Control_handler. __replace_only = true in this table, meaning if the table exists in the new definition, it will be replaced.

the size in meters to render the gun in it's inventory opened with /guns4d_inv

the image of the gun in it's inventory opened with /guns4d_inv

table of firemodes and their overlays in the player's inventory when the gun is on that firemode

string (optional) inventory image for when the gun has no magazine

string inventory image for when the gun is loaded. This is added automatically during construction as the item's wield image.

Ammo_handler the class (based on) ammo_handler to create an instance of and use. Default is Guns4d.ammo_handler

part_handler Part_handler class to use. Default is Guns4d.part_handler

Sprite_scope sprite scope class to use. Nil by default, inherit Sprite_scope for class (documentation needed, reccomended contact for help if working with it)

Dynamic_crosshair crosshair class to use. Nil by default, set to Guns4d.Dynamic_crosshair for a generic circular expanding reticle.

vector the offset of the gun relative to the eye's position at hip.

float the horizontal offset of the eye when aiming

the time it takes to go into full aim

vector the offset of the gun (relative to the right arm's default position) at hip.

the ratio that the look rotation is expressed through player_axial (rotated around the viewport) rotation as opposed to gun_axial (rotating the entity).

sway speed multiplier while at hip

sway angle multiplier while at hip

float TL:DR higher decreases recoil at expense of smoothness. 1/value is the deviation of a normalized bell curve, where x is the time since firing. this means that increasing it decreases the time it takes for the angular velocity to fully "decay".

float Correction of recoil offset per second is calculated as such: target_correction_factor[axis]*time_since_fire*recoil[axis]

float The maximum rate per second of recoil offset as determined with gun.properties.recoil.target_correction_factor

float caps the recoil velocity that can stack up from shots.

vector {x=float, y=float}, defines the initial angular velocity produced by firing the gun

vector {x=float, y=float}, ranges -1 to 1. Defines the probability of the recoil being positive or negative for any given axis.

float angular velocity multiplier when firing from the hip

float maximum angle of the sway

float angular velocity the sway

float maximum angle multiplier while the gun is at the hip

float velocity multiplier while the gun is at the hip

float=1.6 the cycle speed multiplier

float=1 decay factor when walking has stopped and offset remains.

table containing angular deviation while walking in the same format as an offset vector. Acts as a multiplier on the figure-8 generated while walking.

bool defines wether the draw animation is played on swap (when loaded). Default true.

string "none" bolt will never need to be charged after reload, "catch" when fired to empty bolt will not need to be charged after reload, "no_catch" bolt will always need to be charged after reload.

float the time it takes to swap to the gun

string name of the animation to play from visuals.animations. Default "draw"

string name of the sound to play from sounds. Default "draw"

bool wether the gun only uses a magazine or accepts raw ammunition too.

table a list of accepted bullet itemstrings

table a list of accepted magazine itemstrings

string the mag the gun starts with. Set to "empty" for no mag, otherwise it defaults to accepted_magazines[1] (if present)

name of mesh to display. Currently only supports b3d

list of textures to use.

scale multiplier. Default 1

objects that are attached to the gun. This is especially useful for attachments

Example

my_object = {
    textures = {"blank.png"},
    visual_size = {x=1,y=1,z=1},
    offset = {x=0,y=0,z=0},
    bone = "main",
    backface_culling = false,
    glow = 0
}

toggles backface culling. Default true

a table of animations. Indexes define the name of the animation to be refrenced by other functions of the gun. should be in the format {x=integer,y=integer}

Example

animations = {
    empty = {x=0,y=0}
    loaded = {x=1,y=1}
    fire = {x=10,y=20}
    draw = {x=24,y=30} --DEFAULT of charging.draw_animation.
}

There are other animations which are variable which are not listed here, these are usually defined by properties such as: reload, draw_animation

sound player when firing the weapon

frequency of keyframe samples for animation offsets and

default max hear distance when not specified

fps=60 animation fps i.e. during firing when no length is specified

bool

bool

bool

bool

bool wether the gun rotates on it's own axis instead of the player's view (i.e. ironsight misalignments)

wether animations create an offset

whether the idle animation changes or not

general gain multiplier for third persons when hearing sounds

the root bone of the gun (for animation offsets)

string="magazine",the bone of the magazine in the gun (for dropping mags)

string="right_aimpoint", the bone which the right arm aims at to

string="left_aimpoint", the bone which the left arm aims at to

table version of 4dguns this gun is made for. If left empty it will be assumed it is before 1.3.