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.
autofire_slow_mult	The multiplier for how much slower this should fire in automatic mode. 1 is normal, 1.2 is 20% slower, 2 is 100% slower, etc. Protected due to it never needing to be edited.
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. Use modify_burst_amount and set_burst_amount instead of modifying this
burst_delay	The delay in between shots. Lower = less delay = faster. Use modify_burst_delay and set_burst_delay instead of modifying this
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_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?
fire_delay	For regular shots, how long to wait before firing again. Use modify_fire_delay and set_fire_delay instead of modifying this on the fly
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.
gun_firemode	Current selected firemode of the gun.
gun_firemode_list	List of allowed firemodes.
gun_user	Current user (holding) of the gun. Set with set_gun_user()
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.
mouse_pointer	A custom mouse pointer icon to use when wielded
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_color	Color of the muzzle flash light effect.
muzzle_flash_lum	muzzle flash brightness
projectile_type	The type of projectile that this gun should shoot
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.
shots_fired	How many bullets the gun fired while bursting/auto firing
start_automatic	If this gun should spawn with automatic fire. Protected due to it never needing to be edited.
start_semiauto	If this gun should spawn with semi-automatic fire. Protected due to it never needing to be edited.
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	Currently selected target to fire at. Set with set_target()
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
change_target	Update the target if you draged your mouse
clean_target	Set the target to its turf, so we keep shooting even when it was qdeled
fire_wrapper	Wrapper proc for the autofire subsystem to ensure the important args aren't null
force_light	If this gun has a relevant flashlight attachable attached, (de)activate it
get_fire_delay	getter for fire_delay
get_gun_user	Getter for gun_user
handle_view	SIGNAL_HANDLER for COMSIG_CLIENT_RESET_VIEW to ensure the mouse_pointer is set correctly
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.
is_civilian_usable	Returns one of the two override values if either are null, preferring the argument value. Otherwise, returns TRUE if it is in a civilian usable category (Handguns or SMGs), FALSE if it is not.
light_sources	check if the gun contains any light source that is currently turned on.
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.
modify_burst_amount	adder for burst_amount
modify_burst_delay	Adder for burst_delay
modify_fire_delay	adder for fire_delay
play_firing_sounds	When the gun is about to shoot this is called to play the specific gun's firing sound. Requires the firing projectile and the gun's user as the first and second argument
remove_bullet_traits	@bullet_traits: A list of bullet trait typepaths or ids
reset_fire	Clean all references
reset_light_range	called by a timer to remove the light range from muzzle flash
set_auto_firing	Setter proc for fa_firing
set_bullet_traits	Populate traits_to_give in this proc
set_burst_amount	setter for burst_amount
set_burst_delay	Setter for burst_delay
set_bursting	Setter proc to toggle burst firing
set_fire_delay	setter for fire_delay
set_target	Set the target and take care of hard delete
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
turn_off_light	This function actually turns the lights on the gun off
unload_chamber	Unload a chambered round, if one exists, and empty the chamber.
update_mouse_pointer	Turns the mouse cursor into a crosshair if new_cursor is set to TRUE. If set to FALSE, returns the cursor to its initial icon.

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

The multiplier for how much slower this should fire in automatic mode. 1 is normal, 1.2 is 20% slower, 2 is 100% slower, etc. Protected due to it never needing to be edited.

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. Use modify_burst_amount and set_burst_amount instead of modifying this

var
burst_delay
–

The delay in between shots. Lower = less delay = faster. Use modify_burst_delay and set_burst_delay instead of modifying this

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_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
fire_delay
–

For regular shots, how long to wait before firing again. Use modify_fire_delay and set_fire_delay instead of modifying this on the fly

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

Current selected firemode of the gun.

var
gun_firemode_list
– /list

List of allowed firemodes.

var
gun_user
– /mob

Current user (holding) of the gun. Set with set_gun_user()

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/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
mouse_pointer
–

A custom mouse pointer icon to use when wielded

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

Color of the muzzle flash light effect.

var
muzzle_flash_lum
–

muzzle flash brightness

var
projectile_type
–

The type of projectile that this gun should shoot

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

How many bullets the gun fired while bursting/auto firing

var
start_automatic
–

If this gun should spawn with automatic fire. Protected due to it never needing to be edited.

var
start_semiauto
–

If this gun should spawn with semi-automatic fire. Protected due to it never needing to be edited.

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
– /atom

