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
TracerEffect
chevron_left Classes
class
TracerEffect

Constructors

functionsTracerEffect

Properties

data_objectCastShadowsdata_objectDistancePerSeconddata_objectEnableLightdata_objectEndCapdata_objectEndPointdata_objectLengthdata_objectLightColordata_objectLightPositiondata_objectLightRadiusdata_objectLineColordata_objectLineWidthdata_objectMaterialdata_objectOpaquedata_objectStartCapdata_objectStartDistance

Methods

functionsSetStartPointfunctionsSetTarget
TracerEffect
A line effect that travels from this component's position to Sandbox.TracerEffect.EndPoint - a bullet tracer or beam. Drives a Sandbox.SceneLineObject and an optional light that travels with the line. Implements Sandbox.ITargetedEffect so a weapon model can aim it at the hit point.
class Sandbox .account_tree extends Renderer
sealedSandbox.Engine

build Constructors 1

TracerEffect ()

data_object Properties 15

CastShadows
bool
The line casts shadows.
DistancePerSecond
float
How fast the line travels, in units per second.
EnableLight
bool
A point light that travels with the line.
EndCap
CapStyle
Cap shape at the tail end of the line.
EndPoint
SceneAnchor
Where the line travels to - a fixed world position, or anchored to an object it follows.
Length
float
Length of the visible line.
LightColor
Gradient
Light colour over the travel - 0 at the start, 1 at the end point.
LightPosition
float
Where along the visible line the light sits - 0 the leading edge, 1 the tail.
LightRadius
Curve
Light radius over the travel - 0 at the start, 1 at the end point.
LineColor
Gradient
Colour along the line - 0 is the leading edge, 1 the tail.
LineWidth
Curve
Width along the line - 0 is the leading edge, 1 the tail.
Material
Material
Material for the line. Empty uses the default line material.
Opaque
bool
Render the line opaque rather than blended.
StartCap
CapStyle
Cap shape at the leading end of the line.
StartDistance
float
How far along the travel the line starts - skips the stretch right out of the muzzle.

functions Methods 2

SetStartPoint (start)
Sandbox.ITargetedEffect: where the line starts from.
SetTarget (target)
Sandbox.ITargetedEffect: the destination the line travels to.

Inheritance

Component
Renderer
TracerEffect
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.