gun
/obj/item/gun

Vars
burst_delay	Delay between shots in a burst.
burst_size	how large a burst is
can_hold_up	Can we hold up our target with this? Default to yes
can_unsuppress	Whether a gun can be unsuppressed. for ballistics, also determines if it generates a suppressor overlay
doafter_self_shoot	If TRUE, and we aim at ourselves, it will initiate a do after to fire at ourselves. If FALSE it will just try to fire at ourselves straight up.
fire_cd	firing cooldown, true if this gun shouldn't be allowed to manually fire
fire_delay	Delay between bursts (if burst-firing) or individual shots (if weapon is single-fire).
firing_burst	Prevent the weapon from firing again while already firing
flip_cooldown	Cooldown for the visible message sent from gun flipping.
light_time	Muzzle Flash Duration
min_recoil	Used as the min value when calculating recoil Affected by a player's min_recoil_multiplier preference, so keep in mind it can ultimately be 0 regardless Often utilized as a "purely visual" form of recoil (as it can be disabled)
pinless	True if a gun dosen't need a pin, mostly used for abstract guns like tentacles and meathooks
projectile_damage_multiplier	Just 'slightly' snowflakey way to modify projectile damage for projectiles fired from this gun.
projectile_speed_multiplier	The most reasonable way to modify projectile speed values for projectile fired from this gun. Honest. Lower values are worse, higher values are better.
projectile_wound_bonus	Even snowflakier way to modify projectile wounding bonus/potential for projectiles fired from this gun.
recoil	Screen shake when the weapon is fired
recoil_backtime_multiplier	a multiplier of the duration the recoil takes to go back to normal view, this is (recoil*recoil_backtime_multiplier)+1
recoil_deviation	this is how much deviation the gun recoil can have, recoil pushes the screen towards the reverse angle you shot + some deviation which this is the max.
Procs
add_seclight_point	Handles adding the seclite mount component to the gun. If the gun shouldn't have a seclight mount, override this with a return. Or, if a child of a gun with a seclite mount has slightly different behavior or icons, extend this.
calculate_recoil	Calculates the final recoil value applied when firing a gun.
clear_suppressor	Clears var and updates icon. In the case of ballistic weapons, also updates the gun's weight.
process_fire	returns true if the gun successfully fires
simulate_recoil	Simulates firearm recoil and applies camera feedback when firing.

Var Details

var
burst_delay

Delay between shots in a burst.

var
burst_size

how large a burst is

var
can_hold_up

Can we hold up our target with this? Default to yes

var
can_unsuppress

Whether a gun can be unsuppressed. for ballistics, also determines if it generates a suppressor overlay

var
doafter_self_shoot

If TRUE, and we aim at ourselves, it will initiate a do after to fire at ourselves. If FALSE it will just try to fire at ourselves straight up.

var
fire_cd

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

var
fire_delay

Delay between bursts (if burst-firing) or individual shots (if weapon is single-fire).

var
firing_burst

Prevent the weapon from firing again while already firing

var
flip_cooldown

Cooldown for the visible message sent from gun flipping.

var
light_time

Muzzle Flash Duration

var
min_recoil

Used as the min value when calculating recoil Affected by a player's min_recoil_multiplier preference, so keep in mind it can ultimately be 0 regardless Often utilized as a "purely visual" form of recoil (as it can be disabled)

var
pinless

True if a gun dosen't need a pin, mostly used for abstract guns like tentacles and meathooks

var
projectile_damage_multiplier

Just 'slightly' snowflakey way to modify projectile damage for projectiles fired from this gun.

var
projectile_speed_multiplier

The most reasonable way to modify projectile speed values for projectile fired from this gun. Honest. Lower values are worse, higher values are better.

var
projectile_wound_bonus

Even snowflakier way to modify projectile wounding bonus/potential for projectiles fired from this gun.

var
recoil

Screen shake when the weapon is fired

var
recoil_backtime_multiplier

a multiplier of the duration the recoil takes to go back to normal view, this is (recoil*recoil_backtime_multiplier)+1

var
recoil_deviation

this is how much deviation the gun recoil can have, recoil pushes the screen towards the reverse angle you shot + some deviation which this is the max.

Proc Details

proc
add_seclight_point
()

Handles adding the seclite mount component to the gun. If the gun shouldn't have a seclight mount, override this with a return. Or, if a child of a gun with a seclite mount has slightly different behavior or icons, extend this.

proc
calculate_recoil
(/mob/living/user, recoil_amount)

Calculates the final recoil value applied when firing a gun.

Arguments:

user - The living mob attempting to fire the gun. Used for preference lookups.
recoil_amount - The raw recoil value to be processed before clamping.

Returns: The clamped recoil value after applying all modifiers.

proc
clear_suppressor
()

Clears var and updates icon. In the case of ballistic weapons, also updates the gun's weight.

proc
process_fire
(/atom/target, /mob/living/user, message, params, zone_override, bonus_spread)

returns true if the gun successfully fires

proc
simulate_recoil
(/mob/living/user, recoil_amount, firing_angle)

Simulates firearm recoil and applies camera feedback when firing.

Arguments:

user - The mob firing the gun. Used for recoil calculation and camera shake.
recoil_amount - The base recoil value before modifiers.
firing_angle - The firing direction used to determine camera kick direction.

gun /obj/item/gun

Vars

Procs

Var Details

var burst_delay

var burst_size

var can_hold_up

var can_unsuppress

var doafter_self_shoot

var fire_cd

var fire_delay

var firing_burst

var flip_cooldown

var light_time

var min_recoil

var pinless

var projectile_damage_multiplier

var projectile_speed_multiplier

var projectile_wound_bonus

var recoil

var recoil_backtime_multiplier

var recoil_deviation