gun
/obj/item/weapon/gun

Vars
PB_burst_bullets_fired	When PB burst firing and handing off to /fire after a target moves out of range, this is how many bullets have been fired.
accuracy_mult	Multiplier. Increased and decreased through attachments. Multiplies the projectile's accuracy by this number.
accuracy_mult_unwielded	Multiplier. Increased and decreased through attachments. Multiplies the projectile's accuracy when unwielded by this number.
active_attachable	This will link to one of the attachments, or remain null.
aim_slowdown	Self explanatory. How much does aiming (wielding the gun) slow you
ammo	How the bullet will behave once it leaves the gun, also used for basic bullet damage and effects, etc. Ammo will be replaced on New() for things that do not use mags.
attachable_allowed	Must be the exact path to the attachment present in the list. Empty list for a default.
attachable_offset	Is a list, see examples of from the other files. Initiated on New() because lists don't initial() properly.
attachable_overlays	List of overlays so we can switch them in an out, instead of using Cut() on overlays.
attachments	List of all current attachments on the gun.
automatic	Used to determine if you can target multiple people.
base_gun_icon	the default gun icon_state. change to reskin the gun
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.
burst_scatter_mult	Multiplier. Increases or decreases how much bonus scatter is added with each bullet during burst fire (wielded only).
caliber	Determines what kind of bullet is created when the gun is unloaded - used to match rounds to magazines. Set automatically when reloading.
cock_cooldown	world.time value, to prevent COCK COCK COCK COCK
cock_delay	Delay before we can cock again, in tenths of seconds
damage_buildup_mult	Multiplier. Increased and decreased through attachments. Multiplies the projectile's damage bleed (buildup) by this number.
damage_falloff_mult	Multiplier. Increased and decreased through attachments. Multiplies the projectile's damage bleed (falloff) by this number.
damage_mult	Multiplier. Increased and decreased through attachments. Multiplies the projectile's damage by this number.
delay_style	Determines what happens when you fire a gun before its wield or pull time has finished. This one is extra scatter and an acc. malus.
effective_range_max	What maximum range the weapon deals full damage, tapers off using damage_falloff after hitting this value. 0 for no maximum.
effective_range_min	What minimum range the weapon deals full damage, builds up the closer you get. 0 for no minimum.
extra_delay	When burst-firing, this number is extra time before the weapon can fire again. Depends on number of rounds fired.
fa_delay	The delay when firing full-auto
fa_firing	Whether or not the gun is firing full-auto
fa_max_scatter	How bad does the scatter get on full auto?
fa_params	Click parameters to use when firing full-auto
fa_scatter_peak	How many full-auto shots to get to max scatter?
fa_shots	How many shots have been fired using full-auto. Used to figure out scatter
fa_target	The atom we're shooting at while full-autoing
fire_delay	For regular shots, how long to wait before firing again.
fire_delay_group	The group or groups of the gun where a fire delay is applied and the delays applied to each group when the gun is dropped after being fired
fire_rattle	Does our gun have a unique empty mag sound? If so use instead of pitch shifting.
fire_sounds	If fire_sound is null, it will pick a sound from the list here instead.
guaranteed_delay_time	Storing value for guaranteed delay
gun_category	Only guns of the same category can be fired together while dualwielding.
has_empty_icon	whether gun has icon state of (base_gun_icon)_e
has_open_icon	whether gun has icon state of (base_gun_icon)_o
in_chamber	What is currently in the chamber. Most guns will want something in the chamber upon creation.
last_fired	When it was last fired, related to world.time.
last_moved_mob	Used to fire faster at more than one person.
movement_onehanded_acc_penalty_mult	Multiplier. Increased and decreased through attachments. Multiplies the accuracy/scatter penalty of the projectile when firing onehanded while moving.
muzzle_flash_lum	muzzle flash brightness
pull_time	Storing value for how long pulling a gun takes before you can use it
random_muzzle_chance	Chance for random spawn to give this gun a muzzle attachment.
random_rail_chance	Chance for random spawn to give this gun a rail attachment.
random_spawn_chance	Chance for random attachments to spawn in general.
random_spawn_muzzle	Used when a gun will have a chance to spawn with attachments.
random_spawn_stock	Used when a gun will have a chance to spawn with attachments.
random_spawn_under	Used when a gun will have a chance to spawn with attachments.
random_stock_chance	Chance for random spawn to give this gun a stock attachment.
random_under_chance	Chance for random spawn to give this gun a underbarrel attachment.
recoil	Screen shake when the weapon is fired.
recoil_buildup	The recoil on a dynamic recoil gun
recoil_buildup_limit	The limit at which the recoil on a gun can reach. Usually the maximum value
recoil_loss_per_second	How much recoil_buildup is lost per second. Builds up as time passes, and is set to 0 when a single shot is fired
recoil_unwielded	Multiplier. Increased and decreased through attachments. Multiplies the gun's recoil when unwielded by this number.
scatter	How much the bullet scatters when fired.
scatter_unwielded	Multiplier. Increased and decreased through attachments. Multiplies the projectile's scatter when the gun is unwielded by this number.
starting_attachment_types	What attachments this gun starts with THAT CAN BE REMOVED. Important to avoid nuking the attachments on restocking! Added on New()
target	List of who yer targeting.
told_cant_shoot	So that it doesn't spam them with the fact they cannot hit them.
traits_to_give
velocity_add	Added velocity to fired bullet.
wield_delay	How long between wielding and firing in tenths of seconds
wield_time	Storing value for wield delay.
Procs
add_bullet_traits	@bullet_trait_entries: A list of bullet trait entries
has_ammunition	Returns TRUE if the weapon is loaded. Separate proc because there's no single way to check this for all weapons: chamber isn't always loaded, not all weapons use normal magazines etc. load_into_chamber() itself is designed to be called immediately before firing, and isn't suitable.
load_into_chamber	load_into_chamber(), reload_into_chamber(), and clear_jam() do all of the heavy lifting. If you need to change up how a gun fires, just change these procs for that subtype and you're good to go.
remove_bullet_traits	@bullet_traits: A list of bullet trait typepaths or ids
set_bullet_traits	Populate traits_to_give in this proc
unload_chamber	Unload a chambered round, if one exists, and empty the chamber.

