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
Classes
BaseWeapon
ShootBullet
chevron_left Classes
class
BaseWeapon

Constructors

functionsBaseWeapon

Properties

data_objectAimRaydata_objectAmmo1data_objectAmmo2lockAttackerdata_objectAttackSounddata_objectAutoReloaddata_objectBallisticsdata_objectCanCancelReloaddata_objectClip1data_objectClip2data_objectClipMaxSizelockCrosshairCanShootlockCrosshairNoShootdata_objectCurrentSpreaddata_objectDeployTimedata_objectDryFireSounddata_objectFirstShellReloadTimedata_objectHandednessdata_objectHoldBonedata_objectHolderRendererdata_objectHoldTypedata_objectIncrementalReloadingdata_objectIsHelddata_objectIsReloadingdata_objectMaxReserveAmmolockNextPrimaryFirelockNextSecondaryFiredata_objectNpcdata_objectOwnerdata_objectPrimaryAmmoTypedata_objectPrimaryAutomaticdata_objectPrimaryClipSizedata_objectPrimaryDelaylockReloadFillTargetdata_objectReloadStartTimedata_objectReloadTimedata_objectSecondaryAmmoTypedata_objectSecondaryAutomaticdata_objectSecondaryClipSizedata_objectSecondaryDefaultClipdata_objectSecondaryDelaydata_objectShouldAvoidlockSpreadBloomdata_objectSpreadScaledata_objectStartingAmmolockTimeSinceShootlockUnheldAimRaydata_objectUsableByNpcsdata_objectUsesAmmodata_objectUsesClipsdata_objectUsesPrimaryClipdata_objectUsesSecondaryClipdata_objectViewModeldata_objectViewModelPrefabdata_objectWeaponModeldata_objectWorldModeldata_objectWorldModelPrefab

Methods

lockBulletTracefunctionsCancelReloadfunctionsCanPrimaryAttackfunctionsCanReloadfunctionsCanSecondaryAttacklockCreateViewModellockCreateWorldModellockDestroyViewModellockDestroyWorldModelfunctionsDrawCrosshairfunctionsDrawHudfunctionsDryFirefunctionsFirePrimaryfunctionsFireSecondaryfunctionsGetMuzzleTransformlockGetReserveAmmofunctionsHasPrimaryAmmofunctionsHasSecondaryAmmolockModifyCameralockOnAddedlockOnAddinglockOnControllockOnEquippedlockOnHolsteredlockOnReloadCancelledlockOnReloadFinishedlockOnReloadInsertedlockOnReloadStartedlockOnShootEffectslockOnShootImpactlockOnUpdatelockOnValidateShotClaimlockPlaceViewModellockPlayAttackSoundfunctionsPrimaryAttackfunctionsReloadfunctionsSecondaryAttackfunctionsSetNextFirefunctionsSetNextPrimaryFirefunctionsSetNextSecondaryFirefunctionsShootEffectsfunctionsTakePrimaryAmmolockTakeReserveAmmofunctionsTakeSecondaryAmmolockThinklockUpdateBodyAnimationslockWantsPrimaryAttacklockWantsReloadlockWantsSecondaryAttack

Static Methods

functionsImpactEffectfunctionsImpactPrefabfunctionsShootBulletfunctionsShootBullets
ShootBullet
Traces a bullet through the world and, on the host, damages and pushes whatever it hits. This is a pure utility - it holds no state, so you can call it from anywhere (a weapon, a trap, an NPC, an explosion). Returns the trace result so the caller can spawn tracers, decals and play sounds.
methodstatic4 overloads
Overloads
static SceneTraceResult ShootBullet (Scene scene, Ray ray, float distance, float radius, float damage, float force, GameObject attacker, GameObject weapon, GameObject ignore, TagSet tags)

Remarks

Damage and the physics impulse are applied on the host only, so it stays authoritative no matter who calls it - a client still gets the trace result back for effects, but can't deal damage. Call it from the host (or a host-routed path) when you want the hit to count.

Parameters

NameTypeDescription
scene Scene Scene to trace in.
ray Ray Origin and direction of the bullet (apply any aim cone before calling).
distance float How far the bullet travels.
radius float Bullet radius - 0 for a thin ray, higher to be forgiving.
damage float Damage dealt to what we hit.
force float Impulse applied to the hit physics body, along the bullet direction.
attacker GameObject Who fired this - credited for the damage and ignored by the trace.
weapon GameObject The weapon GameObject, recorded on the damage.
ignore = null GameObject Hierarchy to ignore. Defaults to .
tags = null TagSet Optional damage tags (e.g. "bullet").

Returns

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