Version: bleeding-edge 🩸

🔫 Weapon

Weapons are entities with firing, reloading and aiming functionalities.

They are fully customizable, all pieces of the weapon can be changed with immense possibility of creation.

💂Authority

This class can only be spawned on 🟦 Server side.

🔁Network Authority Distribution

This class have the Network Authority distribution enabled and automatically handled by the server. You can override the Network Authority or disable it from automatically distributing.

👪Inheritance

This class shares methods and events from Base Entity, Base Actor, Base Paintable, Base Pickable.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

🎒 Examples

Server/Index.lua
-- Spawning a Weapon with an AK47 model
local new_weapon = Weapon(
    Vector(-900, 185, 215),
    Rotator(0, 0, 0),
    "nanos-world::SK_AK47"
)

-- Configures Weapon Base Settings
new_weapon:SetAmmoSettings(30, 1000)
new_weapon:SetDamage(30)
new_weapon:SetSpread(30)
new_weapon:SetRecoil(0.25)
new_weapon:SetBulletSettings(1, 20000, 20000, Color(100, 58, 0))
new_weapon:SetCadence(0.1)
new_weapon:SetWallbangSettings(50, 0.75)

-- Configures how the Character Grabs and Aims the Weapon
new_weapon:SetHandlingMode(HandlingMode.DoubleHandedWeapon)
new_weapon:SetSightTransform(Vector(0, 0, -1), Rotator(-1.5, 0, 0))
new_weapon:SetLeftHandTransform(Vector(22, 0, 9), Rotator(0, 60, 90))
new_weapon:SetRightHandOffset(Vector(-10, 0, 0))

-- Configures Weapon Particles
new_weapon:SetParticlesBulletTrail("nanos-world::P_Bullet_Trail")
new_weapon:SetParticlesBarrel("nanos-world::P_Weapon_BarrelSmoke")
new_weapon:SetParticlesShells("nanos-world::P_Weapon_Shells_762x39")

-- Configures Weapon Sounds
new_weapon:SetSoundDry("nanos-world::A_Rifle_Dry")
new_weapon:SetSoundLoad("nanos-world::A_Rifle_Load")
new_weapon:SetSoundUnload("nanos-world::A_Rifle_Unload")
new_weapon:SetSoundZooming("nanos-world::A_AimZoom")
new_weapon:SetSoundAim("nanos-world::A_Rattle")
new_weapon:SetSoundFire("nanos-world::A_AK47_Shot")

-- Configures Weapon Animations
new_weapon:SetAnimationFire("nanos-world::A_AK47_Fire")
new_weapon:SetAnimationCharacterFire("nanos-world::AM_Mannequin_Sight_Fire")
new_weapon:SetAnimationReload("nanos-world::AM_Mannequin_Reload_Rifle")

-- Configures the Mesh to drop when reloading
new_weapon:SetMagazineMesh("nanos-world::SM_AK47_Mag_Empty")

-- Configures the Crosshair Material
new_weapon:SetCrosshairMaterial("nanos-world::MI_Crosshair_Regular")

Using the default-weapons Package to spawn an AK47:

Terminal
# install the default-weapons package
./NanosWorldServer.exe --cli install package default-weapons

Server/Index.lua
-- Loads the default-weapons (note: it's recommended to add it to your Package's packages_requirements instead)
Server.LoadPackage("default-weapons")

-- Spawning the AK47 from default-weapons package
local my_ak47 = AK47(Vector(1035, 154, 300), Rotator())

-- Giving the Weapon to a Character
my_character:PickUp(my_ak47)

More related examples:

Prop Shootergetting-started/tutorials-and-examples/prop-shooter Weapon Scopegetting-started/tutorials-and-examples/weapon-scope Weapon Flashlightgetting-started/tutorials-and-examples/weapon-flashlight

🛠 Constructors

Default Constructor

No description provided

local my_weapon = Weapon(location, rotation, asset, collision_type?, gravity_enabled?, defer_spawn?)

Parameters

Type	Name	Default	Description
Vector	`location`	Required parameter	No description provided
Rotator	`rotation`	Required parameter	No description provided
SkeletalMesh Reference	`asset`	Required parameter	No description provided
CollisionType	`collision_type`	`CollisionType.Auto`	No description provided
boolean	`gravity_enabled`	`true`	No description provided
boolean	`defer_spawn`	`false`	Pass true to avoid immediately sending the entity to clients and improve performance when you want to configure it by setting several configs. Must call `FinishSpawn()` after all

🗿 Static Functions

Inherited Entity Static Functions

Weapon inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

Returns	Name	Description
table of Base Entity	`GetAll`	Returns a table containing all Entities of the class this is called on
Base Entity	`GetByIndex`	Returns a specific Entity of this class at an index
integer	`GetCount`	Returns how many Entities of this class exist
table of table	`GetInheritedClasses`	Gets a list of all directly inherited classes from this Class created with the Inheriting System
iterator	`GetPairs`	Returns an iterator with all Entities of this class to be used with `pairs()`
table or nil	`GetParentClass`	Gets the parent class if this Class was created with the Inheriting System
table	`Inherit`	Inherits this class with the Inheriting System
boolean	`IsChildOf`	Gets if this Class is child of another class if this Class was created with the Inheriting System
function	`Subscribe`	Subscribes to an Event for all entities of this Class
function	`SubscribeRemote`	Subscribes to a custom event called from server
	`Unsubscribe`	Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed

