Skip to content

Server

Provides server functionality for item behaviour.

Creates an explosion.

NameTypeDefaultDescription
roundRoundThe current round.
paramsExplosionParamsThe data of the explosion.
soundSound?The sound to play for the explosion.

Processes a hitscan request.

NameTypeDefaultDescription
itemItemThe item.
originVector3The origin of the hit.
participantParticipantThe participant responsible for the hit.
hitNumbernumberThe hit number, when multiple hits are processed at once, such as from firing a shotgun.
hitscanBehaviourTypes.HitscanResultThe hitscan data to use.

string?

Returns a string if the hit is rejected.

Spawns a physics-simulated projectile.

NameTypeDefaultDescription
itemItemThe item.
participantParticipantThe participant responsible for the hit.
originVector3The origin for the projectile.
directionVector3The direction of the projectile.
cookTimenumber?The amount of time to subtract from the fuse time, if this is a fuse projectile.

Decreases the ammo of the item by 1. Does not update the client.

NameTypeDefaultDescription
itemItemThe item.

Processes hit rejects for an item.

NameTypeDefaultDescription
itemItemThe item.

Determines which players to apply near-miss self defense to, and applies it.

NameTypeDefaultDescription
originVector3The origin for the projectile.
directionVector3The direction of the projectile.
participantParticipantThe participant responsible for the near-miss.

Process a primary fire request.

NameTypeDefaultDescription
itemItemThe item.
originVector3The origin for the projectile.
directionVector3The direction of the projectile.
participantParticipantThe participant responsible for the near-miss.
dataunknownThe client-supplied data for the hit.

{string} | string?

If returning a string or table of strings, the primary fire was rejected with the provided reason.