infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Components
BaseWeaponModel
chevron_left Components
class
BaseWeaponModel

Constructors

functionsBaseWeaponModel

Properties

data_objectDeploySounddata_objectEjectBrassdata_objectMuzzleEffectdata_objectMuzzleGameObjectdata_objectRendererdata_objectShellEjectGameObjectdata_objectTracerEffect

Methods

functionsDoEjectBrassfunctionsDoMuzzleEffectfunctionsDoTracerEffectfunctionsGetMuzzleTransformfunctionsGetShellEjectTransformfunctionsGetTracerOriginfunctionsOnAttackfunctionsOnDeployfunctionsOnIncrementalReloadfunctionsOnReloadCancelfunctionsOnReloadFinishfunctionsOnReloadStart
BaseWeaponModel
Marks up a weapon's view or world model with the attachment points the weapon fires from - the muzzle, the shell-eject port, and so on - and plays the stock presentation off them: muzzle flash, brass and tracer prefabs, plus the b_deploy/b_attack/b_reload animation parameters. Drop this on a weapon model prefab, wire the attachment GameObjects, and override the On* hooks to extend or replace any of it. The holding Sandbox.BaseWeapon drives it through those hooks.
class Sandbox .account_tree extends Component
Sandbox.Engine

build Constructors 1

BaseWeaponModel ()

data_object Properties 7

DeploySound
SoundEvent
Sound played when this weapon model is deployed (drawn).
EjectBrass
GameObject
Effect prefab spawned at the shell-eject port when the weapon fires (the flying brass). Defaults to a generic casing - clear it for none.
MuzzleEffect
GameObject
Effect prefab spawned at the muzzle when the weapon fires (muzzle flash, smoke). Defaults to a generic flash - clear it for none.
MuzzleGameObject
GameObject
The muzzle attachment - where shots and muzzle effects originate.
Renderer
SkinnedModelRenderer
The skinned model renderer for this weapon model.
ShellEjectGameObject
GameObject
The shell-eject attachment - where spent casings are thrown from.
TracerEffect
GameObject
Effect prefab spawned from the muzzle toward the hit point (the bullet tracer). Defaults to a generic tracer - clear it for none.

functions Methods 12

DoEjectBrass ()
Spawns Sandbox.BaseWeaponModel.EjectBrass at the shell-eject attachment and throws it out, if both are set.
DoMuzzleEffect ()
Spawns Sandbox.BaseWeaponModel.MuzzleEffect parented to the muzzle attachment, if both are set.
DoTracerEffect (hitPoint, origin)
GetMuzzleTransform ()
Transform
The muzzle world transform, or the model's own transform when there's no muzzle attachment.
GetShellEjectTransform ()
Transform
The shell-eject world transform, or the model's own transform when there's no eject attachment.
GetTracerOrigin ()
Transform
The point a tracer starts from - the muzzle.
OnAttack (hitPoint, origin)
OnDeploy ()
Called when this weapon model is deployed (drawn). Base sets the "b_deploy" animation parameter and plays Sandbox.BaseWeaponModel.DeploySound. Override to extend.
OnIncrementalReload ()
Called when a round is loaded during an incremental (one-at-a-time) reload. Base does nothing - override for the per-shell animation.
OnReloadCancel ()
Called when a reload is cancelled part-way through. Base does nothing - override to stop timed sounds and so on.
OnReloadFinish ()
Called when the reload finishes. Base clears the "b_reload" animation parameter. Override to extend.
OnReloadStart ()
Called when the weapon starts reloading. Base sets the "b_reload" animation parameter. Override to extend (incremental animations, timed reload sounds).

Inheritance

Component
BaseWeaponModel
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.