This class doesn't have own static functions.

🦠 Functions

Inherited Entity Functions

Weapon inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

Returns	Name	Description
	`BroadcastRemoteEvent`	Calls a custom remote event directly on this entity to all Players
	`BroadcastRemoteInRadiusEvent`	Calls a custom remote event directly on this entity to all Players in a radius
	`CallRemoteEvent`	Calls a custom remote event directly on this entity to a specific Player
	`CallRemoteEvent`	Calls a custom remote event directly on this entity
	`CallRemotePlayersEvent`	Calls a custom remote event directly on this entity to a list of Players
	`Destroy`	Destroys this Entity
	`FinishSpawn`	Finish the spawning process and send the entity to clients if it was spawned with `defer_spawn`
table of string	`GetAllValuesKeys`	Gets a list of all values keys
table	`GetClass`	Gets the class of this entity
integer	`GetID`	Gets the universal network ID of this Entity (same on both client and server)
any	`GetValue`	Gets a Value stored on this Entity at the given key
boolean	`HasAuthority`	Gets if the local context has authority over this Entity (true if spawned by the client, false if spawned by the server)
boolean	`IsA`	Recursively checks if this entity is inherited from a Class
boolean	`IsBeingDestroyed`	Returns true if this Entity is being destroyed
boolean	`IsValid`	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
	`SetValue`	Sets a Value in this Entity
function	`Subscribe`	Subscribes to an Event on this specific entity
function	`SubscribeRemote`	Subscribes to a custom event called from server on this specific entity
	`Unsubscribe`	Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed

Inherited Actor Functions

Weapon inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/actor

Returns	Name	Description
	`AddActorTag`	Adds an Unreal Actor Tag to this Actor
	`AddAngularImpulse`	Add an angular impulse to this Actor. Good for one time instant burst
	`AddImpulse`	Add an impulse to this Actor. Good for one time instant burst
boolean	`AttachTo`	Attaches this Actor to any other Actor, optionally at a specific bone
	`Detach`	Detaches this Actor from AttachedTo Actor
table of string	`GetActorTags`	Gets all Unreal Actor Tags on this Actor
Vector	`GetAngularForce`	Gets this Actor's angular force (set by `SetAngularForce()`)
table of Base Actor	`GetAttachedEntities`	Gets all Actors attached to this Actor
Base Actor or nil	`GetAttachedTo`	Gets the Actor this Actor is attached to
table	`GetBounds`	Gets this Actor's bounds
CollisionType	`GetCollision`	Gets this Actor's collision type
integer	`GetDimension`	Gets this Actor's dimension
float	`GetDistanceFromCamera`	Gets the distance of this Actor from the Camera
Vector	`GetForce`	Gets this Actor's force (set by `SetForce()`)
Vector	`GetLocation`	Gets this Actor's location in the game world
Player or nil	`GetNetworkAuthority`	Gets this Actor's Network Authority Player
Vector	`GetRelativeLocation`	Gets this Actor's Relative Location if it's attached
Rotator	`GetRelativeRotation`	Gets this Actor's Relative Rotation if it's attached
Rotator	`GetRotation`	Gets this Actor's angle in the game world
Vector	`GetScale`	Gets this Actor's scale
float	`GetScreenPercentage`	Gets the percentage of this Actor size in the screen
table	`GetSocketTransform`	Gets a Socket Transform in world space given a bone or socket name
Vector	`GetVelocity`	Gets this Actor's current velocity
boolean	`HasNetworkAuthority`	Returns true if the local Player is currently the Network Authority of this Actor
boolean	`IsGravityEnabled`	Returns true if gravity is enabled on this Actor
boolean	`IsInWater`	Returns true if this Actor is in water
boolean	`IsNetworkDistributed`	Returns true if this Actor is currently network distributed
boolean	`IsVisible`	Returns true if this Actor is visible
	`RemoveActorTag`	Removes an Unreal Actor Tag from this Actor
	`RotateTo`	Smoothly rotates this actor to an angle over a certain time
	`SetAngularForce`	Adds a permanent angular force to this Actor, set to Vector(0, 0, 0) to cancel
	`SetCastShadow`	Sets this Actor's to cast shadows or not
	`SetCollision`	Sets this Actor's collision type
	`SetDimension`	Sets this Actor's Dimension
	`SetDistanceOptimizationMultiplier`	Sets this Actor's distance optimization multiplier
	`SetForce`	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
	`SetGravityEnabled`	Sets whether gravity is enabled on this Actor
	`SetHighlightEnabled`	Sets whether the highlight is enabled on this Actor, and which highlight index to use
	`SetLifeSpan`	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
	`SetLocation`	Sets this Actor's location in the game world
	`SetNetworkAuthority`	Sets the Player to have network authority over this Actor
	`SetNetworkAuthorityAutoDistributed`	Sets if this Actor will auto distribute the network authority between players
	`SetOutlineEnabled`	Sets whether the outline is enabled on this Actor, and which outline index to use
	`SetRelativeLocation`	Sets this Actor's relative location in local space (only if this actor is attached)
	`SetRelativeRotation`	Sets this Actor's relative rotation in local space (only if this actor is attached)
	`SetRenderCullDistance`	Sets this Actor's render cull distance
	`SetRotation`	Sets this Actor's rotation in the game world
	`SetScale`	Sets this Actor's scale
	`SetVisibility`	Sets whether the actor is visible or not
	`TranslateTo`	Smoothly moves this actor to a location over a certain time
