Parameter

Default

Description

Style

---

The weapon's holding style in third person. More details can be found below.

Model

The weapon's third person model. Usually this is in the form of w_<weap>.w3d

IdleAnim

???

FireAnim

???

BackModel

The model used for when the weapon is on the third person model's back. Usually this is in the form of w_<weap>_b.w3d

SwitchTime

1.000

How long it takes to swap to and from this weapon, in seconds.

ReloadTime

0.000

How long it takes to reload the weapon, in seconds.

PerBulletReload note: if this option is enabled,then this is how long it takes to do one reload cycle)

KeyNumber

0.000

What number key is used to select the weapon.

CanSnipe

false

Does this weapon have a sniper scope?

Rating

0.000

Unused.

EjectVelocity

2.000

The velocity of the ejected bullet casing

EjectRandomness

0.000

How random the ejected casing velocity is, plus or minus this number.

EjectTime

0.000

How long after firing is a casing ejected

EjectPhysDefID

Opens a window that allows you to define the casing model and such. More details are found below.

EjectIsShotgunShell

false

When the casing is ejected, will it make shotgun shell sounds (defined in SurfaceEffects.ini under <surface>_Shell Shotgun) when it hits the ground?

MuzzleFlashPhysDefID

Allows you to define a model for the muzzle flash.

FirstPersonModel

The model used for the first person view. NOTE: This must be named in the format F_GM_<WEAP>, and there are further dependencies. See <tbd> for more information on view models.

FirstPersonOffset

0.000,0.000,0.000

The 3d offset of the first person view model.

RecoilImpulse

0.000

How much force will this weapon impart on the user when it fires.

HUDIconTextureName

Unused.

ReloadSoundDefID

What sound is played when the weapon is reloaded

PerBulletReload note: if this is enabled, the reload sound will be played every reload cycle

EmptySoundDefID

