gun
/obj/item/gun

Vars
accuracy	Gun accuracy (without distance accuracy)
attachable_allowed	List of allowed attachments, IT MUST INCLUDE THE STARTING ATTACHMENT TYPES OR THEY WILL NOT ATTACH.
attachable_offset	List of offsets to make attachment overlays not look wonky.
attachment_overlays	Image list of attachments overlays.
attachments_by_slot	List of slots a gun can have.
autoburst_delay	when autobursting, this is the total amount of time before the weapon fires again. If no amount is specified, defaults to fire_delay + extra_delay
burst_amount	How many shots can the weapon shoot in burst? Anything less than 2 and you cannot toggle burst.
burst_delay	The delay in between shots. Lower = less delay = faster.
damage_mod	Damage modifier for projectile
dual_wield	If this gun is in inactive hands and shooting in akimbo
extra_delay	When burst-firing, this number is extra time before the weapon can fire again. Depends on number of rounds fired.
fire_cd	Firing cooldown, true if this gun shouldn't be allowed to manually fire
gun_crosshair	Crosshair icon of the gun
gun_firemode	Current selected firemode of the gun.
gun_firemode_list	List of allowed firemodes.
gun_light	Currently attached flashlight.
gun_user	The mob holding the gun
last_fired	World.time of last gun firing.
on_rack	Guns can be placed on racks
pb_cooldown_duration	Point blank shot cooldown
pb_knockback	Responsible for the range of the throwing back when shooting at point blank range
shots_counter	Shots counter
shots_fired	How many bullets the gun fired while bursting/auto firing
stamina_mod	Stamina modifier for projectile
starting_attachment_types	The attachments this gun starts with on Init
target	The atom targeted by the user
unique_rename	Allows renaming with a pen
windup_autofire	windup autofire vars Whether the delay between shots increases over time, simulating a spooling weapon
windup_autofire_cap	How high of a reduction that current_windup_reduction can reach
windup_autofire_reduction_multiplier	the percentage of autfire_shot_delay that is added to current_windup_reduction
windup_spindown	How long it takes for weapons that have spooled-up to reset back to the original firing speed
Procs
ZoomGrantCheck	Proc which will be called when the gun receives the `COMSIG_ITEM_EQUIPPED` signal.
change_target	Update the target if you draged your mouse
clean_gun_user	Null out gun user to prevent hard del
clean_target	Set the target to it's turf, so we keep shooting even when it was qdeled
do_recoil	animate recoil for gun
do_semiauto_fire	Single-shot fire path, runs process_fire and resets state on success.
gun_on_cooldown	Checks if the gun is on cooldown
reset_fire	Clean all references
set_bursting	Inform the gun if he is currently bursting, to prevent reloading
set_gun_light	Sets gun's flashlight and do all the necessary updates
set_gun_user	Set the user in argument as gun_user
set_target	Set the target and take care of hard delete
setup_bullet_accuracy	Sets the projectile accuracy and scatter
start_fire	Check if the gun can fire and add it to bucket auto_fire system if needed, or just fire the gun if not
stop_fire	Reset variables used in firing and remove the gun from the autofire system
update_mouse_pointer	Updates the current mouse pointer to use the gun crosshair or not

Var Details

var
accuracy
– /datum/gun_accuracy

Gun accuracy (without distance accuracy)

var
attachable_allowed

List of allowed attachments, IT MUST INCLUDE THE STARTING ATTACHMENT TYPES OR THEY WILL NOT ATTACH.

var
attachable_offset
– /list

List of offsets to make attachment overlays not look wonky.

var
attachment_overlays
– /list/image

Image list of attachments overlays.

var
attachments_by_slot
– /list/obj/item/gun_module

List of slots a gun can have.

var
autoburst_delay

when autobursting, this is the total amount of time before the weapon fires again. If no amount is specified, defaults to fire_delay + extra_delay

var
burst_amount

How many shots can the weapon shoot in burst? Anything less than 2 and you cannot toggle burst.

var
burst_delay

The delay in between shots. Lower = less delay = faster.

var
damage_mod

Damage modifier for projectile

var
dual_wield

If this gun is in inactive hands and shooting in akimbo

var
extra_delay

When burst-firing, this number is extra time before the weapon can fire again. Depends on number of rounds fired.