boolean	`WasRecentlyRendered`	Gets if this Actor was recently rendered on screen

Inherited Paintable Functions

Weapon inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/paintable

Returns	Name	Description
Color	`GetMaterialColorParameter`	Gets a Color parameter from this Actor's material
float	`GetMaterialScalarParameter`	Gets a Scalar parameter from this Actor's material
string	`GetMaterialTextureParameter`	Gets a Texture parameter from this Actor's material
Vector	`GetMaterialVectorParameter`	Gets a Vector parameter from this Actor's material
	`ResetMaterial`	Resets the material from the specified index to the original one
	`SetMaterial`	Sets the material at the specified index of this Actor
	`SetMaterialColorParameter`	Sets a Color parameter in this Actor's material
	`SetMaterialFromCanvas`	Sets the material at the specified index of this Actor to a Canvas object
	`SetMaterialFromSceneCapture`	Sets the material at the specified index of this Actor to a SceneCapture object
	`SetMaterialFromWebUI`	Sets the material at the specified index of this Actor to a WebUI object
	`SetMaterialScalarParameter`	Sets a Scalar parameter in this Actor's material
	`SetMaterialTextureParameter`	Sets a texture parameter in this Actor's material to an image
	`SetMaterialVectorParameter`	Sets a Vector parameter in this Actor's material
	`SetPhysicalMaterial`	Overrides this Actor's Physical Material with a new one

Inherited Pickable Functions

Weapon inherits from Base Pickable Class, sharing it's methods and functions:
Base Pickablescripting-reference/classes/base-classes/pickable

Returns	Name	Description
	`AddSkeletalMeshAttached`	Attaches a Skeletal Mesh as master pose to this entity
	`AddStaticMeshAttached`	Attaches a Static Mesh to this entity
table of string	`GetAllSkeletalMeshAttached`	Gets all Skeletal Meshes attached to this entity
table of string	`GetAllStaticMeshAttached`	Gets all Static Meshes attached to this entity
Character or nil	`GetHandler`	Gets the Character, if it exists, that's holding this Pickable
HandlingMode	`GetHandlingMode`	Gets the Handling Mode of this Pickable
SkeletalMesh Reference	`GetMesh`	Gets the name of the asset this Pickable uses
	`PullUse`	Pulls the usage of this Pickable (will start firing if this is a weapon)
	`ReleaseUse`	Releases the usage of this Pickable (will stop firing if this is a weapon)
	`RemoveAllSkeletalMeshesAttached`	Removes all SkeletalMeshes attached
	`RemoveAllStaticMeshesAttached`	Removes all StaticMeshes attached
	`RemoveSkeletalMeshAttached`	Removes, if it exists, a SkeletalMesh from this Pickable given its custom ID
	`RemoveStaticMeshAttached`	Removes, if it exists, a StaticMesh from this Pickable given its custom ID
	`SetAttachmentSettings`	Sets the Attachment Settings for this Pickable (how it attaches to the Character when Picking up)
	`SetCanUse`	Sets if this Pickable can be used by the player when held
	`SetCrosshairMaterial`	Sets the crosshair material for this Pickable
	`SetPickable`	Sets if this Pickable can be picked up from ground by the player
	`SetStaticMeshAttachedTransform`	Sets a Static Mesh Attached location and rotation

