ProcessHit

Provides functions to process a hit.

Functions

Given a part, returns the category of body part it falls into. Unknown body parts are classed as “Limb”.

Name	Type	Default	Description
`part`	`BasePart`		The part.

"Limb" | "Body" | "Head"

Gets damage that an item will do to a given part, accounting for damage falloff (if relevant).

Name	Type	Description
`item`	`Item \| ExplosionParams`	The item.
`hitPart`	`BasePart`	The origin of the hit.
`origin`	`Vector3`	The participant responsible for the hit.

number

The damage.

Processes a hit on a part, additionally processing prop / participant hit if needed.

Name	Type	Description
`item`	`Item \| ExplosionParams`	The item.
`attacker`	`Participant`	The attacker.
`hitPart`	`BasePart`	The part that was hit.
`hitPosition`	`Vector3`	The hit position.
`normal`	`Vector3?`	The hit normal.
`origin`	`Vector3`	The origin of the hit.
`relativeHitCFrame`	`CFrame?`	The relative hit CFrame, in object space.
`projectile`	`MapObject?`	The projectile.

"Part" | "Prop" | "Participant"?

The type of thing that was hit. Nil if the hit is invalid.

Processes a hit on a participant.

Name	Type	Description
`item`	`Item \| ExplosionParams`	The item.
`attacker`	`Participant?`	The attacker. Can be nil if the hit is from an explosion.
`victim`	`Participant`	The target.
`hitPart`	`BasePart`	The part that was hit.
`hitPosition`	`Vector3`	The hit position.
`normal`	`Vector3?`	The hit normal.
`origin`	`Vector3`	The origin of the hit.
`relativeHitCFrame`	`CFrame?`	The relative hit CFrame, in object space.
`projectile`	`MapObject?`	The projectile.

Processes a hit on a prop.

Name	Type	Description
`item`	`Item \| ExplosionParams`	The item.
`attacker`	`Participant?`	The attacker. Can be nil if the hit is from an explosion.
`prop`	`Prop`	The target prop.
`hitPart`	`BasePart`	The part that was hit.
`hitPosition`	`Vector3`	The hit position.
`normal`	`Vector3?`	The hit normal.
`origin`	`Vector3`	The origin of the hit.
`relativeHitCFrame`	`CFrame?`	The relative hit CFrame, in object space.
`projectile`	`MapObject?`	The projectile.