Var Details

var
PB_burst_bullets_fired
–

When PB burst firing and handing off to /fire after a target moves out of range, this is how many bullets have been fired.

var
accuracy_mult
–

Multiplier. Increased and decreased through attachments. Multiplies the projectile's accuracy by this number.

var
accuracy_mult_unwielded
–

Multiplier. Increased and decreased through attachments. Multiplies the projectile's accuracy when unwielded by this number.

var
active_attachable
– /obj/item/attachable/attached_gun

This will link to one of the attachments, or remain null.

var
aim_slowdown
–

Self explanatory. How much does aiming (wielding the gun) slow you

var
ammo
– /datum/ammo

How the bullet will behave once it leaves the gun, also used for basic bullet damage and effects, etc. Ammo will be replaced on New() for things that do not use mags.

var
attachable_allowed
– /list

Must be the exact path to the attachment present in the list. Empty list for a default.

var
attachable_offset
– /list

Is a list, see examples of from the other files. Initiated on New() because lists don't initial() properly.

var
attachable_overlays
– /list

List of overlays so we can switch them in an out, instead of using Cut() on overlays.

var
attachments
– /list

List of all current attachments on the gun.

var
automatic
–

Used to determine if you can target multiple people.

var
base_gun_icon
–

the default gun icon_state. change to reskin the gun

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
burst_scatter_mult
–

Multiplier. Increases or decreases how much bonus scatter is added with each bullet during burst fire (wielded only).

var
caliber
–

Determines what kind of bullet is created when the gun is unloaded - used to match rounds to magazines. Set automatically when reloading.

var
cock_cooldown
–

world.time value, to prevent COCK COCK COCK COCK

var
cock_delay
–

Delay before we can cock again, in tenths of seconds

var
damage_buildup_mult
–

Multiplier. Increased and decreased through attachments. Multiplies the projectile's damage bleed (buildup) by this number.

var
damage_falloff_mult
–

Multiplier. Increased and decreased through attachments. Multiplies the projectile's damage bleed (falloff) by this number.

var
damage_mult
–

Multiplier. Increased and decreased through attachments. Multiplies the projectile's damage by this number.

var
delay_style
–

Determines what happens when you fire a gun before its wield or pull time has finished. This one is extra scatter and an acc. malus.

var
effective_range_max
–

What maximum range the weapon deals full damage, tapers off using damage_falloff after hitting this value. 0 for no maximum.

var
effective_range_min
–

What minimum range the weapon deals full damage, builds up the closer you get. 0 for no minimum.

var
extra_delay
–

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

var
fa_delay
–

The delay when firing full-auto

var
fa_firing
–

Whether or not the gun is firing full-auto

var
fa_max_scatter
–

How bad does the scatter get on full auto?

var
fa_params
–

Click parameters to use when firing full-auto

var
fa_scatter_peak
–

How many full-auto shots to get to max scatter?

var
fa_shots
–

How many shots have been fired using full-auto. Used to figure out scatter

