Browsing StarfallEx's section
โ† Back to ACE
Back to StarfallEx

SFEX.effect.beamRingPoint

S๐Ÿท๏ธ Effect

Part of StarfallEx namespace

๐Ÿ”— External
effect.beamRingPoint(pos, lifetime, startRad, endRad, width, amplitude, color, speed, flags, framerate, material)
View on GitHub|lua/starfall/libs_sh/effect.lua:208
๐Ÿ“‹ Has LDoc๐Ÿ‘๏ธ 1 viewsUpdated 1 week ago

Description

Creates a "beam ring point" effect, like the AR2 orb explosion

Parameters

NameTypeDescription
posVectorThe origin position of the effect
lifetimenumberHow long the effect will be drawing for, in seconds (clamped: 0 to 25.6)
startRadnumberInitial radius of the effect (clamped: -4096 to 4096)
endRadnumberFinal radius of the effect (clamped: -4096 to 4096)
widthnumberHow thick the beam should be (clamped: 0 to 128)
amplitudenumberHow noisy the beam should be (clamped: 0 to 64)
colorColorColor
speed?numberCauses the beam to start faded if set to any integer other than 0 (clamped: 0 to 255)
flags?numberBeam flags
framerate?numberTexture framerate (clamped: 0 to 255)
material?stringThe material to use instead of the default one

Returns

No return values documented.

Examples

No examples available.

Used In

No usages found in the codebase.