var
fire_cd

Firing cooldown, true if this gun shouldn't be allowed to manually fire

var
gun_crosshair

Crosshair icon of the gun

var
gun_firemode

Current selected firemode of the gun.

var
gun_firemode_list
– /list

List of allowed firemodes.

var
gun_light
– /obj/item/flashlight/seclite

Currently attached flashlight.

var
gun_user
– /mob/living

The mob holding the gun

var
last_fired

World.time of last gun firing.

var
on_rack

Guns can be placed on racks

var
pb_cooldown_duration

Point blank shot cooldown

var
pb_knockback

Responsible for the range of the throwing back when shooting at point blank range

var
shots_counter

Shots counter

var
shots_fired

How many bullets the gun fired while bursting/auto firing

var
stamina_mod

Stamina modifier for projectile

var
starting_attachment_types
– /list

The attachments this gun starts with on Init

var
target
– /atom

The atom targeted by the user

var
unique_rename

Allows renaming with a pen

var
windup_autofire

windup autofire vars Whether the delay between shots increases over time, simulating a spooling weapon

var
windup_autofire_cap

How high of a reduction that current_windup_reduction can reach

var
windup_autofire_reduction_multiplier

the percentage of autfire_shot_delay that is added to current_windup_reduction

var
windup_spindown

How long it takes for weapons that have spooled-up to reset back to the original firing speed

Proc Details

proc
ZoomGrantCheck
(/datum/source, /mob/user, slot)

Proc which will be called when the gun receives the COMSIG_ITEM_EQUIPPED signal.

This happens if the mob picks up the gun, or equips it to any of their slots. If the slot is anything other than either of their hands (such as the back slot), un-zoom them, and Remove the zoom action button from the mob. Otherwise, Grant the mob the zoom action button.

Arguments:

source - the gun that got equipped, which is src.
user - the mob equipping the gun.
slot - the slot the gun is getting equipped to.

proc
change_target
(/client/source, /atom/src_object, /atom/over_object, /turf/src_location, /turf/over_location, src_control, over_control, params)

Update the target if you draged your mouse

proc
clean_gun_user
()

Null out gun user to prevent hard del

proc
clean_target
()

Set the target to it's turf, so we keep shooting even when it was qdeled

proc
do_recoil
(/mob/living/user, /atom/target)

animate recoil for gun

proc
do_semiauto_fire
()

Single-shot fire path, runs process_fire and resets state on success.

proc
gun_on_cooldown
(/mob/user)

Checks if the gun is on cooldown

proc
reset_fire
()

Clean all references

proc
set_bursting
(bursting)

Inform the gun if he is currently bursting, to prevent reloading

proc
set_gun_light
(/obj/item/flashlight/seclite/new_light)

Sets gun's flashlight and do all the necessary updates

proc
set_gun_user
(/mob/user)

Set the user in argument as gun_user

proc
set_target
(/atom/object)

Set the target and take care of hard delete

proc
setup_bullet_accuracy
()

Sets the projectile accuracy and scatter

proc
start_fire
(/datum/source, /atom/object, /turf/location, control, params, bypass_checks)

Check if the gun can fire and add it to bucket auto_fire system if needed, or just fire the gun if not

proc
stop_fire
()

Reset variables used in firing and remove the gun from the autofire system

proc
update_mouse_pointer
(reset)

Updates the current mouse pointer to use the gun crosshair or not

gun /obj/item/gun

Vars

Procs

Var Details

var accuracy – /datum/gun_accuracy

var attachable_allowed

var attachable_offset – /list

var attachment_overlays – /list/image

var attachments_by_slot – /list/obj/item/gun_module

var autoburst_delay

var burst_amount

var burst_delay

var damage_mod

var dual_wield

var extra_delay

var fire_cd

var gun_crosshair

var gun_firemode

var gun_firemode_list – /list

var gun_light – /obj/item/flashlight/seclite

var gun_user – /mob/living

var last_fired

var on_rack

var pb_cooldown_duration

var pb_knockback

var shots_counter

var shots_fired

var stamina_mod

var starting_attachment_types – /list

var target – /atom

var unique_rename

var windup_autofire

var windup_autofire_cap

var windup_autofire_reduction_multiplier

var windup_spindown