var
fa_target
– /atom

The atom we're shooting at while full-autoing

var
fire_delay
–

For regular shots, how long to wait before firing again.

var
fire_delay_group
– /list

The group or groups of the gun where a fire delay is applied and the delays applied to each group when the gun is dropped after being fired

Guns with this var set will apply the gun's remaining fire delay to any other guns in the same group

Set as null (does not apply any fire delays to any other gun group) or a list of fire delay groups (string defines) matched with the corresponding fire delays applied

var
fire_rattle
–

Does our gun have a unique empty mag sound? If so use instead of pitch shifting.

var
fire_sounds
– /list

If fire_sound is null, it will pick a sound from the list here instead.

var
guaranteed_delay_time
–

Storing value for guaranteed delay

var
gun_category
–

Only guns of the same category can be fired together while dualwielding.

var
has_empty_icon
–

whether gun has icon state of (base_gun_icon)_e

var
has_open_icon
–

whether gun has icon state of (base_gun_icon)_o

var
in_chamber
– /obj/item/projectile

What is currently in the chamber. Most guns will want something in the chamber upon creation.

var
last_fired
–

When it was last fired, related to world.time.

var
last_moved_mob
– /tmp/mob/living

Used to fire faster at more than one person.

var
movement_onehanded_acc_penalty_mult
–

Multiplier. Increased and decreased through attachments. Multiplies the accuracy/scatter penalty of the projectile when firing onehanded while moving.

var
muzzle_flash_lum
–

muzzle flash brightness

var
pull_time
–

Storing value for how long pulling a gun takes before you can use it

var
random_muzzle_chance
–

Chance for random spawn to give this gun a muzzle attachment.

var
random_rail_chance
–

Chance for random spawn to give this gun a rail attachment.

var
random_spawn_chance
–

Chance for random attachments to spawn in general.

var
random_spawn_muzzle
– /list

Used when a gun will have a chance to spawn with attachments.

var
random_spawn_stock
– /list

Used when a gun will have a chance to spawn with attachments.

var
random_spawn_under
– /list

Used when a gun will have a chance to spawn with attachments.

var
random_stock_chance
–

Chance for random spawn to give this gun a stock attachment.

var
random_under_chance
–

Chance for random spawn to give this gun a underbarrel attachment.

var
recoil
–

Screen shake when the weapon is fired.

var
recoil_buildup
–

The recoil on a dynamic recoil gun

var
recoil_buildup_limit
–

The limit at which the recoil on a gun can reach. Usually the maximum value

var
recoil_loss_per_second
–

How much recoil_buildup is lost per second. Builds up as time passes, and is set to 0 when a single shot is fired

var
recoil_unwielded
–

Multiplier. Increased and decreased through attachments. Multiplies the gun's recoil when unwielded by this number.

var
scatter
–

How much the bullet scatters when fired.

var
scatter_unwielded
–

Multiplier. Increased and decreased through attachments. Multiplies the projectile's scatter when the gun is unwielded by this number.

var
starting_attachment_types
– /list

What attachments this gun starts with THAT CAN BE REMOVED. Important to avoid nuking the attachments on restocking! Added on New()

var
target
– /tmp/list/mob/living

List of who yer targeting.

var
told_cant_shoot
– /tmp

So that it doesn't spam them with the fact they cannot hit them.

var
traits_to_give
– /list/list

An assoc list in the format list(/datum/element/bullet_trait_to_give = list(...args)) that will be given to a projectile with the current ammo datum*

var
velocity_add
–

Added velocity to fired bullet.

var
wield_delay
–

How long between wielding and firing in tenths of seconds

var
wield_time
–

Storing value for wield delay.

Proc Details

proc
add_bullet_traits
(/list/list/bullet_trait_entries)

@bullet_trait_entries: A list of bullet trait entries

proc
has_ammunition
()

Returns TRUE if the weapon is loaded. Separate proc because there's no single way to check this for all weapons: chamber isn't always loaded, not all weapons use normal magazines etc. load_into_chamber() itself is designed to be called immediately before firing, and isn't suitable.

proc
load_into_chamber
(/mob/user)

load_into_chamber(), reload_into_chamber(), and clear_jam() do all of the heavy lifting. If you need to change up how a gun fires, just change these procs for that subtype and you're good to go.

proc
remove_bullet_traits
(/list/bullet_traits)

@bullet_traits: A list of bullet trait typepaths or ids

proc
set_bullet_traits
()

Populate traits_to_give in this proc

proc
unload_chamber
(/mob/user)

Unload a chambered round, if one exists, and empty the chamber.

gun /obj/item/weapon/gun

Vars

Procs

Var Details

