package.swb.demo

Gets the visible muzzle renderer and attachment name

Gets the muzzle attachment transform

Gets the muzzle attachment gameobject

Gets the correct shoot animation

Info used for the current attack

If there is usable ammo left

Checks if the weapon can do the provided attack

Attack information Time since this attack The input button for this attack

Checks if weapon can do the primary attack

Checks if weapon can do the secondary attack

A single bullet trace from start to end with a certain radius.

A single bullet trace from start to end with a certain radius.

Create a bullet impact effect

Create a bullet impact effect

Create a bullet eject particle (always world)

Create a weapon particle

Create a weapon particle

Create a weapon particle

Override this if you want custom UI elements

Unique name that identifies the weapon

How the player holds the weapon in thirdperson

Can bullets be cocked in the barrel? (clip ammo + 1)

Range that tucking should be enabled (-1 to disable tucking)

How much movement speed is affected by holding this weapon (Speed *= Mobility)

A speed multiplier for all reloading animations

View Model field of view

Aim Information

Firstperson Model

Firstperson Hands Model

Thirdperson Model

Enable scoping, renders a 2D scope on ADS

Scope Information

Firing sound when clip is empty

Primary attack data

Secondary attack data (setting this will disable weapon aiming)

Procedural animation speed (lower is slower)

Offset used for setting the weapon to its aim position

Offset used for setting the weapon to its run position

Offset used for setting the weapon to its run position

Duration of the reload animation

Reloading animation

Duration of the empty reload animation (-1 to disable)

Reloading animation when clip is empty

Duration of the draw animation

Draw animation

Duration of the empty draw animation (-1 to disable)

Draw animation when there is no ammo

Is the weapon reloading shells instead of a magazine?

Can the weapon shoot while reloading to cancel the reload?

Delay in fire animation to eject the shell

Duration of the shell reload start animation (animation is set with ReloadAnim)

Duration of the shell reload insert animation (animation is set in animgraph)

Is this a bolt action weapon?

Duration of the boltback animation

Boltback animation

Bullet eject delay during the boltback animation (-1 to disable)

Time since the last primary attack

Time since the last secondary attack

Time since deployment

Time since the last reload

Time since the weapon was in run animation

If the player is running

If the player is crouching

Is the view model visible

If the weapon is being reloaded

If the weapon is being aimed

If the weapon is being scoped

If the weapon is being bolt back reloaded

Called when the view model starts being drawn

Attach this component somewhere in the root of your scene. Manages particle spawning

Max total decals allowed at the same time

Max total eject particles allowed at the same time

Attach this component somewhere in the root of your scene. Register all weapons that you want to use in here. A custom WeaponRegistry can be used by basing it off this one.

Attach this component somewhere in the root of your scene. Gives control over weapon settings (host only)

Enable the weapon customization menu (Q)

Reload weapons automatically when trying to shoot if clip is empty

Enable controller aim assist

Display name (needs to be unique)

Display description

Only 1 active attachment per category, this is also used to determine what effect attachment to overide

The category name

List of positive attributes

List of negative attributes

Weapon stats changer

Path to an image that represent the attachment on the HUD

Path to the attachment model

Name of the model attachment used for new effect origins

Hide this attachment in menus

Equip this attachment by default (Only 1 attachment per category can be enabled by default!)

Depends on another attachment (e.g. rail/mount)

Name of the bone you want to attach the model to

Viewmodel scale

Worldmodel scale

The name of the body group

The name of the body group choice

The default target body group value

If already equipped

Equips the attachment for everyone

Equips the attachment

Unequips the attachment for everyone

Unequips the attachment

Gets called after the attachment is equipped

Gets called after the attachment is unequipped

Gets called when the weapon is creating its HUD elements

Gets called when the weapon is destroying its HUD elements

The new aim position offset

Scope Information

The new aim position offset

New muzzle flash effect point

New particle used for the muzzle flash

New sound used for firing

A physical bullet that simulates a bullet travelling over time through the air

Describes effects of aiming with a weapon Any value set to -1 implies "don't modify" or "use default"

Spread modifier to apply when Aiming Down Sights (ADS).

Input sensitivity multiplier when aiming down sights (ADS). (lower is slower, 0 to disable)

FOV For the view model when aiming down sights.

FOV for the player camera when aiming down sights.

FOV aim in speed

FOV aim out speed

2D lens texture

2D scope texture

Delay between ADS and scoping in ms