Returns	Name	Description
integer	`GetAmmoBag`	Gets this Weapon's Ammo Bag
integer	`GetAmmoClip`	Gets this Weapon's Ammo Clip
integer	`GetAmmoToReload`	Gets the amount of ammo needed to fully reload
Animation Reference	`GetAnimationCharacterFire`	No description provided
Animation Reference	`GetAnimationFire`	No description provided
Animation Reference	`GetAnimationReload`	Gets the reload animation
Color	`GetBulletColor`	No description provided
integer	`GetBulletCount`	No description provided
float	`GetCadence`	No description provided
boolean	`GetCanHoldUse`	Gets if the weapon can be used continuously by holding the use button
integer	`GetClipCapacity`	No description provided
integer	`GetDamage`	No description provided
HandlingMode	`GetHandlingMode`	No description provided
boolean	`GetHoldReleaseUse`	Gets if the weapon is triggered/fired when releasing the use button
Vector	`GetLeftHandLocation`	No description provided
Rotator	`GetLeftHandRotation`	No description provided
StaticMesh Reference	`GetMagazineMesh`	No description provided
Particle Reference	`GetParticlesBulletTrail`	No description provided
Particle Reference	`GetParticlesShells`	No description provided
float	`GetRecoil`	No description provided
Vector	`GetRightHandOffset`	No description provided
float	`GetSightFOVMultiplier`	No description provided
Vector	`GetSightLocation`	No description provided
Rotator	`GetSightRotation`	No description provided
Sound Reference	`GetSoundAim`	No description provided
Sound Reference	`GetSoundDry`	No description provided
Sound Reference	`GetSoundFire`	No description provided
Sound Reference	`GetSoundLoad`	No description provided
Sound Reference	`GetSoundUnload`	No description provided
Sound Reference	`GetSoundZooming`	No description provided
float	`GetSpread`	No description provided
	`PlayAnimation`	Plays an Animation on this Weapon
	`Reload`	Forces this Weapon to reload
	`SetAmmoBag`	Sets this Weapon's Ammo in the Bag
	`SetAmmoClip`	Sets this Weapon's Ammo in the Clip
	`SetAmmoSettings`	Aux for setting and configuring ammo
	`SetAnimationCharacterFire`	Animation played by the Character when Firing
	`SetAnimationFire`	Animation played by the Weapon when Firing
	`SetAnimationReload`	Animation played by the Character when Reloading
	`SetAutoReload`	If the Character will reload automatically when ammo empties
	`SetBulletColor`	Set the Bullet Color
	`SetBulletSettings`	Aux for setting and configuring the Bullet
	`SetCadence`	Speed of shots
	`SetClipCapacity`	Capacity of the Weapon's clip
	`SetDamage`	Set the Base Weapon's Damage
	`SetHandlingMode`	Sets how the Character grabs this Weapon
	`SetLeftHandTransform`	Left Hand Offset
	`SetMagazineMesh`	Set the mesh used when the Character reloads the weapon
	`SetParticlesBarrel`	Particle of the Fire Blast in the muzzle
	`SetParticlesBulletTrail`	Particle of the Bullet flying
	`SetParticlesShells`	Particle of the empty bullet flying from the weapon when shooting
	`SetRecoil`	Base Weapon's Recoil
	`SetRightHandOffset`	Set the offset of Right Hand
	`SetSightFOVMultiplier`	The FOV multiplier when ADS
	`SetSightTransform`	Offset applied to align player's head to weapon's sight and rotation applied on the weapon when ADS
	`SetSoundAim`	Sound when Aiming
	`SetSoundDry`	Sound when weapon has not bullet and try to shoot
	`SetSoundFire`	Sound when Shooting
	`SetSoundFireLastBullets`	Sound when firing with only having X remaining bullets in the magazine
	`SetSoundLoad`	Sound when Loading a magazine
	`SetSoundUnload`	Sound when Unloading a magazine
	`SetSoundZooming`	Sound when Zooming
	`SetSpread`	Base Weapon's Spread
	`SetUsageSettings`	Sets if the Weapon can hold to keep firing and if it needs to release to fire
	`SetWallbangSettings`	Sets how the bullet will pass through walls

`GetAmmoBag`

Gets this Weapon's Ammo Bag

local ammo_bag = my_weapon:GetAmmoBag()

Returns

Type	Description
integer	ammo_bag

`GetAmmoClip`

Gets this Weapon's Ammo Clip

local ammo_clip = my_weapon:GetAmmoClip()

Returns

Type	Description
integer	ammo_clip

`GetAmmoToReload`

Gets the amount of ammo needed to fully reload

local ammo_to_reload = my_weapon:GetAmmoToReload()

Returns

Type	Description
integer	ammo_to_reload

`GetAnimationCharacterFire`

local animation_character_fire_path = my_weapon:GetAnimationCharacterFire()

Returns

Type	Description
Animation Reference	animation_character_fire_path

`GetAnimationFire`

local animation_fire_path = my_weapon:GetAnimationFire()

Returns

Type	Description
Animation Reference	animation_fire_path

`GetAnimationReload`

Gets the reload animation

local reload_animation_path = my_weapon:GetAnimationReload()

Returns

Type	Description
Animation Reference	reload_animation_path

`GetBulletColor`

local bullet_color = my_weapon:GetBulletColor()

Returns

Type	Description
Color	bullet_color

`GetBulletCount`

local bullet_count = my_weapon:GetBulletCount()

Returns

Type	Description
integer	bullet_count

`GetCadence`

local cadence = my_weapon:GetCadence()

Returns

Type	Description
float	cadence

`GetCanHoldUse`

Gets if the weapon can be used continuously by holding the use button

local can_hold_use = my_weapon:GetCanHoldUse()

Returns

Type	Description
boolean	can_hold_use

`GetClipCapacity`

local clip = my_weapon:GetClipCapacity()

Returns

Type	Description
integer	clip

`GetDamage`

local damage = my_weapon:GetDamage()

Returns

Type	Description
integer	damage

`GetHandlingMode`

local handling_mode = my_weapon:GetHandlingMode()

Returns

Type	Description
HandlingMode	handling_mode