Currently selected target to fire at. Set with set_target()

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
change_target
(/datum/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_target
()

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

proc
fire_wrapper
(/atom/target, /mob/living/user, params, reflex, dual_wield)

Wrapper proc for the autofire subsystem to ensure the important args aren't null

proc
force_light
(on)

If this gun has a relevant flashlight attachable attached, (de)activate it

proc
get_fire_delay
(value)

getter for fire_delay

proc
get_gun_user
()

Getter for gun_user

proc
handle_view
(/client/user, /atom/target)

SIGNAL_HANDLER for COMSIG_CLIENT_RESET_VIEW to ensure the mouse_pointer is set correctly

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
is_civilian_usable
(/mob/user, arg_override)

Returns one of the two override values if either are null, preferring the argument value. Otherwise, returns TRUE if it is in a civilian usable category (Handguns or SMGs), FALSE if it is not.

proc
light_sources
()

check if the gun contains any light source that is currently turned on.

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
modify_burst_amount
(value, /mob/user)

adder for burst_amount

proc
modify_burst_delay
(value, /mob/user)

Adder for burst_delay

proc
modify_fire_delay
(value)

adder for fire_delay

proc
play_firing_sounds
(/obj/projectile/projectile_to_fire, /mob/user)

When the gun is about to shoot this is called to play the specific gun's firing sound. Requires the firing projectile and the gun's user as the first and second argument

proc
remove_bullet_traits
(/list/bullet_traits)

@bullet_traits: A list of bullet trait typepaths or ids

proc
reset_fire
()

Clean all references

proc
reset_light_range
(lightrange)

called by a timer to remove the light range from muzzle flash

proc
set_auto_firing
(auto)

Setter proc for fa_firing

proc
set_bullet_traits
()

Populate traits_to_give in this proc

proc
set_burst_amount
(value, /mob/user)

setter for burst_amount

proc
set_burst_delay
(value, /mob/user)

Setter for burst_delay

proc
set_bursting
(bursting)

Setter proc to toggle burst firing

proc
set_fire_delay
(value)

setter for fire_delay

proc
set_target
(/atom/object)

Set the target and take care of hard delete

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
turn_off_light
(/mob/bearer)

This function actually turns the lights on the gun off

proc
unload_chamber
(/mob/user)

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

proc
update_mouse_pointer
(/mob/user, new_cursor)

Turns the mouse cursor into a crosshair if new_cursor is set to TRUE. If set to FALSE, returns the cursor to its initial icon.

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

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

var fa_max_scatter –

var fa_params –

var fa_scatter_peak –

var fire_delay –

var fire_delay_group – /list

var fire_rattle –

var fire_sounds – /list

var guaranteed_delay_time –

var gun_category –

var gun_firemode –

var gun_firemode_list – /list

var gun_user – /mob

var has_empty_icon –

var has_open_icon –

var in_chamber – /obj/projectile

var last_fired –

var last_moved_mob – /tmp/mob/living

var mouse_pointer –

var movement_onehanded_acc_penalty_mult –

var muzzle_flash_color –

var muzzle_flash_lum –

var projectile_type –

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

var start_automatic –

var start_semiauto –

var starting_attachment_types – /list

var target – /atom

var told_cant_shoot – /tmp

var traits_to_give – /list/list

var velocity_add –

var wield_delay –

var wield_time –

Proc Details

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

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

var
fa_max_scatter
–

var
fa_params
–

var
fa_scatter_peak
–

var
fire_delay
–

var
fire_delay_group
– /list

var
fire_rattle
–

var
fire_sounds
– /list

var
guaranteed_delay_time
–

var
gun_category
–

var
gun_firemode
–

var
gun_firemode_list
– /list

var
gun_user
– /mob

var
has_empty_icon
–

var
has_open_icon
–

var
in_chamber
– /obj/projectile

var
last_fired
–

var
last_moved_mob
– /tmp/mob/living

var
mouse_pointer
–

var
movement_onehanded_acc_penalty_mult
–

var
muzzle_flash_color
–

var
muzzle_flash_lum
–

var
projectile_type
–

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

var
start_automatic
–

var
start_semiauto
–

var
starting_attachment_types
– /list

var
target
– /atom

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
change_target
(/datum/source, /atom/src_object, /atom/over_object, /turf/src_location, /turf/over_location, src_control, over_control, params)

proc
clean_target
()

proc
fire_wrapper
(/atom/target, /mob/living/user, params, reflex, dual_wield)