var PB_burst_bullets_fired –

var accuracy_mult –

var accuracy_mult_unwielded –

var active_attachable – /obj/item/attachable/attached_gun

var aim_slowdown –

var ammo – /datum/ammo

var attachable_allowed – /list

var attachable_offset – /list

var attachable_overlays – /list

var attachments – /list

var automatic –

var base_gun_icon –

var burst_amount –

var burst_delay –

var burst_scatter_mult –

var caliber –

var cock_cooldown –

var cock_delay –

var damage_buildup_mult –

var damage_falloff_mult –

var damage_mult –

var delay_style –

var effective_range_max –

var effective_range_min –

var extra_delay –

var fa_delay –

var fa_firing –

var fa_max_scatter –

var fa_params –

var fa_scatter_peak –

var fa_shots –

var fa_target – /atom

var fire_delay –

var fire_delay_group – /list

var fire_rattle –

var fire_sounds – /list

var guaranteed_delay_time –

var gun_category –

var has_empty_icon –

var has_open_icon –

var in_chamber – /obj/item/projectile

var last_fired –

var last_moved_mob – /tmp/mob/living

var movement_onehanded_acc_penalty_mult –

var muzzle_flash_lum –

var pull_time –

var random_muzzle_chance –

var random_rail_chance –

var random_spawn_chance –

var random_spawn_muzzle – /list

var random_spawn_stock – /list

var random_spawn_under – /list

var random_stock_chance –

var random_under_chance –

var recoil –

var recoil_buildup –

var recoil_buildup_limit –

var recoil_loss_per_second –

var recoil_unwielded –

var scatter –

var scatter_unwielded –

var starting_attachment_types – /list

var target – /tmp/list/mob/living

var told_cant_shoot – /tmp

var traits_to_give – /list/list

var velocity_add –

var wield_delay –

var wield_time –

Proc Details

proc add_bullet_traits(/list/list/bullet_trait_entries)

proc has_ammunition()

proc load_into_chamber(/mob/user)

proc remove_bullet_traits(/list/bullet_traits)

proc set_bullet_traits()

proc unload_chamber(/mob/user)

gun
/obj/item/weapon/gun

var
PB_burst_bullets_fired
–

var
accuracy_mult
–

var
accuracy_mult_unwielded
–

var
active_attachable
– /obj/item/attachable/attached_gun

var
aim_slowdown
–

var
ammo
– /datum/ammo

var
attachable_allowed
– /list

var
attachable_offset
– /list

var
attachable_overlays
– /list

var
attachments
– /list

var
automatic
–

var
base_gun_icon
–

var
burst_amount
–

var
burst_delay
–

var
burst_scatter_mult
–

var
caliber
–

var
cock_cooldown
–

var
cock_delay
–

var
damage_buildup_mult
–

var
damage_falloff_mult
–

var
damage_mult
–

var
delay_style
–

var
effective_range_max
–

var
effective_range_min
–

var
extra_delay
–

var
fa_delay
–

var
fa_firing
–

var
fa_max_scatter
–

var
fa_params
–

var
fa_scatter_peak
–

var
fa_shots
–

var
fa_target
– /atom

var
fire_delay
–

var
fire_delay_group
– /list

var
fire_rattle
–

var
fire_sounds
– /list

var
guaranteed_delay_time
–

var
gun_category
–

var
has_empty_icon
–

var
has_open_icon
–

var
in_chamber
– /obj/item/projectile

var
last_fired
–

var
last_moved_mob
– /tmp/mob/living

var
movement_onehanded_acc_penalty_mult
–

var
muzzle_flash_lum
–

var
pull_time
–

var
random_muzzle_chance
–

var
random_rail_chance
–

var
random_spawn_chance
–

var
random_spawn_muzzle
– /list

var
random_spawn_stock
– /list

var
random_spawn_under
– /list

var
random_stock_chance
–

var
random_under_chance
–

var
recoil
–

var
recoil_buildup
–

var
recoil_buildup_limit
–

var
recoil_loss_per_second
–

var
recoil_unwielded
–

var
scatter
–

var
scatter_unwielded
–

var
starting_attachment_types
– /list

var
target
– /tmp/list/mob/living

var
told_cant_shoot
– /tmp

var
traits_to_give
– /list/list

var
velocity_add
–

var
wield_delay
–

var
wield_time
–

proc
add_bullet_traits
(/list/list/bullet_trait_entries)

proc
has_ammunition
()

proc
load_into_chamber
(/mob/user)

proc
remove_bullet_traits
(/list/bullet_traits)

proc
set_bullet_traits
()

proc
unload_chamber
(/mob/user)