`GetHoldReleaseUse`

Gets if the weapon is triggered/fired when releasing the use button

local hold_release_use = my_weapon:GetHoldReleaseUse()

Returns

Type	Description
boolean	hold_release_use

`GetLeftHandLocation`

local left_hand_location = my_weapon:GetLeftHandLocation()

Returns

Type	Description
Vector	left_hand_location

`GetLeftHandRotation`

local left_hand_rotation = my_weapon:GetLeftHandRotation()

Returns

Type	Description
Rotator	left_hand_rotation

`GetMagazineMesh`

local magazine_mesh = my_weapon:GetMagazineMesh()

Returns

Type	Description
StaticMesh Reference	magazine_mesh

`GetParticlesBulletTrail`

local particle_bullet_trail_asset_path = my_weapon:GetParticlesBulletTrail()

Returns

Type	Description
Particle Reference	particle_bullet_trail_asset_path

`GetParticlesShells`

local particle_shells_asset_path = my_weapon:GetParticlesShells()

Returns

Type	Description
Particle Reference	particle_shells_asset_path

`GetRecoil`

local recoil = my_weapon:GetRecoil()

Returns

Type	Description
float	recoil

`GetRightHandOffset`

local right_hand_offset = my_weapon:GetRightHandOffset()

Returns

Type	Description
Vector	right_hand_offset

`GetSightFOVMultiplier`

local sight_fov_multiplier = my_weapon:GetSightFOVMultiplier()

Returns

Type	Description
float	sight_fov_multiplier

`GetSightLocation`

local sight_location = my_weapon:GetSightLocation()

Returns

Type	Description
Vector	sight_location

`GetSightRotation`

local sight_rotation = my_weapon:GetSightRotation()

Returns

Type	Description
Rotator	sight_rotation

`GetSoundAim`

local sound_aim_asset_path = my_weapon:GetSoundAim()

Returns

Type	Description
Sound Reference	sound_aim_asset_path

`GetSoundDry`

local sound_dry_asset_path = my_weapon:GetSoundDry()

Returns

Type	Description
Sound Reference	sound_dry_asset_path

`GetSoundFire`

local sound_fire_asset_path = my_weapon:GetSoundFire()

Returns

Type	Description
Sound Reference	sound_fire_asset_path

`GetSoundLoad`

local sound_load_asset_path = my_weapon:GetSoundLoad()

Returns

Type	Description
Sound Reference	sound_load_asset_path

`GetSoundUnload`

local sound_unload_asset_path = my_weapon:GetSoundUnload()

Returns

Type	Description
Sound Reference	sound_unload_asset_path

`GetSoundZooming`

local sound_zooming_asset_path = my_weapon:GetSoundZooming()

Returns

Type	Description
Sound Reference	sound_zooming_asset_path

`GetSpread`

local spread = my_weapon:GetSpread()

Returns

Type	Description
float	spread

`PlayAnimation`

Plays an Animation on this Weapon

