Skip to main content

Combat

warning

This API is only accessible from the server.

tip

This API is a module. You should specify function names when using this API.

Types

CombatAPIExplosionParams

export type CombatAPIExplosionParams = {
Position: Vector3,
Damage: number,
FalloffBegin: number?,
FalloffEnd: number,
Attacker: Participant?,
IgnoreKarma: boolean?,
}

Functions

MakeExplosion

Creates an explosion at the specified position with the specified damage, radius, and sound.

Parameters

NameTypeDefaultDescription
paramsCombatAPIExplosionParamsFalloffBegin = 0The parameters for the explosion.
soundSound?default explosion soundThe sound to play when the explosion happens.
A default sound is used if not provided.

Returns

()