What sound is played when the player tries to fire, but the weapon has no bullets (and can't reload).

SelectSoundDefID

What sound is played when the player selects this weapon?

DeselectSoundDefID

What sound is played when the player deselects this weapon?

PrimaryAmmoDefID

What does the weapon fire on a left click. Links to an Ammo definition. Required.

SecondaryAmmoDefID

What does the weapon fire on a right click. Links to an Ammo definition. This isn't required.

PrimaryFireMuzzleSetEditor

A

Which set of barrels does the primary fire come out of? (E.g MuzzleA, MuzzleB, etc. Put the letter of the muzzle set in)

SecondaryFireMuzzleSetEditor

B

Which set of barrels does the secondary fire come out of? (E.g MuzzleA, MuzzleB, etc. Put the letter of the muzzle set in)

BypassSameAmmoMuzzleSelectLogic

false

If a weapon has the same ammo set for both primary and secondary, then by default the code will automatically default to ignoring the secondary muzzle set. Set this to make the code instead use both sets of muzzles based on primary/secondary fire, rather than just using the same muzzle.

ClipSize

0

How many bullets does the weapon hold in one clip? -1 means the weapon can shoot infinitely with no reloading.

MaxInventoryRounds

100

How many bullets can the weapon hold to reload with. -1 means infinite reloads.

RecoilTime

0.1

How long will the gun's visual recoil take? For this, the muzzle on vehicles will recoil, and the character's arms and such will recoil.

RecoilScale

1.0

How far will the gun recoil? For this, the muzzle on vehicles will recoil, and the character's arms and such will recoil.

AGiveWeaponsWeapon

false

Will this weapon be granted to the player if the function SoldierGameObj::Give_All_Weapons is called?

If the Allweapons console command is used and this is ticked, then this weapon will be given to the client the command points to.

IconNameID

What string is displayed in the hud in the weapon's information area?

IconTextureName

What icon is the weapon using.

IconTextureUV

Where on the IconTextureName texture is the icon? X1 is left, X2 is right, Y1 is top, Y2 is bottom.

IconOffset

How far is the icon offset from it's default position?

HumanFiringAnimation

What animation does the character use when they are firing this weapon?

ScopeTexture

If the weapon has a scope, what texture is used for the scope?

UniformScope

false

Will the scope texture be stretched to match the aspect ratio?

MaxZoom

0

How far in can the scope zoom?

MinZoom

0

What's the most zoomed out the scope can be?

GlobalFireSoundDefID

This sound will be played across the map when the weapon is fired.

AreaEffectWeapon

false

Does this weapon do AOE damage instead of firing a bullet?

AreaEffectWeaponAffectOwner

false

Does the AOE damage effect the owner?

AreaEffectWeaponAffectFriendly

true

Does the AOE damage effect friendlies?

AreaEffectWeaponAffectEnemy

true

Does the AOE damage effect enemies?

AreaEffectWeaponAffectNeutral

true

Does the AOE damage effect neutral objects?

SprayAddWalking

0

How much spray does jumping add to the weapon?

SprayAddWounded

0

How much spray does being wounded add to the weapon?

SprayAddWalking

0

How much spray does walking add to the weapon? (Note, this isn't running.)

SprayAddCrouching

0

How much spray does being crouched add to the weapon?

SprayAddSprinting

0

How much spray does sprinting add to the weapon?

Accuracy Recovery Rate (Movement) (deg/sec)

0.573

How much does the spray reduce each second?

Accuracy Recovery Rate (Weapon) (deg/sec)

-57.296

How much does the weapon's spray bloom get reduced by each second?

IsSuperweaponBeacon

true

Always true.

PerBulletReload

false

Each reload adds a single bullet to the magazine.

If this is ticked, the weapon will reload to full, reloading one bullet (or more) at a time. Read the end of the document to find out how exactly this works, as there's a lot to it.

BulletsPerPBReload

1

How many bullets are added to the magazine per reload cycle, if PerBulletReload is enabled.

PBReloadStartTime

0

How much extra time is added to the reload if this is the start of the reload?

PBReloadEndTime

0

How much time does the end of the reload (after the magazine is filled with bullets) take?

PBReloadLoopFrame

0

What frame of the first person animation does the first person reload animation loop to?

PBReloadEndSoundDefID

What sound does the weapon play at the end of the reload, while it's finishing.

FirstPersonAnim

This tells the first person view model to use another weapon's animations. Must be entered in the form of F_GM_XXXX.

DoTiltWhileReloading

true

Does the third person model tilt down while reloading?

AllowEmptyShots

false

Can this weapon fire when the ammo is empty?

HideWhenEmpty

true

Can this weapon be selected if it's got no ammo?

IsCooldownAbility

false

Is this a weapon that goes on cooldown instead of reloading? (Uses Reload Time as Cooldown Time)

IsQuickCastAbility

false

Is this a weapon that fires upon being switched to and then switch back to the last held weapon?

AutoSwitchOnFire

false

Does the Cooldown Ability weapon switch to the last held weapon after firing?

AutoSwitchDelay

0.2

If the Cooldown Ability weapon auto switches after firing, how long should this switch be delayed by?

DelayedChargeFire

false

Can the charge bar or Cooldown Weapon be held with the fire key, to be fired upon releasing the fire key?

CannotFireWithoutLock

false

This weapon cannot fire without a lockon

RequireCrouch

false

When this weapon is equipped, the owner is forced to crouch

PostSprintSwitchTime

The time between coming out of a sprint and being able to fire the weapon

RecoilPattern

Arc

What pattern does the recoil use?

Circle - Will go in a 360 direction around the aim point.

Arc - Will go in a slice, with the direction in the RecoilBias direction.

RecoilSize

0

How big is the recoil?

RecoilBias

0,0.

What direction is the recoil? This is an X,Y axis.

RecoilRandProb

0

How often will the recoil go in a truly random direction instead of the RecoilPhysBias direction?

RecoilArcSize

0

How wide the arc of the "Arc" recoil pattern is, in degrees.

RecoilResist

0

How well can the recoil be "resisted" by the weapon. This reduces the effect of recoil, but doesn't reset the weapon when done firing.

RecoilResistMulJumping

1

Modifies the recoil resistance. Values greater than one make it worse, less than 1 make it better.
 

RecoilResistMulInjuring

1

RecoilResistMulCrouching

1

RecoilResistMulScoped

1

RecoilRecovery

0

This controls how quickly the weapon will return to it's original aim point.

RecoilFirstShotMultiplier

1

How much is the recoil strength multiplied on the first shot?

RecoilAimpointStatic

false

If this is enabled, then when the recoil hits the edge of the recoil range, then it will not travel any further. If disabled, this will continue to move the weapon up and shift the original aimpoint up as well.

UseGattlingLogic

false

If enabled, the weapon will spin up/down when firing, like a minigun. There are bones associated with this. (Check in Vehicle/Weapon rigging pages)

GattlingWarmUpTime

1.0

How long does the weapon take to spin up?

GattlingWarmDownMultiplier

1.0

This controls how long it takes the weapon to spin back down after stopping. If Warm up time is 1.0 and the Warm down multiplier is 0.5, then the weapon will take 2 seconds to spin down. If it is 2.0, then the weapon will take half a second to spin down.

GatlingMinimumContSoundPitch

1.0

What is the pitch of the ContinuousMotorSound when the gun is starting to spin?

GatlingMaximumContSoundPitch

1.0

What is the pitch of the ContinuousMotorSound when the gun is at full speed?

GatlingCannotFireWhileWarmingUp

false

Can the weapon fire while it's still spinning up to max RPM? (A Yuri's Revengesque Gatling weapon would be set to false, while a generic gatling from most other games would be set to true.)

GatlingSpinningStopsDuringReload

false

Does the weapon spin down during the reload process?

GatlingContinuousMotorSoundID

Controls what sound is playing when the gatling motor is spinning. This plays even if the weapon is not firing.