my_weapon:PlayAnimation(animation_path, slot_name?, loop_indefinitely?, blend_in_time?, blend_out_time?, play_rate?, stop_all_montages?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`animation_path`	Required parameter	No description provided
string	`slot_name?`	`DefaultSlot`	No description provided
boolean	`loop_indefinitely?`	`false`	This parameter is only used if the Weapon has an Animation Blueprint
float	`blend_in_time?`	`0.25`	This parameter is only used if the Weapon has an Animation Blueprint
float	`blend_out_time?`	`0.25`	This parameter is only used if the Weapon has an Animation Blueprint
float	`play_rate?`	`1.0`	This parameter is only used if the Weapon has an Animation Blueprint
boolean	`stop_all_montages?`	`false`	Stops all running Montages from the same Group. This parameter is only used if the Weapon has an Animation Blueprint

`Reload`

Forces this Weapon to reload (only if being handled by a Character)

my_weapon:Reload()

`SetAmmoBag`

Sets this Weapon's Ammo in the Bag

my_weapon:SetAmmoBag(new_ammo_bag)

Parameters

Type	Parameter	Default	Description
integer	`new_ammo_bag`	Required parameter	No description provided

`SetAmmoClip`

Sets this Weapon's Ammo in the Clip

my_weapon:SetAmmoClip(new_ammo_clip)

Parameters

Type	Parameter	Default	Description
integer	`new_ammo_clip`	Required parameter	No description provided

`SetAmmoSettings`

Aux for setting and configuring ammo

my_weapon:SetAmmoSettings(ammo_clip, ammo_bag, ammo_to_reload?, clip_capacity?)

Parameters

Type	Parameter	Default	Description
integer	`ammo_clip`	Required parameter	No description provided
integer	`ammo_bag`	Required parameter	No description provided
integer	`ammo_to_reload?`	`ammo_clip`	No description provided
integer	`clip_capacity?`	`ammo_clip`	No description provided

`SetAnimationCharacterFire`

Animation played by the Character when Firing

my_weapon:SetAnimationCharacterFire(animation_character_fire_path, play_rate?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`animation_character_fire_path`	Required parameter	No description provided
float	`play_rate?`	`1`	No description provided

`SetAnimationFire`

Animation played by the Weapon when Firing

my_weapon:SetAnimationFire(animation_fire_path, play_rate?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`animation_fire_path`	Required parameter	No description provided
float	`play_rate?`	`1`	No description provided

`SetAnimationReload`

Animation played by the Character when Reloading

my_weapon:SetAnimationReload(reload_animation_path, play_rate?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`reload_animation_path`	Required parameter	No description provided
float	`play_rate?`	`1`	No description provided

`SetAutoReload`

If the Character will reload automatically when ammo empties. Default is true

my_weapon:SetAutoReload(auto_reload)

Parameters

Type	Parameter	Default	Description
boolean	`auto_reload`	Required parameter	No description provided

`SetBulletColor`

Set the Bullet Color

Only has effect if using Bullet Trail particle P_Bullet_Trail or if you particle has the Color parameter

my_weapon:SetBulletColor(bullet_color)

Parameters

Type	Parameter	Default	Description
Color	`bullet_color`	Required parameter	No description provided

`SetBulletSettings`

Aux for setting and configuring the Bullet

my_weapon:SetBulletSettings(bullet_count, bullet_max_distance, bullet_velocity, bullet_color)

Parameters

Type	Parameter	Default	Description
integer	`bullet_count`	Required parameter	1 for common weapons > 1 for shotguns
integer	`bullet_max_distance`	Required parameter	No description provided
integer	`bullet_velocity`	Required parameter	Visuals only
Color	`bullet_color`	Required parameter	No description provided

`SetCadence`

Speed of shots

my_weapon:SetCadence(cadence)

Parameters

Type	Parameter	Default	Description
float	`cadence`	Required parameter	1 shot at each `cadence` second

`SetClipCapacity`

Capacity of the Weapon's clip

my_weapon:SetClipCapacity(clip)

Parameters

Type	Parameter	Default	Description
integer	`clip`	Required parameter	No description provided

`SetDamage`

Base Weapon's Damage

This will be multiplied by multiplier factors when hitting specific bones

my_weapon:SetDamage(damage)

Parameters

Type	Parameter	Default	Description
integer	`damage`	Required parameter	No description provided

`SetHandlingMode`

Sets how the Character grabs this Weapon

my_weapon:SetHandlingMode(handling_mode)

Parameters

Type	Parameter	Default	Description
HandlingMode	`handling_mode`	Required parameter	No description provided

`SetLeftHandTransform`

Left Hand Offset

my_weapon:SetLeftHandTransform(left_hand_location, left_hand_rotation)

Parameters

Type	Parameter	Default	Description
Vector	`left_hand_location`	Required parameter	No description provided
Rotator	`left_hand_rotation`	Required parameter	No description provided

`SetMagazineMesh`

Set the mesh used when the Character reloads the weapon.

Will drop this Mesh as an animation effect.

my_weapon:SetMagazineMesh(magazine_mesh, magazine_mesh_hide_bone?)

Parameters

Type	Parameter	Default	Description
StaticMesh Reference	`magazine_mesh`	Required parameter	No description provided
string	`magazine_mesh_hide_bone?`	`b_gun_mag`	Weapon bone to hide when reloading it

`SetParticlesBarrel`

Particle of the Fire Blast in the muzzle

my_weapon:SetParticlesBarrel(particle_asset_path)

Parameters

Type	Parameter	Default	Description
Particle Reference	`particle_asset_path`	Required parameter	No description provided

`SetParticlesBulletTrail`

Particle of the Bullet flying

my_weapon:SetParticlesBulletTrail(particle_bullet_trail_asset_path)

Parameters

Type	Parameter	Default	Description
Particle Reference	`particle_bullet_trail_asset_path`	Required parameter	No description provided

`SetParticlesShells`

Particle of the empty bullet flying from the weapon when shooting

my_weapon:SetParticlesShells(particle_shells_asset_path)

Parameters

Type	Parameter	Default	Description
Particle Reference	`particle_shells_asset_path`	Required parameter	No description provided

`SetRecoil`

Base Weapon's Recoil

my_weapon:SetRecoil(recoil)

Parameters

Type	Parameter	Default	Description
float	`recoil`	Required parameter	0 means no Recoil, default is 1

`SetRightHandOffset`

Set the Offset of Right Hand. To position relative to the camera.

my_weapon:SetRightHandOffset(right_hand_offset)

Parameters

Type	Parameter	Default	Description
Vector	`right_hand_offset`	Required parameter	No description provided

`SetSightFOVMultiplier`

The FOV multiplier when ADS

my_weapon:SetSightFOVMultiplier(sight_fov_multiplier)

Parameters

Type	Parameter	Default	Description
float	`sight_fov_multiplier`	Required parameter	No description provided

`SetSightTransform`

Offset applied to align player's head to weapon's sight and rotation applied on the weapon when ADS

my_weapon:SetSightTransform(sight_location, sight_rotation)

Parameters

Type	Parameter	Default	Description
Vector	`sight_location`	Required parameter	No description provided
Rotator	`sight_rotation`	Required parameter	No description provided

`SetSoundAim`

Sound when Aiming

my_weapon:SetSoundAim(sound_aim_asset_path, volume?, pitch?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_aim_asset_path`	Required parameter	No description provided
float	`volume?`	`1`	No description provided
float	`pitch?`	`1`	No description provided

`SetSoundDry`

Sound when weapon has not bullet and try to shoot

my_weapon:SetSoundDry(sound_dry_asset_path, volume?, pitch?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_dry_asset_path`	Required parameter	No description provided
float	`volume?`	`1`	No description provided
float	`pitch?`	`1`	No description provided

`SetSoundFire`

Sound when Shooting

my_weapon:SetSoundFire(sound_fire_asset_path, volume?, pitch?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_fire_asset_path`	Required parameter	No description provided
float	`volume?`	`1`	No description provided
float	`pitch?`	`1`	No description provided

`SetSoundFireLastBullets`

Sound when firing with only having X remaining bullets in the magazine, useful for last shot 'ping' or sound when low on bullets

my_weapon:SetSoundFireLastBullets(sound_asset_path, remaining_bullets_count?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_asset_path`	Required parameter	No description provided
integer	`remaining_bullets_count?`	`1`	The amount of remaining bullet to start playing this sound

`SetSoundLoad`

Sound when Loading a magazine

my_weapon:SetSoundLoad(sound_load_asset_path, volume?, pitch?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_load_asset_path`	Required parameter	No description provided
float	`volume?`	`1`	No description provided
float	`pitch?`	`1`	No description provided

`SetSoundUnload`

Sound when Unloading a magazine

my_weapon:SetSoundUnload(sound_unload_asset_path, volume?, pitch?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_unload_asset_path`	Required parameter	No description provided
float	`volume?`	`1`	No description provided
float	`pitch?`	`1`	No description provided

`SetSoundZooming`

Sound when Zooming

my_weapon:SetSoundZooming(sound_zooming_asset_path, volume?, pitch?)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_zooming_asset_path`	Required parameter	No description provided
float	`volume?`	`1`	No description provided
float	`pitch?`	`1`	No description provided

`SetSpread`

Base Weapon's Spread

my_weapon:SetSpread(spread)

Parameters

Type	Parameter	Default	Description
float	`spread`	Required parameter	the higher the less precision - recommended value: 20

`SetUsageSettings`

Sets if the Weapon can hold to keep firing and if it needs to release to fire

my_weapon:SetUsageSettings(can_hold_use, hold_release_use)

Parameters

Type	Parameter	Default	Description
boolean	`can_hold_use`	Required parameter	No description provided
boolean	`hold_release_use`	Required parameter	No description provided

`SetWallbangSettings`

Sets how the bullet will pass through walls

my_weapon:SetWallbangSettings(max_distance, damage_multiplier)

Parameters

Type	Parameter	Default	Description
integer	`max_distance`	Required parameter	Max distance to pass through another wall
float	`damage_multiplier`	Required parameter	Damage given if wallbangged

🚀 Events

Inherited Entity Events

Weapon inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/entity

	Name	Description
	`ClassRegister`	Triggered when a new Class is registered with the Inheriting System
	`Destroy`	Triggered when an Entity is destroyed
	`Spawn`	Triggered when an Entity is spawned/created
	`ValueChange`	Triggered when an Entity has a value changed with `:SetValue()`

Inherited Actor Events

Weapon inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	`DimensionChange`	Triggered when an Actor changes its dimension

Inherited Pickable Events

Weapon inherits from Base Pickable Class, sharing it's events:
Base Pickablescripting-reference/classes/base-classes/pickable

	Name	Description
	`Drop`	When a Character drops this Pickable
	`Hit`	When this Pickable hits something
	`Interact`	Triggered when a Character interacts with this Pickable (i.e. tries to pick it up)
	`PickUp`	Triggered When a Character picks this up
	`PullUse`	Triggered when a Character presses the use button for this Pickable (i.e. clicks left mouse button with this equipped)
	`ReleaseUse`	Triggered when a Character releases the use button for this Pickable (i.e. releases left mouse button with this equipped)

	Name	Description
	`AmmoBagChange`	When the Ammo Bag is changed, by reloading or manually setting through scripting
	`AmmoClipChange`	When the Ammo Clip is changed, by reloading or manually setting through scripting
	`BulletHit`	Triggered when bullets hit (this will be triggered for each bullet shot)
	`Fire`	Triggered when Weapon fires (this will be triggered for each shot)
	`Reload`	When a Weapon is reloaded, optionally by a Character

`AmmoBagChange`

When the Ammo Bag is changed, by reloading or manually setting through scripting

Weapon.Subscribe("AmmoBagChange", function(self, old_ammo_bag, new_ammo_bag)
	-- AmmoBagChange was called
end)

Arguments

Type	Argument	Description
Weapon	`self`	No description provided
integer	`old_ammo_bag`	No description provided
integer	`new_ammo_bag`	No description provided

`AmmoClipChange`

When the Ammo Clip is changed, by reloading or manually setting through scripting

Weapon.Subscribe("AmmoClipChange", function(self, old_ammo_clip, new_ammo_clip)
	-- AmmoClipChange was called
end)

Arguments

Type	Argument	Description
Weapon	`self`	No description provided
integer	`old_ammo_clip`	No description provided
integer	`new_ammo_clip`	No description provided

`BulletHit`

Triggered when bullets hit (this will be triggered for each bullet shot)

Weapon.Subscribe("BulletHit", function(self, impact_point, impact_normal, damage, actor_hit)
	-- BulletHit was called
end)

Arguments

Type	Argument	Description
Weapon	`self`	No description provided
Vector	`impact_point`	Location in world space of the bullet hit
Vector	`impact_normal`	Normal of the bullet hit in world space
integer	`damage`	Damage that was applied
Base Actor or nil	`actor_hit`	Actor entity that was hit, if any

`Fire`

Triggered when Weapon fires (this will be triggered for each shot)

Weapon.Subscribe("Fire", function(self, shooter)
	-- Fire was called
end)

Arguments

Type	Argument	Description
Weapon	`self`	No description provided
Character	`shooter`	No description provided

`Reload`

When a Weapon is reloaded, optionally by a Character

Weapon.Subscribe("Reload", function(self, character, ammo_to_reload)
	-- Reload was called
end)

Arguments

Type	Argument	Description
Weapon	`self`	No description provided
Character	`character`	No description provided
integer	`ammo_to_reload`	No description provided

🎒 Examples
🛠 Constructors
🗿 Static Functions
🦠 Functions
🚀 Events

🎒 Examples​

🛠 Constructors​

Default Constructor​

Parameters

🗿 Static Functions​

🦠 Functions​

GetAmmoBag​

Returns

GetAmmoClip​

Returns

GetAmmoToReload​

Returns

GetAnimationCharacterFire​

Returns

GetAnimationFire​

Returns

GetAnimationReload​

Returns

GetBulletColor​

Returns

GetBulletCount​

Returns

GetCadence​

Returns

GetCanHoldUse​

Returns

GetClipCapacity​

Returns

GetDamage​

Returns

GetHandlingMode​

Returns

GetHoldReleaseUse​

Returns

GetLeftHandLocation​

Returns

GetLeftHandRotation​

Returns

GetMagazineMesh​

Returns

GetParticlesBulletTrail​

Returns

GetParticlesShells​

Returns

GetRecoil​

Returns

GetRightHandOffset​

Returns

GetSightFOVMultiplier​

Returns

GetSightLocation​

Returns

GetSightRotation​

Returns

GetSoundAim​

Returns

GetSoundDry​

Returns

GetSoundFire​

Returns

GetSoundLoad​

Returns

GetSoundUnload​

Returns

GetSoundZooming​

Returns

GetSpread​

Returns

PlayAnimation​

Parameters

Reload​

SetAmmoBag​

Parameters

SetAmmoClip​

Parameters

SetAmmoSettings​

Parameters

SetAnimationCharacterFire​

Parameters

SetAnimationFire​

🎒 Examples

🛠 Constructors

Default Constructor

🗿 Static Functions

🦠 Functions

`GetAmmoBag`

`GetAmmoClip`

`GetAmmoToReload`

`GetAnimationCharacterFire`

`GetAnimationFire`

`GetAnimationReload`

`GetBulletColor`

`GetBulletCount`

`GetCadence`

`GetCanHoldUse`

`GetClipCapacity`

`GetDamage`

`GetHandlingMode`

`GetHoldReleaseUse`

`GetLeftHandLocation`

`GetLeftHandRotation`

`GetMagazineMesh`

`GetParticlesBulletTrail`

`GetParticlesShells`

`GetRecoil`

`GetRightHandOffset`

`GetSightFOVMultiplier`

`GetSightLocation`

`GetSightRotation`

`GetSoundAim`

`GetSoundDry`

`GetSoundFire`

`GetSoundLoad`

`GetSoundUnload`

`GetSoundZooming`

`GetSpread`

`PlayAnimation`

`Reload`

`SetAmmoBag`

`SetAmmoClip`

`SetAmmoSettings`

`SetAnimationCharacterFire`

`SetAnimationFire`

`SetAnimationReload`

`SetAutoReload`

`SetBulletColor`

`SetBulletSettings`

`SetCadence`

`SetClipCapacity`

`SetDamage`

`SetHandlingMode`

`SetLeftHandTransform`

`SetMagazineMesh`

`SetParticlesBarrel`

`SetParticlesBulletTrail`

`SetParticlesShells`

`SetRecoil`

`SetRightHandOffset`

`SetSightFOVMultiplier`

`SetSightTransform`

`SetSoundAim`

`SetSoundDry`

`SetSoundFire`

`SetSoundFireLastBullets`

`SetSoundLoad`

`SetSoundUnload`

`SetSoundZooming`

`SetSpread`

`SetUsageSettings`

`SetWallbangSettings`

🚀 Events

`AmmoBagChange`

`AmmoClipChange`

`BulletHit`

`Fire`

`Reload`