Sound that plays when scoping starts

Sound that plays when scoping ends

Player FOV while scoping

Mouse sensitivity while scoping (lower is slower, 0 to use AimInfo.Sensitivity while scoped)

Spread while scoping (lower is more accurate, 0 = perfect, 1 = normal )

Single fire

Automatic fire

3-Burst fire

No infinite ammo

Infinite clip ammo, no need to reload

Infinite reserve ammo, can always reload

Bullet type (Hitscan/Physical)

Type of ammo

Amount of ammo in the clip

Size of the clip

If the weapon should have infinite ammo

Amount of bullets per shot

Bullet size

Chance the BulletTracerParticle is created (0-1)

Damage per bullet

Bullet impact force

Bullet hit flinch

Weapon spread

Weapon recoil

Rate Per Minute, firing speed (higher is faster)

Screenshake per shot

Weapon firing type

Animation used for shooting

Animation used for shooting the last bullet

Animation used for shooting while aiming

Firing sound when clip is empty

Firing sound

View Model particle scale

World Model particle scale (BulletEject + BulletTracer)

World Model particle scale for the muzzle effects (MuzzleFlash + BarrelSmoke)

Particle used for bullet ejection

Particle used for the muzzle flash

Particle used for the barrel smoke

Particle used for the barrel smoke

A horizontal slider. Can be float or whole number.

The right side of the slider

The left side of the slider

If set to 1, value will be rounded to 1's If set to 10, value will be rounded to 10's If set to 0.1, value will be rounded to 0.1's

The actual value. Setting the value will snap and clamp it.

Convert a screen position to a value. The value is clamped, but not snapped.

If we move the mouse while we're being pressed then set the position, but skip transitions.

On mouse press jump to that position

Updates the styles for TrackInner and Thumb to position us based on the current value. Note this purposely uses percentages instead of pixels when setting up, this way we don't have to worry about parent size, screen scale etc.

A horizontal slider with a text entry on the right

The actual value. Setting the value will snap and clamp it.

Thirdperson shoulder offset

Enable the ability to climb ladders

Blocks jump when jumping quickly in succession

Called once when the player lands

Animations that SWB may trigger on the player object

An extended version of Sandbox.DamageInfo with additional properties for SWB

Inventory slot

Image that represent the item on the HUD

Name that represent the item on the HUD

The movement speed modifier while this item is active

Called on the GameObject that will be the new active one (Broadcast for networked gameObjects!)

Called when the GameObject stops being the active one (Broadcast for networked gameObjects!)

Can the GameObject be switched out

Implement this interface on a `Component` to integrate with SWB

Unique identifier for the player Typically implemented by `Component`

The game object that owns this component Typically implemented by `Component`

The camera to use when renderering the weapon's view model on the client side If none is provided and first person mode is enabled, then a camera will be created

The camera used for rendering the player's first person view Used to calculate view model sway The Render exclude tag "viewmodel" will be automatically applied to prevent render issues

Whether the player is in first person view

The player's current velocity

Whether the player is crouching, this will effect aim and recoil

Whether the player is running, this will effect aim and recoil

Whether the player is on the ground, this will effect aim and recoil

Whether the player is actively climbing a ladder

Whether the player is alive. Damage will not be dealt to dead players.

Is this player considered a bot Bots have input movement and other functionalities disabled

View angle of the player, used to determine the direction to shoot a bullet

View position of the player, used to determine the origin point of a fired bullet

Input sensitivity modifier based on player ADS (aim down sights) state

The suggested FOV to be used by the player camera, affected by a weapon zoom This assumes a first-person perspective and will default to `Preferences.FieldOfView`

The Hold Type for the currently equipped weapon

Called when the weapon wants to know how much ammo is available

The type of ammo How much ammo is available

Called when the weapon wants to trigger an animation on the player object

The animation to trigger

Triggered when the weapon wants to apply an angular offset to the player's view to simulate recoil. Called when a weapon is fired.

The suggested angular offset to apply

Called when the weapon object should be attached/parented to the player's body

The game object to parent The suggested bone to parent to

Called when the weapon is trying to take ammo.

The type of ammo The amount of ammo requested How much ammo was actually taken

Shakes the camera

Information about the shake

Modifies the velocity (WishVelocity *= Amount) [1 = none]

Duration (s)

Delay between shakes (s)

Screen disposition amount

Screen rotation amount

How long until we destroy the GameObject.

The real time until we destroy the GameObject.